Package org.apache.pdfbox.cos

Class COSInteger

java.lang.Object
org.apache.pdfbox.cos.COSBase
org.apache.pdfbox.cos.COSNumber
org.apache.pdfbox.cos.COSInteger
All Implemented Interfaces:
COSObjectable
public final class COSInteger extends COSNumber
This class represents an integer number in a PDF document.

  • Field Details

    • LOW

      private static final int LOW
      The lowest integer to be kept in the STATIC array.
      See Also:

    • HIGH

      private static final int HIGH
      The highest integer to be kept in the STATIC array.
      See Also:

    • STATIC

      private static final COSInteger[] STATIC
      Static instances of all COSIntegers in the range from LOW to HIGH.

    • ZERO

      public static final COSInteger ZERO
      Constant for the number zero.
      Since:
      Apache PDFBox 1.1.0

    • ONE

      public static final COSInteger ONE
      Constant for the number one.
      Since:
      Apache PDFBox 1.1.0

    • TWO

      public static final COSInteger TWO
      Constant for the number two.
      Since:
      Apache PDFBox 1.1.0

    • THREE

      public static final COSInteger THREE
      Constant for the number three.
      Since:
      Apache PDFBox 1.1.0

    • OUT_OF_RANGE_MAX

      static final COSInteger OUT_OF_RANGE_MAX
      Constant for an out of range value which is bigger than Log.MAX_VALUE.

    • OUT_OF_RANGE_MIN

      static final COSInteger OUT_OF_RANGE_MIN
      Constant for an out of range value which is smaller than Log.MIN_VALUE.

    • value

      private final long value

    • isValid

      private final boolean isValid

  • Constructor Details

    • COSInteger

      private COSInteger(long val, boolean valid)
      constructor.
      Parameters:
      val - The integer value of this object.
      valid - indicates if the value is valid.

  • Method Details

    • get

      public static COSInteger get(long val)
      Returns a COSInteger instance with the given value.
      Parameters:
      val - integer value
      Returns:
      COSInteger instance

    • getInvalid

      private static COSInteger getInvalid(boolean maxValue)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • floatValue

      public float floatValue()
      polymorphic access to value as float.
      Specified by:
      floatValue in class COSNumber
      Returns:
      The float value of this object.

    • intValue

      public int intValue()
      Polymorphic access to value as int This will get the integer value of this object.
      Specified by:
      intValue in class COSNumber
      Returns:
      The int value of this object,

    • longValue

      public long longValue()
      Polymorphic access to value as int This will get the integer value of this object.
      Specified by:
      longValue in class COSNumber
      Returns:
      The int value of this object,

    • isValid

      public boolean isValid()
      Indicates whether this instance represents a valid value.
      Returns:
      true if the value is valid

    • accept

      public void accept(ICOSVisitor visitor) throws IOException
      visitor pattern double dispatch method.
      Specified by:
      accept in class COSBase
      Parameters:
      visitor - The object to notify when visiting this object.
      Throws:
      IOException - If an error occurs while visiting this object.

    • writePDF

      public void writePDF(OutputStream output) throws IOException
      This will output this string as a PDF object.
      Parameters:
      output - The stream to write to.
      Throws:
      IOException - If there is an error writing to the stream.