All Downloads are FREE. Search and download functionalities are using the official Maven repository.

atom.beans.AbstractPropertyChange Maven / Gradle / Ivy

/*
 * Copyright © 2014 Geeoz, and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Research Projects is dual-licensed under the GNU General Public
 * License, version 2.0 (GPLv2) and the Geeoz Commercial License.
 *
 * Solely for non-commercial purposes. A purpose is non-commercial only if
 * it is in no manner primarily intended for or directed toward commercial
 * advantage or private monetary compensation.
 *
 * This Geeoz Software is supplied to you by Geeoz in consideration of your
 * agreement to the following terms, and your use, installation, modification
 * or redistribution of this Geeoz Software constitutes acceptance of these
 * terms. If you do not agree with these terms, please do not use, install,
 * modify or redistribute this Geeoz Software.
 *
 * Neither the name, trademarks, service marks or logos of Geeoz may be used
 * to endorse or promote products derived from the Geeoz Software without
 * specific prior written permission from Geeoz.
 *
 * The Geeoz Software is provided by Geeoz on an "AS IS" basis. GEEOZ MAKES NO
 * WARRANTIES, EXPRESS  OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
 * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE, REGARDING THE GEEOZ SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
 * COMBINATION WITH YOUR PRODUCTS.
 *
 * IN NO EVENT SHALL GEEOZ BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION
 * AND/OR DISTRIBUTION OF THE GEEOZ SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER
 * THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR
 * OTHERWISE, EVEN IF GEEOZ HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * A copy of the GNU General Public License is included in the distribution in
 * the file LICENSE and at
 *
 *     http://www.gnu.org/licenses/gpl-2.0.html
 *
 * If you are using the Research Projects for commercial purposes, we
 * encourage you to visit
 *
 *     http://products.geeoz.com/license
 *
 * for more details.
 *
 * This software or hardware and documentation may provide access to
 * or information on content, products, and services from third parties.
 * Geeoz and its affiliates are not responsible for and expressly disclaim
 * all warranties of any kind with respect to third-party content, products,
 * and services. Geeoz and its affiliates will not be responsible for any loss,
 * costs, or damages incurred due to your access to or use of third-party
 * content, products, or services. If a third-party content exists, the
 * additional copyright notices and license terms applicable to portions of the
 * software are set forth in the THIRD_PARTY_LICENSE_README file.
 *
 * Please contact Geeoz or visit www.geeoz.com if you need additional
 * information or have any questions.
 */

package atom.beans;

import atom.beans.event.InsertChildPropertyChangeEvent;
import atom.beans.event.InsertFirstChildPropertyChangeEvent;
import atom.beans.event.InsertLastChildPropertyChangeEvent;
import atom.beans.event.MultiplePropertyChangeEvent;
import atom.beans.event.RemoveChildPropertyChangeEvent;
import atom.beans.event.SimplePropertyChangeEvent;
import atom.view.AbstractView;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;
import java.beans.PropertyChangeEvent;
import java.io.Serializable;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import java.util.stream.Collectors;

/**
 * A "PropertyChange" gets delivered whenever a bean changes a "bound" or
 * "constrained" property.
 *
 * @author Alex Voloshyn
 * @author Serge Voloshyn
 * @author Vladimir Ovcharov
 * @version 1.7 11/11/14
 */
@XmlType(namespace = AbstractView.LAYOUT_NAMESPACE)
@XmlAccessorType(XmlAccessType.FIELD)
@XmlSeeAlso(value = {
        SimplePropertyChange.class,
        InsertFirstChildPropertyChange.class,
        InsertChildPropertyChange.class,
        InsertLastChildPropertyChange.class,
        RemoveChildPropertyChange.class
})
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME,
        include = JsonTypeInfo.As.PROPERTY, property = "jso")
@JsonSubTypes({
        @JsonSubTypes.Type(value = SimplePropertyChange.class,
                name = "Simple"),
        @JsonSubTypes.Type(value = InsertFirstChildPropertyChange.class,
                name = "InsertFirstChild"),
        @JsonSubTypes.Type(value = InsertChildPropertyChange.class,
                name = "InsertChild"),
        @JsonSubTypes.Type(value = InsertLastChildPropertyChange.class,
                name = "InsertLastChild"),
        @JsonSubTypes.Type(value = RemoveChildPropertyChange.class,
                name = "RemoveChild"),
        @JsonSubTypes.Type(value = MultiplePropertyChange.class,
                name = "Multiple")
})
public abstract class AbstractPropertyChange implements Serializable {
    /**
     * Use serialVersionUID from JDK 1.0.2 for interoperability.
     */
    private static final long serialVersionUID = 7869179151270456827L;

    /**
     * Retrieve a property change event from client abstract change.
     *
     * @return filled property change event
     */
    public abstract PropertyChangeEvent asPropertyChangeEvent();

    /**
     * Propagation ID. May be null.
     */
    @XmlElement
    private String propagationId;
    /**
     * Name of the property that changed. May be null, if not known.
     */
    @XmlElement
    private String propertyName;
    /**
     * Property value.
     */
    @XmlElement
    private Object propertyValue;

    /**
     * Retrieve list with property change events.
     *
     * @param changes abstract changes from client
     * @return property change event list
     */
    public static List asPropertyChangeEvents(
            final List changes) {
        if (changes == null) {
            return Collections.emptyList();
        }
        return changes.stream()
                .map(new Function() {
                    @Override
                    public PropertyChangeEvent apply(
                            final AbstractPropertyChange change) {
                        return change.asPropertyChangeEvent();
                    }
                }).collect(Collectors.toList());
    }

    /**
     * Returns the property change representation of the property change event
     * argument.
     *
     * @param events an event for representation
     * @return property change representation of the property change event
     * argument
     */
    public static List valueListOf(
            final List events) {
        if (events != null && !events.isEmpty()) {
            return events.stream().map(
                    new Function() {
                @Override
                public AbstractPropertyChange apply(
                        final PropertyChangeEvent event) {
                    return AbstractPropertyChange.valueOf(event);
                }
            }).collect(Collectors.toList());
        }
        return Collections.emptyList();
    }

    /**
     * Returns the property change representation of the property change event
     * argument.
     *
     * @param event an event for representation
     * @return property change representation of the property change event
     * argument
     */
    public static AbstractPropertyChange valueOf(
            final PropertyChangeEvent event) {
        if (event instanceof SimplePropertyChangeEvent) {
            return SimplePropertyChange.valueOf(event);
        } else if (event instanceof InsertChildPropertyChangeEvent) {
            return InsertChildPropertyChange.valueOf(event);
        } else if (event instanceof InsertFirstChildPropertyChangeEvent) {
            return InsertFirstChildPropertyChange.valueOf(event);
        } else if (event instanceof InsertLastChildPropertyChangeEvent) {
            return InsertLastChildPropertyChange.valueOf(event);
        } else if (event instanceof RemoveChildPropertyChangeEvent) {
            return RemoveChildPropertyChange.valueOf(event);
        } else if (event instanceof MultiplePropertyChangeEvent) {
            return MultiplePropertyChange.valueOf(event);
        }
        throw new IllegalArgumentException();
    }

    /**
     * Returns the propagationId object associated with a bound/constrained
     * property update.
     *
     * @return the propagationId object associated with a bound/constrained
     * property update
     */
    public final String getPropagationId() {
        return propagationId;
    }

    /**
     * Sets the propagationId object for the change.
     *
     * @param identity the propagationId object for the change
     */
    protected final void setPropagationId(final Object identity) {
        if (identity instanceof String) {
            setPropagationId((String) identity);
        }
    }

    /**
     * Sets the propagationId string for the change.
     *
     * @param identity the propagationId object for the event
     */
    public final void setPropagationId(final String identity) {
        propagationId = identity;
    }

    /**
     * Gets the programmatic name of the property that was changed.
     *
     * @return the programmatic name of the property that was changed
     */
    public final String getPropertyName() {
        return propertyName;
    }

    /**
     * Sets the programmatic name of the property that was changed.
     *
     * @param name the programmatic name of the property that was changed
     */
    public final void setPropertyName(final String name) {
        propertyName = name;
    }

    /**
     * Get new property value.
     *
     * @return new property value
     */
    public final Object getPropertyValue() {
        return propertyValue;
    }

    /**
     * Sets new property value.
     *
     * @param newValue new property value
     */
    public final void setPropertyValue(final Object newValue) {
        propertyValue = newValue;
    }

    /* (non-Javadoc)
     * @see java.lang.Object#equals(java.lang.Object)
     */
    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        final AbstractPropertyChange that = (AbstractPropertyChange) o;
        return Objects.equals(propagationId, that.propagationId)
                && Objects.equals(propertyName, that.propertyName)
                && Objects.equals(propertyValue, that.propertyValue);
    }

    /* (non-Javadoc)
     * @see java.lang.Object#hashCode()
     */
    @Override
    public int hashCode() {
        return Objects.hash(propagationId, propertyName);
    }

    @Override
    public String toString() {
        return String.format("PropertyChange {propagationId='%s',"
                        .concat(" propertyName='%s', propertyValue='%s'}"),
                propagationId, propertyName, propertyValue);
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy