Package loci.poi.util
Class ByteField
java.lang.Object
loci.poi.util.ByteField
- All Implemented Interfaces:
FixedField
representation of a byte (8-bit) field at a fixed location within a
byte array
- Author:
- Marc Johnson (mjohnson at apache dot org
-
Constructor Summary
ConstructorsConstructorDescriptionByteField(int offset) construct the ByteField with its offset into its containing byte array and a default value of 0ByteField(int offset, byte value) construct the ByteField with its offset into its containing byte array and initialize its valueByteField(int offset, byte[] data) Construct the ByteField with its offset into its containing byte array and initialize its value from its byte arrayByteField(int offset, byte value, byte[] 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 TypeMethodDescriptionbyteget()get the ByteField's current valuevoidreadFromBytes(byte[] data) set the value from its offset into an array of bytesvoidreadFromStream(InputStream stream) set the value from an InputStreamvoidset(byte value) set the ByteField's current valuevoidset(byte value, byte[] data) set the ByteField's current value and write it to a byte arraytoString()return the value as a StringvoidwriteToBytes(byte[] data) write the value out to an array of bytes at the appropriate offset
-
Constructor Details
-
ByteField
construct the ByteField with its offset into its containing byte array and a default value of 0- Parameters:
offset- of the field within its byte array- Throws:
ArrayIndexOutOfBoundsException- if offset is negative
-
ByteField
construct the ByteField with its offset into its containing byte array and initialize its value- Parameters:
offset- of the field within its byte arrayvalue- the initial value- Throws:
ArrayIndexOutOfBoundsException- if offset is negative
-
ByteField
Construct the ByteField with its offset into its containing byte array and initialize its value from its byte array- Parameters:
offset- of the field within its byte arraydata- the byte array to read the value from- Throws:
ArrayIndexOutOfBoundsException- if the offset is not within the range of 0..(data.length - 1)
-
ByteField
construct the ByteField with its offset into its containing byte array, initialize its value, and write its value to its byte array- Parameters:
offset- of the field within its byte arrayvalue- the initial valuedata- the byte array to write the value to- Throws:
ArrayIndexOutOfBoundsException- if the offset is not within the range of 0..(data.length - 1)
-
-
Method Details
-
get
public byte get()get the ByteField's current value- Returns:
- current value
-
set
public void set(byte value) set the ByteField's current value- Parameters:
value- to be set
-
set
set the ByteField's current value and write it to a byte array- Parameters:
value- to be setdata- the byte array to write the value to- Throws:
ArrayIndexOutOfBoundsException- if the offset is out of the byte array's range
-
readFromBytes
set the value from its offset into an array of bytes- Specified by:
readFromBytesin interfaceFixedField- Parameters:
data- the byte array from which the value is to be read- Throws:
ArrayIndexOutOfBoundsException- if the offset is out of range of the bte array
-
readFromStream
public void readFromStream(InputStream stream) throws IOException, LittleEndian.BufferUnderrunException set the value from an InputStream- Specified by:
readFromStreamin interfaceFixedField- Parameters:
stream- the InputStream from which the value is to be read- Throws:
LittleEndian.BufferUnderrunException- if there is not enough data available from the InputStreamIOException- if an IOException is thrown from reading the InputStream
-
writeToBytes
write the value out to an array of bytes at the appropriate offset- Specified by:
writeToBytesin interfaceFixedField- Parameters:
data- the array of bytes to which the value is to be written- Throws:
ArrayIndexOutOfBoundsException- if the offset is out of the byte array's range
-
toString
return the value as a String- Specified by:
toStringin interfaceFixedField- Overrides:
toStringin classObject- Returns:
- the value as a String
-