COSFloat (Apache PDFBox 1.8.10 API)

java.lang.Object
+
- org.apache.pdfbox.cos.COSBase
- +
  - org.apache.pdfbox.cos.COSNumber
  - +
    - org.apache.pdfbox.cos.COSFloat
    +
  +
+

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

+ +

+ + +
Field Summary
+
- + + +
  Fields inherited from class org.apache.pdfbox.cos.COSNumber
  +ONE, ZERO
+

+ +

+ + +
Constructor Summary
+ + + + + + + + + + + +
Constructors
Constructor and Description
COSFloat(float aFloat) +
Constructor.
+
COSFloat(String aFloat) +
Constructor.
+
+

Constructors
Constructor and Description
`COSFloat(float aFloat)` + Constructor. +
`COSFloat(String aFloat)` + Constructor. +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`Object`	`accept(ICOSVisitor visitor)` + visitor pattern double dispatch method. +
`double`	`doubleValue()` + The value of the double object that this one wraps. +
`boolean`	`equals(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. +
`void`	`setValue(float floatValue)` + Set the value of the float object. +
`String`	`toString()`
`void`	`writePDF(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 org.apache.pdfbox.cos.COSBase
+getCOSObject, getFilterManager, isDirect, isNeedToBeUpdate, setDirect, setNeedToBeUpdate

+ + +
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(String aFloat)
+         throws IOException
```
    +
    Constructor.
    +
    Parameters:
    aFloat - The primitive float object that this object wraps.
    +
    Throws:
    +
    IOException - If aFloat is not a float.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    setValue
    +
```
public void setValue(float floatValue)
```
    +
    Set the value of the float object.
    +
    Parameters:
    floatValue - The new float value.
    +
  + + + +
  - +
    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(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
    +
    +
  + + + +
  - +
    accept
    +
```
public Object accept(ICOSVisitor visitor)
+              throws COSVisitorException
```
    +
    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:
    +
    COSVisitorException - 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.
    +
  +
+

java.lang.Object
+
- org.apache.pdfbox.cos.COSBase
- +
  - org.apache.pdfbox.cos.COSNumber
  - +
    - org.apache.pdfbox.cos.COSInteger
    +
  +
+

+
+
All Implemented Interfaces:
+
COSObjectable
+
+
+
+
```
public class COSInteger
+extends COSNumber
```
+
This class represents an integer number in a PDF document.
+
Version:
+
$Revision: 1.12 $
+
Author:
+
Ben Litchfield
+

+ +

+ + +

Field Summary

+ + + + + + + + + + + + + + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`static COSInteger`	`ONE` + Constant for the number one. +
`static COSInteger`	`THREE` + Constant for the number three. +
`static COSInteger`	`TWO` + Constant for the number two. +
`static COSInteger`	`ZERO` + Constant for the number zero. +

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`COSInteger(int val)` + Deprecated. + use the static `get(long)` method instead + +
`COSInteger(long val)` + Deprecated. + use the static `get(long)` method instead + +
`COSInteger(String val)` + Deprecated. + use the static `get(long)` method instead + +

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`Object`	`accept(ICOSVisitor visitor)` + visitor pattern double dispatch method. +
`double`	`doubleValue()` + polymorphic access to value as float. +
`boolean`	`equals(Object o)`
`float`	`floatValue()` + polymorphic access to value as float. +
`static COSInteger`	`get(long val)` + Returns a COSInteger instance with the given value. +
`int`	`hashCode()`
`int`	`intValue()` + Polymorphic access to value as int + This will get the integer value of this object. +
`long`	`longValue()` + Polymorphic access to value as int + This will get the integer value of this object. +
`void`	`setValue(long newValue)` + Change the value of this reference. +
`String`	`toString()`
`void`	`writePDF(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 org.apache.pdfbox.cos.COSBase
+getCOSObject, getFilterManager, isDirect, isNeedToBeUpdate, setDirect, setNeedToBeUpdate

+ + +
Methods inherited from class java.lang.Object
+clone, finalize, getClass, notify, notifyAll, wait, wait, wait

+ +
- + + +
  Field Detail
  + + + +
  - +
    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
    +
  +
+ +
- + + +
  Constructor Detail
  + + + +
  - +
    COSInteger
    +
```
public COSInteger(long val)
```
    +
    Deprecated. use the static get(long) method instead
    +
    constructor.
    +
    Parameters:
    val - The integer value of this object.
    +
  + + + +
  - +
    COSInteger
    +
```
public COSInteger(int val)
```
    +
    Deprecated. use the static get(long) method instead
    +
    constructor.
    +
    Parameters:
    val - The integer value of this object.
    +
  + + + +
  - +
    COSInteger
    +
```
public COSInteger(String val)
+           throws IOException
```
    +
    Deprecated. use the static get(long) method instead
    +
    This will create a new PDF Int object using a string.
    +
    Parameters:
    val - The string value of the integer.
    +
    Throws:
    +
    IOException - If the val is not an integer type.
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    get
    +
```
public static COSInteger get(long val)
```
    +
    Returns a COSInteger instance with the given value.
    +
    Parameters:
    val - integer value
    +
    Returns:
    COSInteger instance
    +
  + + + +
  - +
    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
    +
    +
  + + + +
  - +
    setValue
    +
```
public void setValue(long newValue)
```
    +
    Change the value of this reference.
    +
    Parameters:
    newValue - The new value.
    +
  + + + +
  - +
    floatValue
    +
```
public float floatValue()
```
    +
    polymorphic access to value as float.
    +
    +
    Specified by:
    +
    floatValue in class COSNumber
    +
    Returns:
    The float value of this object.
    +
  + + + +
  - +
    doubleValue
    +
```
public double doubleValue()
```
    +
    polymorphic access to value as float.
    +
    +
    Specified by:
    +
    doubleValue in class COSNumber
    +
    Returns:
    The double 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,
    +
  + + + +
  - +
    accept
    +
```
public Object accept(ICOSVisitor visitor)
+              throws COSVisitorException
```
    +
    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:
    +
    COSVisitorException - 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.
    +
  +
+

Class COSFloat

Field Summary

Fields inherited from class org.apache.pdfbox.cos.COSNumber

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.pdfbox.cos.COSBase

Methods inherited from class java.lang.Object

Constructor Detail

COSFloat

COSFloat

Method Detail

setValue

floatValue

doubleValue

longValue

intValue

equals

hashCode

toString

accept

writePDF

Class COSInteger

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class org.apache.pdfbox.cos.COSBase

Methods inherited from class java.lang.Object

Field Detail

ZERO

ONE

TWO

THREE

Constructor Detail

COSInteger

COSInteger

COSInteger

Method Detail

get

equals

hashCode

toString

setValue

floatValue

doubleValue

intValue

longValue

accept

writePDF