Top Description Fields Constructors Methods
org.apache.pdfbox.cos

public final Class COSNull

extends COSBase
Class Inheritance
Imports
java.io.IOException, .OutputStream

This class represents a null PDF object.
Author
Ben Litchfield

Field Summary

Modifier and TypeField and Description
public static final COSNull
NULL

The one null object in the system.

public static final byte[]
NULL_BYTES

The null token.

Constructor Summary

AccessConstructor and Description
private
COSNull()

Constructor.

Method Summary

Modifier and TypeMethod 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 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.COSBase:
getCOSObjectgetKeyisDirectsetDirectsetKey

Field Detail

NULLback to summary
public static final COSNull NULL

The one null object in the system.

NULL_BYTESback to summary
public static final byte[] NULL_BYTES

The null token.

Constructor Detail

COSNullback to summary
private COSNull()

Constructor.

Method Detail

acceptback 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.
toStringback 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
writePDFback 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.