Package org.apache.poi.util
Interface FixedField
- All Known Implementing Classes:
ByteField
,IntegerField
,LongField
,ShortField
public interface FixedField
behavior of a field at a fixed location within a byte array
- Author:
- Marc Johnson (mjohnson at apache dot org
-
Method Summary
Modifier and TypeMethodDescriptionvoid
readFromBytes
(byte[] data) set the value from its offset into an array of bytesvoid
readFromStream
(InputStream stream) set the value from an InputStreamtoString()
return the value as a Stringvoid
writeToBytes
(byte[] data) write the value out to an array of bytes at the appropriate offset
-
Method Details
-
readFromBytes
set the value from its offset into an array of bytes- Parameters:
data
- the byte array from which the value is to be read- Throws:
ArrayIndexOutOfBoundsException
- if the offset is out of the array's valid index range
-
readFromStream
set the value from an InputStream- 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- Parameters:
data
- the array of bytes to which the value is to be written- Throws:
ArrayIndexOutOfBoundsException
- if the offset is out of the array's valid index range
-
toString
String toString()return the value as a String
-