FileDocCategorySizeDatePackage
ShortField.javaAPI DocApache Poi 3.0.16083Mon Jan 01 12:39:42 GMT 2007org.apache.poi.util

ShortField

public class ShortField extends Object implements FixedField
representation of a short (16-bit) field at a fixed location within a byte array
author
Marc Johnson (mjohnson at apache dot org

Fields Summary
private short
_value
private final int
_offset
Constructors Summary
public ShortField(int offset)
construct the ShortField with its offset into its containing byte array

param
offset of the field within its byte array
exception
ArrayIndexOutOfBoundsException if offset is negative

        if (offset < 0)
        {
            throw new ArrayIndexOutOfBoundsException("Illegal offset: "
                                                     + offset);
        }
        _offset = offset;
    
public ShortField(int offset, short value)
construct the ShortField with its offset into its containing byte array and initialize its value

param
offset of the field within its byte array
param
value the initial value
exception
ArrayIndexOutOfBoundsException if offset is negative

        this(offset);
        set(value);
    
public ShortField(int offset, byte[] data)
Construct the ShortField with its offset into its containing byte array and initialize its value from its byte array

param
offset of the field within its byte array
param
data the byte array to read the value from
exception
ArrayIndexOutOfBoundsException if the offset is not within the range of 0..(data.length - 1)

        this(offset);
        readFromBytes(data);
    
public ShortField(int offset, short value, byte[] data)
construct the ShortField with its offset into its containing byte array, initialize its value, and write its value to its byte array

param
offset of the field within its byte array
param
value the initial value
param
data the byte array to write the value to
exception
ArrayIndexOutOfBoundsException if offset is negative

        this(offset);
        set(value, data);
    
Methods Summary
public shortget()
get the ShortField's current value

return
current value

        return _value;
    
public voidreadFromBytes(byte[] data)
set the value from its offset into an array of bytes

param
data the byte array from which the value is to be read
exception
ArrayIndexOutOfBoundsException if the offset is out of range

        _value = LittleEndian.getShort(data, _offset);
    
public voidreadFromStream(java.io.InputStream stream)
set the value from an InputStream

param
stream the InputStream from which the value is to be read
exception
BufferUnderrunException if there is not enough data available from the InputStream
exception
IOException if an IOException is thrown from reading the InputStream

        _value = LittleEndian.readShort(stream);
    
public voidset(short value)
set the ShortField's current value

param
value to be set

        _value = value;
    
public voidset(short value, byte[] data)
set the ShortField's current value and write it to a byte array

param
value to be set
param
data the byte array to write the value to
exception
ArrayIndexOutOfBoundsException if the offset is out of range

        _value = value;
        writeToBytes(data);
    
public java.lang.StringtoString()
return the value as a String

return
the value as a String

        return String.valueOf(_value);
    
public voidwriteToBytes(byte[] data)
write the value out to an array of bytes at the appropriate offset

param
data the array of bytes to which the value is to be written
exception
ArrayIndexOutOfBoundsException if the offset is out of range

        LittleEndian.putShort(data, _offset, _value);