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

Modifier and Type	Field and Description
private static final byte	_default_value
private final int	_offset
private byte	_value

Constructor Summary

Access	Constructor and Description
public	ByteField(final int of the field within its byte array offset) construct the ByteField with its offset into its containing byte array and a default value of 0
public	ByteField(final int of the field within its byte array offset, final byte the initial value value) construct the ByteField with its offset into its containing byte array and initialize its value
public	ByteField(final int of the field within its byte array offset, final byte[] the byte array to read the value from data) Construct the ByteField with its offset into its containing byte array and initialize its value from its byte array
public	ByteField(final int of the field within its byte array offset, final byte the initial value value, final byte[] the byte array to write the value to data) construct the ByteField 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 byte	Returns: current value get() get the ByteField'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 byte to be set value) set the ByteField's current value
public void	set(final byte to be set value, final byte[] the byte array to write the value to data) set the ByteField'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

_default_value	back to summary
private static final byte _default_value

_offset	back to summary
private final int _offset

_value	back to summary
private byte _value

Constructor Detail

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

ByteField

back to summary

public ByteField(final int offset) throws ArrayIndexOutOfBoundsException

construct the ByteField with its offset into its containing byte array and a default value of 0

Parameters

offset:int: of the field within its byte array

Exceptions

ArrayIndexOutOfBoundsException:: if offset is negative

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

ByteField

back to summary

public ByteField(final int offset, final byte value) throws ArrayIndexOutOfBoundsException

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

Parameters

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

Exceptions

ArrayIndexOutOfBoundsException:: if offset is negative

ByteField	back to summary
public ByteField(final int offset, final byte[] data) throws ArrayIndexOutOfBoundsException Construct the ByteField 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)

ByteField

back to summary

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

Construct the ByteField 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)

ByteField	back to summary
public ByteField(final int offset, final byte value, final byte[] data) throws ArrayIndexOutOfBoundsException construct the ByteField 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:byte the initial value data:byte[] the byte array to write the value to Exceptions ArrayIndexOutOfBoundsException: if the offset is not within the range of 0..(data.length - 1)

ByteField

back to summary

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

construct the ByteField 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:byte: the initial value
data:byte[]: the byte array to write the value to

Exceptions

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

Method Detail

get	back to summary
public byte get() get the ByteField's current value Returns:byte current value

get

back to summary

public byte get()

get the ByteField's current value

Returns:byte: 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 of the bte array

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 of the bte array

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 byte value) set the ByteField's current value Parameters value:byte to be set

set

back to summary

public void set(final byte value)

set the ByteField's current value

Parameters

value:byte: to be set

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

set

back to summary

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

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

Parameters

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

Exceptions

ArrayIndexOutOfBoundsException:: if the offset is out of the byte array's 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 the byte array's 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 the byte array's range

public Class ByteField

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail