galaxy.lang
Class GBinary

java.lang.Object
  |
  +--galaxy.lang.GalaxyObject
        |
        +--galaxy.lang.GBinary
All Implemented Interfaces:
ArrayObject, java.lang.Cloneable

public class GBinary
extends GalaxyObject
implements ArrayObject

This class encapsulates an array of bytes.


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
GBinary()
          Creates an empty array of bytes.
GBinary(byte[] byteArray)
          This constructor creates an object that encapsulates the reference to array of bytes.
GBinary(byte[] byteArray, boolean makeCopy)
          This constructor creates an object that encapsulates the reference to array of bytes.
 
Method Summary
 void append(byte[] byteArray)
          Appends an array of bytes to this object's array.
 void append(GBinary gbinary)
          Appends the array of the specified GBinary object to this object's array.
 byte[] getBytes()
          Returns reference to this object's array of bytes.
 int getSize()
          Returns the length of this object's array of bytes.
static byte[] readBinaryFile(java.lang.String file)
          Converts a binary file into an array of bytes.
 double[] toDoubleArray()
          Returns the byte array as an array of floats.
 java.lang.String toEncodedString()
           
 float[] toFloatArray()
          Returns the byte array as an array of floats.
 java.lang.String toFormattedString()
           
 int[] toIntArray()
          Returns the byte array as an array of integers.
 long[] toLongArray()
          Returns the byte array as an array of longs.
 short[] toShortArray()
          Returns the byte array as an array of shorts.
 java.lang.String toString()
           
 
Methods inherited from class galaxy.lang.GalaxyObject
getNameForObject, getType, getTypeForObject, getTypeName, isArrayType, nameType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GBinary

public GBinary()
Creates an empty array of bytes.

GBinary

public GBinary(byte[] byteArray)
This constructor creates an object that encapsulates the reference to array of bytes. If the array is null, an empty array is created.
Parameters:
byteArray - the array

GBinary

public GBinary(byte[] byteArray,
               boolean makeCopy)
        throws java.lang.RuntimeException
This constructor creates an object that encapsulates the reference to array of bytes. If the array is null, an empty array is created.
Parameters:
byteArray - the array
makeCopy - if true, a copy of the array is stored. Otherwise, the reference to the array is stored.
Throws:
java.lang.RuntimeException - If there is an error while copying the array.
Method Detail

getSize

public int getSize()
Returns the length of this object's array of bytes.
Specified by:
getSize in interface ArrayObject
Returns:
length of array

append

public void append(byte[] byteArray)
            throws java.lang.RuntimeException
Appends an array of bytes to this object's array.
Parameters:
byteArray - the array to append
Throws:
java.lang.RuntimeException - If there is an error while appending to the array.

append

public void append(GBinary gbinary)
            throws java.lang.RuntimeException
Appends the array of the specified GBinary object to this object's array.
Parameters:
gbinary - the GBinary to append
Throws:
java.lang.RuntimeException - If there is an error while appending to the array.

getBytes

public byte[] getBytes()
Returns reference to this object's array of bytes.
Specified by:
getBytes in interface ArrayObject
Returns:
reference to the array

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toEncodedString

public java.lang.String toEncodedString()

toFormattedString

public java.lang.String toFormattedString()

toFloatArray

public float[] toFloatArray()
Returns the byte array as an array of floats.
Returns:
the array of floats or null if the is an error

toDoubleArray

public double[] toDoubleArray()
Returns the byte array as an array of floats.
Returns:
the array of floats or null if the is an error

toShortArray

public short[] toShortArray()
Returns the byte array as an array of shorts.
Returns:
the array of shorts or null if the is an error

toIntArray

public int[] toIntArray()
Returns the byte array as an array of integers.
Returns:
the array of integers or null if the is an error

toLongArray

public long[] toLongArray()
Returns the byte array as an array of longs.
Returns:
the array of longs or null if the is an error

readBinaryFile

public static byte[] readBinaryFile(java.lang.String file)
                             throws java.io.IOException
Converts a binary file into an array of bytes.
Parameters:
file - the name of the binary file to convert
Returns:
the contents of the file in a byte array or null if there was an error