atom.ws.model.HandleEventMessage Maven / Gradle / Ivy

Go to download
/*
 * Copyright © 2015 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.ws.model;

import atom.beans.ChangeSet;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
import java.util.List;
import java.util.Objects;

/**
 * Handle Event message.
 *
 * @author Serge Voloshyn
 * @version 1.1 3/1/15
 */
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(namespace = AbstractMessage.MESSAGING_NAMESPACE)
public final class HandleEventMessage extends AbstractMessage {
    /**
     * Use serialVersionUID from JDK 1.0.2 for interoperability.
     */
    private static final long serialVersionUID = -4528649345392508924L;
    /**
     * Existing layers.
     */
    private List layers;
    /**
     * View identifier.
     */
    private String identity;
    /**
     * Event type.
     */
    private int eventType;
    /**
     * View change set.
     */
    private ChangeSet changeSet;

    /**
     * Get existing layers.
     *
     * @return existing layers
     */
    public List getLayers() {
        return layers;
    }

    /**
     * Sets existing layars.
     *
     * @param theLayers existing layers
     */
    public void setLayers(final List theLayers) {
        layers = theLayers;
    }

    /**
     * Get view identifier.
     *
     * @return view identifier
     */
    public String getIdentity() {
        return identity;
    }

    /**
     * Sets view identifier.
     *
     * @param anIdentity view identifier
     */
    public void setIdentity(final String anIdentity) {
        identity = anIdentity;
    }

    /**
     * Get event type.
     *
     * @return event type
     */
    public int getEventType() {
        return eventType;
    }

    /**
     * Sets event type.
     *
     * @param anEventType event type
     */
    public void setEventType(final int anEventType) {
        eventType = anEventType;
    }

    /**
     * Get view's change set.
     *
     * @return view's change set
     */
    public ChangeSet getChangeSet() {
        return changeSet;
    }

    /**
     * Sets view's change set.
     *
     * @param aChangeSet view's change set
     */
    public void setChangeSet(final ChangeSet aChangeSet) {
        changeSet = aChangeSet;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        final HandleEventMessage that = (HandleEventMessage) o;

        return eventType == that.eventType
                && Objects.equals(getClientId(), that.getClientId())
                && Objects.equals(layers, that.layers)
                && Objects.equals(identity, that.identity)
                && Objects.equals(changeSet, that.changeSet);
    }

    @Override
    public int hashCode() {
        return Objects.hash(getClientId(), layers, identity, eventType,
                changeSet);
    }

    @Override
    public String toString() {
        return String.format("HandleEventMessage {clientId='%s', layers='%s',"
                        .concat(" identity='%s', eventType='%d',")
                        .concat(" changeSet='%s'}"),
                getClientId(), layers, identity, eventType, changeSet);
    }
}