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

Modifier and Type	Field and Description
public static final COSBoolean	FALSE The PDF false value.
private static final byte[]	FALSE_BYTES The false boolean token.
public static final COSBoolean	TRUE The PDF true value.
private static final byte[]	TRUE_BYTES The true boolean token.
private final boolean	value

Access	Constructor and Description
private	COSBoolean(boolean The boolean value. aValue) 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.
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static COSBoolean	Returns: The single boolean instance that matches the parameter. getBoolean(boolean Parameter telling which boolean value to get. value) This will get the boolean value.
public static COSBoolean	Returns: The single boolean instance that matches the parameter. getBoolean(Boolean Parameter telling which boolean value to get. value) This will get the boolean value.
public boolean	Returns: The boolean value of this object. getValue() This will get the value that this object wraps.
public Boolean	Returns: The boolean value of this object. getValueAsObject() This will get the value that this object wraps.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	Returns: The string value of this object. toString() Overrides java.lang.Object.toString. Return a string representation of this object.
public void	writePDF(OutputStream The stream to write this object out to. output) This will write this object out to a PDF stream.

Inherited from org.apache.pdfbox.cos.COSBase:: getCOSObject getKey isDirect setDirect setKey

FALSE	back to summary
public static final COSBoolean FALSE The PDF false value.

FALSE_BYTES	back to summary
private static final byte[] FALSE_BYTES The false boolean token.

TRUE	back to summary
public static final COSBoolean TRUE The PDF true value.

TRUE_BYTES	back to summary
private static final byte[] TRUE_BYTES The true boolean token.

value	back to summary
private final boolean value

COSBoolean	back to summary
private COSBoolean(boolean aValue) Constructor. Parameters aValue:boolean The boolean value.

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.

equals back to summary

equals	back to summary
public boolean equals(Object obj) 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 obj:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object obj)

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

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

Returns:boolean

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

getBoolean	back to summary
public static COSBoolean getBoolean(boolean value) This will get the boolean value. Parameters value:boolean Parameter telling which boolean value to get. Returns:COSBoolean The single boolean instance that matches the parameter.

getBoolean

back to summary

public static COSBoolean getBoolean(boolean value)

This will get the boolean value.

Parameters

value:boolean: Parameter telling which boolean value to get.

Returns:COSBoolean

The single boolean instance that matches the parameter.

getBoolean	back to summary
public static COSBoolean getBoolean(Boolean value) This will get the boolean value. Parameters value:Boolean Parameter telling which boolean value to get. Returns:COSBoolean The single boolean instance that matches the parameter.

getBoolean

back to summary

public static COSBoolean getBoolean(Boolean value)

This will get the boolean value.

Parameters

value:Boolean: Parameter telling which boolean value to get.

Returns:COSBoolean

The single boolean instance that matches the parameter.

getValue	back to summary
public boolean getValue() This will get the value that this object wraps. Returns:boolean The boolean value of this object.

getValue

back to summary

public boolean getValue()

This will get the value that this object wraps.

Returns:boolean: The boolean value of this object.

getValueAsObject	back to summary
public Boolean getValueAsObject() This will get the value that this object wraps. Returns:Boolean The boolean value of this object.

getValueAsObject

back to summary

public Boolean getValueAsObject()

This will get the value that this object wraps.

Returns:Boolean: The boolean value of this object.

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

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Return a string representation of this object. Returns:String The string value of this object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Return a string representation of this object.

Returns:String

The string value of this object.

Annotations

@Override

writePDF	back to summary
public void writePDF(OutputStream output) throws IOException This will write this object out to a PDF stream. Parameters output:OutputStream The stream to write this object out to. Exceptions IOException: If an error occurs while writing out this object.

writePDF

back to summary

public void writePDF(OutputStream output) throws IOException

This will write this object out to a PDF stream.

Parameters

output:OutputStream: The stream to write this object out to.

Exceptions

IOException:: If an error occurs while writing out this object.

public final Class COSBoolean

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail