galaxy.lang
Class Int16

java.lang.Object
  |
  +--galaxy.lang.GalaxyObject
        |
        +--galaxy.lang.BinaryObject
              |
              +--galaxy.lang.Int16
All Implemented Interfaces:
java.lang.Cloneable

public class Int16
extends BinaryObject

This class encapsulates an array of 16-bit integers.


Fields inherited from class galaxy.lang.BinaryObject
data
 
Fields inherited from class galaxy.lang.GalaxyObject
GAL_BINARY, GAL_CLAUSE_FRAME, GAL_FLOAT, GAL_FLOAT_32, GAL_FLOAT_64, GAL_FRAME, GAL_FREE, GAL_INT, GAL_INT_16, GAL_INT_32, GAL_INT_64, GAL_KEYWORD, GAL_LIST, GAL_PRED_FRAME, GAL_PROXY, GAL_PTR, GAL_STRING, GAL_SYMBOL, GAL_TAG, GAL_TOKEN, GAL_TOPIC_FRAME, nameToType, type, typeToName
 
Constructor Summary
Int16()
          Creates an empty array of shorts.
Int16(byte[] data)
          Deprecated. As of Galaxy Communicator 3.0. Use Int16(), Int16(short[]) and Int16(short[], boolean) constructors.
Int16(short[] shortArray)
          This constructor creates an object that encapsulates a reference to the specified array.
Int16(short[] shortArray, boolean makeCopy)
          This constructor creates an object that encapsulates the specified array.
 
Method Summary
 void append(short[] shortArray)
          Appends an array of shorts to this array object.
 byte[] getBytes()
          Returns this array as a byte array (in big endian byte order).
 short[] getShortArray()
           
 int getSize()
          Returns the length of this object's short array.
 short[] toShortArray()
          Deprecated. As of Galaxy Communicator 3.0. Use getShortArray in conjunction with Int16() and Int16(short[]) constructors.
 
Methods inherited from class galaxy.lang.BinaryObject
append, readBinaryFile, toEncodedString, toFormattedString, toString
 
Methods inherited from class galaxy.lang.GalaxyObject
getType, getTypeForObject, getTypeName, nameType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Int16

public Int16()
Creates an empty array of shorts.

Int16

public Int16(byte[] data)
Deprecated. As of Galaxy Communicator 3.0. Use Int16(), Int16(short[]) and Int16(short[], boolean) constructors.

This constructor creates an object that encapsulates a reference to the specified array. If the array is null, an empty array is created.

Int16

public Int16(short[] shortArray)
This constructor creates an object that encapsulates a reference to the specified array. If the array is null, an empty array is created.
Parameters:
shortArray - the array

Int16

public Int16(short[] shortArray,
             boolean makeCopy)
      throws java.lang.Exception
This constructor creates an object that encapsulates the specified array. If the array is null, an empty array is created. An exception is thrown if there is an error while copying the array.
Parameters:
shortArray - the array
makeCopy - if true, a copy of the array is stored. Otherwise, the reference to the array is stored.
Method Detail

getSize

public int getSize()
Returns the length of this object's short array. If there is no short array (i.e., the deprecated byte array is being used), the length of the byte array is returned.
Overrides:
getSize in class BinaryObject
Returns:
length of short array or byte array

append

public void append(short[] shortArray)
Appends an array of shorts to this array object. Only use this method if this array object is using a short array. If it is using a byte array, this method does nothing.
Parameters:
shortArray - the array of shorts to append

getShortArray

public short[] getShortArray()

toShortArray

public short[] toShortArray()
Deprecated. As of Galaxy Communicator 3.0. Use getShortArray in conjunction with Int16() and Int16(short[]) constructors.


getBytes

public byte[] getBytes()
Returns this array as a byte array (in big endian byte order).
Overrides:
getBytes in class BinaryObject
Returns:
the byte array or null if there is no data