Apache PDFBox 3.0.4 · org.apache.pdfbox.cos.COSFloat

Modifier and Type	Field and Description
public static final COSFloat	ONE
private final float	value
private String	valueAsString
public static final COSFloat	ZERO

Access	Constructor and Description
public	COSFloat(float The primitive float object that this object wraps. aFloat) Constructor.
private	COSFloat(float aFloat, String valueString) An internal constructor to avoid formatting for the predefined constants.
public	COSFloat(String The primitive float object that this object wraps. aFloat) Constructor.

Method Summary

Modifier and Type	Method and Description
public void	accept(ICOSVisitor The object to notify when visiting this object. visitor) Implements abstract org.apache.pdfbox.cos.COSBase.accept. Visitor pattern double dispatch method.
private float	Returns: the coerced value coerce(float the value to be checked floatValue) Check and coerce the value field to be between MIN_NORMAL and MAX_VALUE.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public float	Returns: The value of this object. floatValue() Implements abstract org.apache.pdfbox.cos.COSNumber.floatValue. The value of the float object that this one wraps.
private String	Returns: current value as string. formatString() Builds, if needed, and returns the string representation of the current value.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	Returns: The int value of this object, intValue() Implements abstract org.apache.pdfbox.cos.COSNumber.intValue. This will get the integer value of this object.
public long	Returns: The long value of this object, longValue() Implements abstract org.apache.pdfbox.cos.COSNumber.longValue. This will get the long value of this object.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	writePDF(OutputStream The stream to write to. output) This will output this string as a PDF object.

Inherited from org.apache.pdfbox.cos.COSNumber:: get

ONE	back to summary
public static final COSFloat ONE

value	back to summary
private final float value

valueAsString	back to summary
private String valueAsString

ZERO	back to summary
public static final COSFloat ZERO

COSFloat	back to summary
public COSFloat(float aFloat) Constructor. Parameters aFloat:float The primitive float object that this object wraps.

COSFloat	back to summary
private COSFloat(float aFloat, String valueString) An internal constructor to avoid formatting for the predefined constants.

COSFloat	back to summary
public COSFloat(String aFloat) throws IOException Constructor. Parameters aFloat:String The primitive float object that this object wraps. Exceptions IOException: If aFloat is not a float.

Method Detail

accept	back to summary
public void accept(ICOSVisitor visitor) throws IOException Implements abstract org.apache.pdfbox.cos.COSBase.accept. Visitor pattern double dispatch method. Parameters visitor:ICOSVisitor The object to notify when visiting this object. Annotations @Override Exceptions IOException: If an error occurs while visiting this object.

back to summary

public void accept(ICOSVisitor visitor) throws IOException

Implements abstract org.apache.pdfbox.cos.COSBase.accept.

Visitor pattern double dispatch method.

Parameters

visitor:ICOSVisitor: The object to notify when visiting this object.

Annotations

@Override

Exceptions

IOException:: If an error occurs while visiting this object.

coerce	back to summary
private float coerce(float floatValue) Check and coerce the value field to be between MIN_NORMAL and MAX_VALUE. Parameters floatValue:float the value to be checked Returns:float the coerced value

coerce

back to summary

private float coerce(float floatValue)

Check and coerce the value field to be between MIN_NORMAL and MAX_VALUE.

Parameters

floatValue:float: the value to be checked

Returns:float

the coerced value

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

floatValue	back to summary
public float floatValue() Implements abstract org.apache.pdfbox.cos.COSNumber.floatValue. The value of the float object that this one wraps. Returns:float The value of this object. Annotations @Override

floatValue

back to summary

public float floatValue()

Implements abstract org.apache.pdfbox.cos.COSNumber.floatValue.

The value of the float object that this one wraps.

Returns:float

The value of this object.

Annotations

@Override

formatString	back to summary
private String formatString() Builds, if needed, and returns the string representation of the current value. Returns:String current value as string.

formatString

back to summary

private String formatString()

Builds, if needed, and returns the string representation of the current value.

Returns:String: current value as string.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

intValue	back to summary
public int intValue() Implements abstract org.apache.pdfbox.cos.COSNumber.intValue. This will get the integer value of this object. Returns:int The int value of this object, Annotations @Override

intValue

back to summary

public int intValue()

Implements abstract org.apache.pdfbox.cos.COSNumber.intValue.

This will get the integer value of this object.

Returns:int

The int value of this object,

Annotations

@Override

longValue	back to summary
public long longValue() Implements abstract org.apache.pdfbox.cos.COSNumber.longValue. This will get the long value of this object. Returns:long The long value of this object, Annotations @Override

longValue

back to summary

public long longValue()

Implements abstract org.apache.pdfbox.cos.COSNumber.longValue.

This will get the long value of this object.

Returns:long

The long value of this object,

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

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

writePDF

back to summary

public void writePDF(OutputStream output) throws IOException

This will output this string as a PDF object.

Parameters

output:OutputStream: The stream to write to.

Exceptions

IOException:: If there is an error writing to the stream.

public Class COSFloat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail