Package org.apache.poi.util
Class IntegerField
java.lang.Object
org.apache.poi.util.IntegerField
- All Implemented Interfaces:
FixedField
representation of an integer (32-bit) field at a fixed location
within a byte array
- Author:
- Marc Johnson (mjohnson at apache dot org
-
Constructor Summary
ConstructorsConstructorDescriptionIntegerField
(int offset) construct the IntegerField with its offset into its containing byte arrayIntegerField
(int offset, byte[] data) Construct the IntegerField with its offset into its containing byte array and initialize its value from its byte arrayIntegerField
(int offset, int value) construct the IntegerField with its offset into its containing byte array and initialize its valueIntegerField
(int offset, int value, byte[] data) construct the IntegerField with its offset into its containing byte array, initialize its value, and write the value to a byte array -
Method Summary
Modifier and TypeMethodDescriptionint
get()
get the IntegerField's current valuevoid
readFromBytes
(byte[] data) set the value from its offset into an array of bytesvoid
readFromStream
(InputStream stream) set the value from an InputStreamvoid
set
(int value) set the IntegerField's current valuevoid
set
(int value, byte[] data) set the IntegerField's current value and write it to a byte arraytoString()
return the value as a Stringvoid
writeToBytes
(byte[] data) write the value out to an array of bytes at the appropriate offset
-
Constructor Details
-
IntegerField
construct the IntegerField with its offset into its containing byte array- Parameters:
offset
- of the field within its byte array- Throws:
ArrayIndexOutOfBoundsException
- if the offset is negative
-
IntegerField
construct the IntegerField 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 the offset is negative
-
IntegerField
Construct the IntegerField 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)
-
IntegerField
construct the IntegerField with its offset into its containing byte array, initialize its value, and write the value to a 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 negative or too large
-
-
Method Details
-
get
public int get()get the IntegerField's current value- Returns:
- current value
-
set
public void set(int value) set the IntegerField's current value- Parameters:
value
- to be set
-
set
set the IntegerField'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 too large
-
readFromBytes
set the value from its offset into an array of bytes- Specified by:
readFromBytes
in interfaceFixedField
- Parameters:
data
- the byte array from which the value is to be read- Throws:
ArrayIndexOutOfBoundsException
- if the offset is too large
-
readFromStream
set the value from an InputStream- Specified by:
readFromStream
in 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:
writeToBytes
in interfaceFixedField
- Parameters:
data
- the array of bytes to which the value is to be written- Throws:
ArrayIndexOutOfBoundsException
- if the offset is too large
-
toString
return the value as a String- Specified by:
toString
in interfaceFixedField
- Overrides:
toString
in classObject
- Returns:
- the value as a String
-