Class PDFName

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFName

All Implemented Interfaces:

Serializable, CompressedObject, PDFWritable

public class PDFName
extends PDFObject
implements Serializable

Class representing a PDF name object.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final char[]	DIGITS
private static final String	ESCAPED_NAME_CHARS
private String	name
private static final long	serialVersionUID

Fields inherited from class PDFObject

log

Constructor Summary

Constructors

Constructor	Description
PDFName(String name)	Creates a new PDF name object.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
(package private) static String	escapeName(String name)	Escapes a PDF name.
String	getName()	Returns the name without the leading slash.
int	hashCode()
int	output(OutputStream stream)	Write the PDF represention of this object
void	outputInline(OutputStream out, StringBuilder textBuffer)	Writes a "direct object" (inline object) representation to the stream.
private static void	toHex(char ch, StringBuilder sb)
String	toString()

Methods inherited from class PDFObject

contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getChildren, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, supportsObjectStream, toPDF, toPDFString

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

name

private String name

ESCAPED_NAME_CHARS

private static final String ESCAPED_NAME_CHARS

See Also:

• Constant Field Values

DIGITS

private static final char[] DIGITS

Constructor Details

PDFName

public PDFName(String name)

Creates a new PDF name object.

Parameters:

name - the name value

Method Details

escapeName

static String escapeName(String name)

Escapes a PDF name. It adds the leading slash and escapes characters as necessary.

Parameters:

name - the name

Returns:

the escaped name

toHex

private static void toHex(char ch,
 StringBuilder sb)

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Returns the name without the leading slash.

Returns:

the name without the leading slash

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

output

public int output(OutputStream stream)
           throws IOException

Description copied from class: PDFObject

Write the PDF represention of this object

Specified by:

output in interface CompressedObject

Overrides:

output in class PDFObject

Parameters:

stream - the stream to write the PDF to

Returns:

the number of bytes written

Throws:

IOException - if there is an error writing to the stream

outputInline

public void outputInline(OutputStream out,
 StringBuilder textBuffer)
                  throws IOException

Description copied from class: PDFObject

Writes a "direct object" (inline object) representation to the stream. A text buffer is given for optimized encoding of text content.

IMPORTANT: If you need to write out binary output, call PDFDocument.flushTextBuffer(StringBuilder, OutputStream) before writing any content to the OutputStream!

Specified by:

outputInline in interface PDFWritable

Overrides:

outputInline in class PDFObject

Parameters:

out - the OutputStream (for binary content)

textBuffer - the text buffer for text content

Throws:

IOException - if an I/O error occurs