com.itextpdf.kernel.pdf

Class PdfBoolean

java.lang.Object

com.itextpdf.kernel.pdf.PdfObject

com.itextpdf.kernel.pdf.PdfPrimitiveObject

com.itextpdf.kernel.pdf.PdfBoolean

All Implemented Interfaces:

Serializable

public class PdfBoolean
extends PdfPrimitiveObject

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PdfBoolean	FALSE
static PdfBoolean	TRUE

Fields inherited from class com.itextpdf.kernel.pdf.PdfPrimitiveObject

content, directOnly

Fields inherited from class com.itextpdf.kernel.pdf.PdfObject

ARRAY, BOOLEAN, DICTIONARY, FLUSHED, FORBID_RELEASE, FREE, INDIRECT_REFERENCE, indirectReference, LITERAL, MODIFIED, MUST_BE_FLUSHED, MUST_BE_INDIRECT, NAME, NULL, NUMBER, ORIGINAL_OBJECT_STREAM, READ_ONLY, READING, STREAM, STRING, UNENCRYPTED

Constructor Summary

Constructors

Constructor and Description
PdfBoolean(boolean value) Store a boolean value

Method Summary

Modifier and Type	Method and Description
protected void	copyContent(PdfObject from, PdfDocument document) Copies object content from object 'from'.
PdfBoolean	copyTo(PdfDocument document) Copies object to a specified document.
PdfBoolean	copyTo(PdfDocument document, boolean allowDuplicating) Copies object to a specified document.
boolean	equals(Object obj)
protected void	generateContent()
byte	getType() Gets object type.
boolean	getValue()
int	hashCode()
PdfBoolean	makeIndirect(PdfDocument document) Marks object to be saved as indirect.
PdfBoolean	makeIndirect(PdfDocument document, PdfIndirectReference reference) Marks object to be saved as indirect.
protected PdfBoolean	newInstance() Creates new instance of object.
String	toString()
static PdfBoolean	valueOf(boolean value) Gets PdfBoolean existing static class variable equivalent for given boolean value.

Methods inherited from class com.itextpdf.kernel.pdf.PdfPrimitiveObject

compareContent, getInternalContent, hasContent, setIndirectReference

Methods inherited from class com.itextpdf.kernel.pdf.PdfObject

checkState, clearState, clone, flush, flush, getIndirectReference, isArray, isBoolean, isDictionary, isFlushed, isIndirect, isIndirectReference, isLiteral, isModified, isName, isNull, isNumber, isStream, isString, release, setModified, setState

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final PdfBoolean TRUE

FALSE

public static final PdfBoolean FALSE

Constructor Detail

PdfBoolean

public PdfBoolean(boolean value)

Store a boolean value

Parameters:

value - value to store

Method Detail

getValue

public boolean getValue()

getType

public byte getType()

Description copied from class: PdfObject

Gets object type.

Specified by:

getType in class PdfObject

Returns:

object type.

makeIndirect

public PdfBoolean makeIndirect(PdfDocument document)

Marks object to be saved as indirect.

Overrides:

makeIndirect in class PdfObject

Parameters:

document - a document the indirect reference will belong to.

Returns:

object itself.

makeIndirect

public PdfBoolean makeIndirect(PdfDocument document,
                               PdfIndirectReference reference)

Marks object to be saved as indirect.

Overrides:

makeIndirect in class PdfPrimitiveObject

Parameters:

document - a document the indirect reference will belong to.

Returns:

object itself.

copyTo

public PdfBoolean copyTo(PdfDocument document)

Copies object to a specified document. Works only for objects that are read from existing document, otherwise an exception is thrown.

Overrides:

copyTo in class PdfObject

Parameters:

document - document to copy object to.

Returns:

copied object.

copyTo

public PdfBoolean copyTo(PdfDocument document,
                         boolean allowDuplicating)

Copies object to a specified document. Works only for objects that are read from existing document, otherwise an exception is thrown.

Overrides:

copyTo in class PdfObject

Parameters:

document - document to copy object to.

allowDuplicating - indicates if to allow copy objects which already have been copied. If object is associated with any indirect reference and allowDuplicating is false then already existing reference will be returned instead of copying object. If allowDuplicating is true then object will be copied and new indirect reference will be assigned.

Returns:

copied object.

toString

public String toString()

Overrides:

toString in class Object

generateContent

protected void generateContent()

Specified by:

generateContent in class PdfPrimitiveObject

newInstance

protected PdfBoolean newInstance()

Description copied from class: PdfObject

Creates new instance of object.

Specified by:

newInstance in class PdfObject

Returns:

new instance of object.

copyContent

protected void copyContent(PdfObject from,
                           PdfDocument document)

Description copied from class: PdfObject

Copies object content from object 'from'.

Overrides:

copyContent in class PdfPrimitiveObject

Parameters:

from - object to copy content from.

document - document to copy object to.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

valueOf

public static PdfBoolean valueOf(boolean value)

Gets PdfBoolean existing static class variable equivalent for given boolean value. Note, returned object will be direct only, which means it is impossible to make in indirect. If required PdfBoolean has to be indirect, use PdfBoolean(boolean) constructor instead.

Parameters:

value - boolean variable defining value of PdfBoolean to return.

Returns:

existing static PdfBoolean class variable.