Package org.apache.pdfbox.cos

Class COSFloat

  • All Implemented Interfaces:
    COSObjectable
    public class COSFloat
extends COSNumber
    This class represents a floating point number in a PDF document.
    Author:
    Ben Litchfield

    • Constructor Summary

      Constructors 
      Constructor Description
      COSFloat​(float aFloat)
      Constructor.
      COSFloat​(java.lang.String aFloat)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object accept​(ICOSVisitor visitor)
      visitor pattern double dispatch method.
      double doubleValue()
      The value of the double object that this one wraps.
      boolean equals​(java.lang.Object o)
      float floatValue()
      The value of the float object that this one wraps.
      int hashCode()
      int intValue()
      This will get the integer value of this object.
      long longValue()
      This will get the long value of this object.
      java.lang.String toString()
      void writePDF​(java.io.OutputStream output)
      This will output this string as a PDF object.

      • Methods inherited from class org.apache.pdfbox.cos.COSNumber

        get

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • COSFloat

        public COSFloat​(float aFloat)
        Constructor.
        Parameters:
        aFloat - The primitive float object that this object wraps.

      • COSFloat

        public COSFloat​(java.lang.String aFloat)
         throws java.io.IOException
        Constructor.
        Parameters:
        aFloat - The primitive float object that this object wraps.
        Throws:
        java.io.IOException - If aFloat is not a float.

    • Method Detail

      • floatValue

        public float floatValue()
        The value of the float object that this one wraps.
        Specified by:
        floatValue in class COSNumber
        Returns:
        The value of this object.

      • doubleValue

        public double doubleValue()
        The value of the double object that this one wraps.
        Specified by:
        doubleValue in class COSNumber
        Returns:
        The double of this object.

      • longValue

        public long longValue()
        This will get the long value of this object.
        Specified by:
        longValue in class COSNumber
        Returns:
        The long value of this object,

      • intValue

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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • accept

        public java.lang.Object accept​(ICOSVisitor visitor)
                        throws java.io.IOException
        visitor pattern double dispatch method.
        Specified by:
        accept in class COSBase
        Parameters:
        visitor - The object to notify when visiting this object.
        Returns:
        any object, depending on the visitor implementation, or null
        Throws:
        java.io.IOException - If an error occurs while visiting this object.

      • writePDF

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