org.ccsds.moims.mo.mal.structures.MOObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-area001-v003-mal Show documentation
An implementation of the Java API for the CCSDS MAL
The newest version!
/* ----------------------------------------------------------------------------
 * Copyright (C) 2013      European Space Agency
 *                         European Space Operations Centre
 *                         Darmstadt
 *                         Germany
 * ----------------------------------------------------------------------------
 * System                : CCSDS MO MAL Java API
 * ----------------------------------------------------------------------------
 * Licensed under the European Space Agency Public License, Version 2.0
 * You may not use this file except in compliance with the License.
 *
 * Except as expressly set forth in this License, the Software is provided to
 * You on an "as is" basis and without warranties of any kind, including without
 * limitation merchantability, fitness for a particular purpose, absence of
 * defects or errors, accuracy or non-infringement of intellectual property rights.
 * 
 * See the License for the specific language governing permissions and
 * limitations under the License. 
 * ----------------------------------------------------------------------------
 */
package org.ccsds.moims.mo.mal.structures;

/**
 * The MOObject abstract class represents the MO Object type.
 */
public abstract class MOObject implements Composite {

    private ObjectIdentity objectIdentity;

    /**
     * Default Constructor.
     */
    public MOObject() {
        this.objectIdentity = new ObjectIdentity();
    }

    /**
     * Constructor.
     *
     * @param objectIdentity The identity of the MO Object.
     */
    public MOObject(ObjectIdentity objectIdentity) {
        this.objectIdentity = objectIdentity;
    }

    /**
     * Returns the Object Identity.
     *
     * @return The object identity.
     */
    public ObjectIdentity getObjectIdentity() {
        return objectIdentity;
    }

    /**
     * Returns a reference to this MO Object.
     *
     * @return The Object reference to this MO Object.
     */
    public ObjectRef getObjectRef() {
        return new ObjectRef(objectIdentity.getDomain(),
                this.getTypeId().getTypeId(),
                objectIdentity.getKey(),
                objectIdentity.getVersion()
        );
    }

    /**
     * Encodes the value of this object using the provided MALEncoder.
     *
     * @param encoder encoder - the encoder to use for encoding.
     * @throws org.ccsds.moims.mo.mal.MALException if any encoding errors are
     * detected.
     */
    public void encode(org.ccsds.moims.mo.mal.MALEncoder encoder) throws org.ccsds.moims.mo.mal.MALException {
        encoder.encodeElement(objectIdentity);
    }

    /**
     * Decodes the value of this object using the provided MALDecoder.
     *
     * @param decoder decoder - the decoder to use for decoding.
     * @return Returns this object.
     * @throws org.ccsds.moims.mo.mal.MALException if any decoding errors are
     * detected.
     */
    public org.ccsds.moims.mo.mal.structures.Element decode(org.ccsds.moims.mo.mal.MALDecoder decoder) throws org.ccsds.moims.mo.mal.MALException {
        objectIdentity = (ObjectIdentity) decoder.decodeElement(new ObjectIdentity());
        return this;
    }

    /**
     * Returns a String object representing this type's value.
     *
     * @return a string representation of the value of this object.
     */
    @Override
    public String toString() {
        StringBuilder buf = new StringBuilder();
        buf.append("objectIdentity=");
        buf.append(objectIdentity);
        return buf.toString();
    }

    /**
     * Compares this object to the specified object. The result is true if and
     * only if the argument is not null and is the same type that contains the
     * same value as this object.
     *
     * @param obj The object to compare with.
     * @return true if the objects are the same; false otherwise.
     */
    @Override
    public boolean equals(Object obj) {
        if (obj == null) {
            return false;
        }
        if (this == obj) {
            return true;
        }
        if (!(obj instanceof MOObject)) {
            return false;
        }
        return this.objectIdentity.equals(((MOObject) obj).getObjectIdentity());
    }

    @Override
    public int hashCode() {
        int hash = 7;
        hash = 29 * hash + (objectIdentity == null ? 0 : objectIdentity.hashCode());
        return hash;
    }
}