/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */
package org.apache.causeway.applib.services.wrapper.events;

import org.apache.causeway.applib.Identifier;
import org.apache.causeway.applib.services.wrapper.WrapperFactory;

/**
 * Supported only by {@link WrapperFactory},
 * represents a check as to whether the proposed values of the value type is valid.
 * <p>
 * If {@link #getReason()} is not <tt>null</tt> then provides the reason why the
 * proposed value is invalid, otherwise the new value is acceptable.
 *
 * @since 1.x {@index}
 */
public class ParseValueEvent extends ValidityEvent {

    private static Object coalesce(final Object source, final String proposed) {
        return source != null ? source : proposed;
    }

    private final String proposed;

    public ParseValueEvent(final Object source, final Identifier classIdentifier, final String proposed) {
        super(coalesce(source, proposed), classIdentifier);
        this.proposed = proposed;
    }

    /**
     * Will be the source provided in the
     * {@link #ParseValueEvent(Object, Identifier, String) constructor} if not
     * null, otherwise will fallback to the proposed value.
     */
    @Override
    public Object getSource() {
        return super.getSource();
    }

    @Override
    public String getProposed() {
        return proposed;
    }

}
