org.ccsds.moims.mo.mal.structures.IdBooleanPair 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!
package org.ccsds.moims.mo.mal.structures;

/**
 * IdBooleanPair shall be a simple pair type of an identifier and Boolean 
 * value. 
 */
public final class IdBooleanPair implements org.ccsds.moims.mo.mal.structures.Composite {

    private static final long serialVersionUID = 281475027043308L;
    /**
     * The TypeId of this Element as a long.
     */
    public static final Long SHORT_FORM = 281475027043308L;
    /**
     * The TypeId of this Element.
     */
    public static final org.ccsds.moims.mo.mal.TypeId TYPE_ID = new org.ccsds.moims.mo.mal.TypeId(SHORT_FORM);

    /**
     * The Identifier value.
     */
    private org.ccsds.moims.mo.mal.structures.Identifier id;

    /**
     * The Boolean value.
     */
    private Boolean value;

    /**
     * Default constructor for IdBooleanPair.
     * 
     */
    public IdBooleanPair() {
    }

    /**
     * Constructor that initialises the values of the structure.
     * 
     * @param id The Identifier value.
     * @param value The Boolean value.
     */
    public IdBooleanPair(org.ccsds.moims.mo.mal.structures.Identifier id,
            Boolean value) {
        this.id = id;
        this.value = value;
    }

    /**
     * Constructor that initialises the non-nullable values of the structure. 
     * 
     * @param id The Identifier value.
     */
    public IdBooleanPair(org.ccsds.moims.mo.mal.structures.Identifier id) {
        this.id = id;
        this.value = null;
    }

    /**
     * Creates an instance of this type using the default constructor. It is a 
     * generic factory method. 
     * 
     * @return A new instance of this type with default field values.
     */
    public org.ccsds.moims.mo.mal.structures.Element createElement() {
        return new org.ccsds.moims.mo.mal.structures.IdBooleanPair();
    }

    /**
     * Returns the field id.
     * 
     * @return The field id.
     */
    public org.ccsds.moims.mo.mal.structures.Identifier getId() {
        return id;
    }

    /**
     * Sets the field id.
     * 
     * @param __newValue The new value.
     */
    @Deprecated
    public void setId(org.ccsds.moims.mo.mal.structures.Identifier __newValue) {
        id = __newValue;
    }

    /**
     * Returns the field value.
     * 
     * @return The field value.
     */
    public Boolean getValue() {
        return value;
    }

    /**
     * Sets the field value.
     * 
     * @param __newValue The new value.
     */
    @Deprecated
    public void setValue(Boolean __newValue) {
        value = __newValue;
    }

    /**
     * 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.
     */
    public boolean equals(Object obj) {
        if (obj instanceof IdBooleanPair) {
            IdBooleanPair other = (IdBooleanPair) obj;
            if (id == null) {
                if (other.id != null) {
                    return false;
                }
            } else {
                if (! id.equals(other.id)) {
                    return false;
                }
            }
            if (value == null) {
                if (other.value != null) {
                    return false;
                }
            } else {
                if (! value.equals(other.value)) {
                    return false;
                }
            }
            return true;
        }
        return false;
    }

    /**
     * Returns a hash code for this object.
     * 
     * @return a hash code value for this object.
     */
    public int hashCode() {
        int hash = 7;
        hash = 83 * hash + (id != null ? id.hashCode() : 0);
        hash = 83 * hash + (value != null ? value.hashCode() : 0);
        return hash;
    }

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

    /**
     * Encodes the value of this object using the provided MALEncoder.
     * 
     * @param 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 {
        if (id == null) {
            throw new org.ccsds.moims.mo.mal.MALException("The field 'id' cannot be null!");
        }
        encoder.encodeIdentifier(id);
        encoder.encodeNullableBoolean(value);
    }

    /**
     * Decodes the value of this object using the provided MALDecoder.
     * 
     * @param 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 {
        id = decoder.decodeIdentifier();
        value = decoder.decodeNullableBoolean();
        return this;
    }

    /**
     * Returns the TypeId of this element.
     * 
     * @return The TypeId of this element.
     */
    public org.ccsds.moims.mo.mal.TypeId getTypeId() {
        return TYPE_ID;
    }

}