Apache POI - Common 5.3.0 · org.apache.poi.util.ShortField

Modifier and Type	Field and Description
private final int	_offset
private short	_value

Constructor Summary

Access	Constructor and Description
public	ShortField(final int of the field within its byte array offset) construct the ShortField with its offset into its containing byte array
public	ShortField(final int of the field within its byte array offset, final short the initial value value) construct the ShortField with its offset into its containing byte array and initialize its value
public	ShortField(final int of the field within its byte array offset, final byte[] the byte array to read the value from data) Construct the ShortField with its offset into its containing byte array and initialize its value from its byte array
public	ShortField(final int of the field within its byte array offset, final short the initial value value, final byte[] the byte array to write the value to data) construct the ShortField with its offset into its containing byte array, initialize its value, and write its value to its byte array

Method Summary

Modifier and Type	Method and Description
public short	Returns: current value get() get the ShortField's current value
public void	readFromBytes(final byte[] the byte array from which the value is to be read data) Implements org.apache.poi.util.FixedField.readFromBytes. set the value from its offset into an array of bytes
public void	readFromStream(final InputStream the InputStream from which the value is to be read stream) Implements org.apache.poi.util.FixedField.readFromStream. set the value from an InputStream
public void	set(final short to be set value) set the ShortField's current value
public void	set(final short to be set value, final byte[] the byte array to write the value to data) set the ShortField's current value and write it to a byte array
public String	Returns: the value as a String toString() Overrides java.lang.Object.toString. Implements org.apache.poi.util.FixedField.toString. return the value as a String
public void	writeToBytes(final byte[] the array of bytes to which the value is to be written data) Implements org.apache.poi.util.FixedField.writeToBytes. write the value out to an array of bytes at the appropriate offset

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_offset	back to summary
private final int _offset

_value	back to summary
private short _value

Constructor Detail

ShortField	back to summary
public ShortField(final int offset) throws ArrayIndexOutOfBoundsException construct the ShortField with its offset into its containing byte array Parameters offset:int of the field within its byte array Exceptions ArrayIndexOutOfBoundsException: if offset is negative

ShortField

back to summary

public ShortField(final int offset) throws ArrayIndexOutOfBoundsException

construct the ShortField with its offset into its containing byte array

Parameters

offset:int: of the field within its byte array

Exceptions

ArrayIndexOutOfBoundsException:: if offset is negative

ShortField	back to summary
public ShortField(final int offset, final short value) throws ArrayIndexOutOfBoundsException construct the ShortField with its offset into its containing byte array and initialize its value Parameters offset:int of the field within its byte array value:short the initial value Exceptions ArrayIndexOutOfBoundsException: if offset is negative

ShortField

back to summary

public ShortField(final int offset, final short value) throws ArrayIndexOutOfBoundsException

construct the ShortField with its offset into its containing byte array and initialize its value

Parameters

offset:int: of the field within its byte array
value:short: the initial value

Exceptions

ArrayIndexOutOfBoundsException:: if offset is negative

ShortField	back to summary
public ShortField(final int offset, final byte[] data) throws ArrayIndexOutOfBoundsException Construct the ShortField with its offset into its containing byte array and initialize its value from its byte array Parameters offset:int of the field within its byte array data:byte[] the byte array to read the value from Exceptions ArrayIndexOutOfBoundsException: if the offset is not within the range of 0..(data.length - 1)

ShortField

back to summary

public ShortField(final int offset, final byte[] data) throws ArrayIndexOutOfBoundsException

Construct the ShortField with its offset into its containing byte array and initialize its value from its byte array

Parameters

offset:int: of the field within its byte array
data:byte[]: the byte array to read the value from

Exceptions

ArrayIndexOutOfBoundsException:: if the offset is not within the range of 0..(data.length - 1)

ShortField	back to summary
public ShortField(final int offset, final short value, final byte[] data) throws ArrayIndexOutOfBoundsException construct the ShortField with its offset into its containing byte array, initialize its value, and write its value to its byte array Parameters offset:int of the field within its byte array value:short the initial value data:byte[] the byte array to write the value to Exceptions ArrayIndexOutOfBoundsException: if offset is negative

ShortField

back to summary

public ShortField(final int offset, final short value, final byte[] data) throws ArrayIndexOutOfBoundsException

construct the ShortField with its offset into its containing byte array, initialize its value, and write its value to its byte array

Parameters

offset:int: of the field within its byte array
value:short: the initial value
data:byte[]: the byte array to write the value to

Exceptions

ArrayIndexOutOfBoundsException:: if offset is negative

Method Detail

get	back to summary
public short get() get the ShortField's current value Returns:short current value

get

back to summary

public short get()

get the ShortField's current value

Returns:short: current value

readFromBytes	back to summary
public void readFromBytes(final byte[] data) throws ArrayIndexOutOfBoundsException Implements org.apache.poi.util.FixedField.readFromBytes. set the value from its offset into an array of bytes Parameters data:byte[] the byte array from which the value is to be read Exceptions ArrayIndexOutOfBoundsException: if the offset is out of range

readFromBytes

back to summary

public void readFromBytes(final byte[] data) throws ArrayIndexOutOfBoundsException

Implements org.apache.poi.util.FixedField.readFromBytes.

set the value from its offset into an array of bytes

Parameters

data:byte[]: the byte array from which the value is to be read

Exceptions

ArrayIndexOutOfBoundsException:: if the offset is out of range

readFromStream	back to summary
public void readFromStream(final InputStream stream) throws IOException Implements org.apache.poi.util.FixedField.readFromStream. set the value from an InputStream Parameters stream:InputStream the InputStream from which the value is to be read Exceptions IOException: if an IOException is thrown from reading the InputStream BufferUnderrunException: if there is not enough data available from the InputStream

readFromStream

back to summary

public void readFromStream(final InputStream stream) throws IOException

Implements org.apache.poi.util.FixedField.readFromStream.

set the value from an InputStream

Parameters

stream:InputStream: the InputStream from which the value is to be read

Exceptions

IOException:: if an IOException is thrown from reading the InputStream
BufferUnderrunException:: if there is not enough data available from the InputStream

set	back to summary
public void set(final short value) set the ShortField's current value Parameters value:short to be set

set

back to summary

public void set(final short value)

set the ShortField's current value

Parameters

value:short: to be set

set	back to summary
public void set(final short value, final byte[] data) throws ArrayIndexOutOfBoundsException set the ShortField's current value and write it to a byte array Parameters value:short to be set data:byte[] the byte array to write the value to Exceptions ArrayIndexOutOfBoundsException: if the offset is out of range

set

back to summary

public void set(final short value, final byte[] data) throws ArrayIndexOutOfBoundsException

set the ShortField's current value and write it to a byte array

Parameters

value:short: to be set
data:byte[]: the byte array to write the value to

Exceptions

ArrayIndexOutOfBoundsException:: if the offset is out of range

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Implements org.apache.poi.util.FixedField.toString. return the value as a String Returns:String the value as a String

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Implements org.apache.poi.util.FixedField.toString.

return the value as a String

Returns:String: the value as a String

writeToBytes	back to summary
public void writeToBytes(final byte[] data) throws ArrayIndexOutOfBoundsException Implements org.apache.poi.util.FixedField.writeToBytes. write the value out to an array of bytes at the appropriate offset Parameters data:byte[] the array of bytes to which the value is to be written Exceptions ArrayIndexOutOfBoundsException: if the offset is out of range

writeToBytes

back to summary

public void writeToBytes(final byte[] data) throws ArrayIndexOutOfBoundsException

Implements org.apache.poi.util.FixedField.writeToBytes.

write the value out to an array of bytes at the appropriate offset

Parameters

data:byte[]: the array of bytes to which the value is to be written

Exceptions

ArrayIndexOutOfBoundsException:: if the offset is out of range

public Class ShortField

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail