Class IntegerField

java.lang.Object
org.apache.poi.util.IntegerField
All Implemented Interfaces:
FixedField

public class IntegerField extends Object implements 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

    Constructors
    Constructor
    Description
    IntegerField(int offset)
    construct the IntegerField with its offset into its containing byte array
    IntegerField(int offset, byte[] data)
    Construct the IntegerField with its offset into its containing byte array and initialize its value from its byte array
    IntegerField(int offset, int value)
    construct the IntegerField with its offset into its containing byte array and initialize its value
    IntegerField(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 Type
    Method
    Description
    int
    get()
    get the IntegerField's current value
    void
    readFromBytes(byte[] data)
    set the value from its offset into an array of bytes
    void
    set the value from an InputStream
    void
    set(int value)
    set the IntegerField's current value
    void
    set(int value, byte[] data)
    set the IntegerField's current value and write it to a byte array
    return the value as a String
    void
    writeToBytes(byte[] data)
    write the value out to an array of bytes at the appropriate offset

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • IntegerField

      public IntegerField(int offset) throws ArrayIndexOutOfBoundsException
      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

      public IntegerField(int offset, int value) throws ArrayIndexOutOfBoundsException
      construct the IntegerField with its offset into its containing byte array and initialize its value
      Parameters:
      offset - of the field within its byte array
      value - the initial value
      Throws:
      ArrayIndexOutOfBoundsException - if the offset is negative
    • IntegerField

      public IntegerField(int offset, byte[] data) throws ArrayIndexOutOfBoundsException
      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 array
      data - the byte array to read the value from
      Throws:
      ArrayIndexOutOfBoundsException - if the offset is not within the range of 0..(data.length - 1)
    • IntegerField

      public IntegerField(int offset, int value, byte[] data) throws ArrayIndexOutOfBoundsException
      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 array
      value - the initial value
      data - the byte array to write the value to
      Throws:
      ArrayIndexOutOfBoundsException - if the offset is negative or too large
  • Method Details