org.ccsds.moims.mo.mal.structures.UShort Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of api-mal Show documentation
Show all versions of api-mal Show documentation
An implementation of the Java API for the CCSDS MAL
/* ----------------------------------------------------------------------------
* 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;
import org.ccsds.moims.mo.mal.MALDecoder;
import org.ccsds.moims.mo.mal.MALEncoder;
import org.ccsds.moims.mo.mal.MALException;
/**
* Class representing MAL UShort type.
*/
public class UShort implements Attribute {
/**
*
*/
public static final UShort ATTRIBUTE_AREA_NUMBER = new UShort(1);
/**
*
*/
public static final UShort ATTRIBUTE_SERVICE_NUMBER = new UShort(0);
private int value;
/**
* A constant holding the maximum value a {@code UShort} can have,
* 216-1.
*/
public static final int MAX_VALUE = 65535;
/**
* Default constructor.
*/
public UShort() {
value = 0;
}
/**
* Initialiser constructor.
*
* @param value Value to initialise with.
*/
public UShort(final int value) {
if (0 > value) {
throw new IllegalArgumentException("UShort argument must not be negative");
}
if (UShort.MAX_VALUE < value) {
throw new IllegalArgumentException("UShort argument must not be greater than " + UShort.MAX_VALUE);
}
this.value = value;
}
@Override
public Element createElement() {
return new UShort();
}
/**
* Returns the value of this type.
*
* @return the value.
*/
public int getValue() {
return value;
}
// This might be required for XML serialisation and technologies that use that.
// public void setValue(int value)
// {
// this.value = value;
// }
@Override
public Long getShortForm() {
return Attribute.USHORT_SHORT_FORM;
}
@Override
public Integer getTypeShortForm() {
return Attribute.USHORT_TYPE_SHORT_FORM;
}
@Override
public UShort getAreaNumber() {
return UShort.ATTRIBUTE_AREA_NUMBER;
}
@Override
public org.ccsds.moims.mo.mal.structures.UOctet getAreaVersion() {
return UOctet.AREA_VERSION;
}
@Override
public UShort getServiceNumber() {
return UShort.ATTRIBUTE_SERVICE_NUMBER;
}
@Override
public void encode(final MALEncoder encoder) throws MALException {
encoder.encodeUShort(this);
}
@Override
public Element decode(final MALDecoder decoder) throws MALException {
return decoder.decodeUShort();
}
@Override
public boolean equals(final Object obj) {
if (null == obj) {
return false;
}
if (this == obj) {
return true;
}
if (!(obj instanceof UShort)) {
return false;
}
return this.value == (((UShort) obj).value);
}
@Override
public int hashCode() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
private static final long serialVersionUID = Attribute.USHORT_SHORT_FORM;
}