com.itextpdf.kernel.pdf

Class PdfString

java.lang.Object

com.itextpdf.kernel.pdf.PdfObject

com.itextpdf.kernel.pdf.PdfPrimitiveObject

com.itextpdf.kernel.pdf.PdfString

All Implemented Interfaces:

Serializable

public class PdfString
extends PdfPrimitiveObject

A PdfString-class is the PDF-equivalent of a JAVA-String-object.

A string is a sequence of characters delimited by parenthesis. If a string is too long to be conveniently placed on a single line, it may be split across multiple lines by using the backslash character (\) at the end of a line to indicate that the string continues on the following line. Within a string, the backslash character is used as an escape to specify unbalanced parenthesis, non-printing ASCII characters, and the backslash character itself. Use of the \ddd escape sequence is the preferred way to represent characters outside the printable ASCII character set.
This object is described in the 'Portable Document Format Reference Manual version 1.7' section 3.2.3 (page 53-56).

PdfObject

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	encoding
protected boolean	hexWriting
protected String	value

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

Modifier	Constructor and Description
	PdfString(byte[] content)
protected	PdfString(byte[] content, boolean hexWriting) Only PdfReader can use this method!
	PdfString(String value)
	PdfString(String value, String encoding)

Method Summary

Modifier and Type	Method and Description
protected void	copyContent(PdfObject from, PdfDocument document) Copies object content from object 'from'.
PdfString	copyTo(PdfDocument document) Copies object to a specified document.
PdfString	copyTo(PdfDocument document, boolean allowDuplicating) Copies object to a specified document.
protected byte[]	decodeContent()
protected PdfString	decrypt(PdfEncryption decrypt) Deprecated. use decodeContent() or getValue() methods, they will decrypt bytes if they are encrypted. Will be removed in iText 7.1
protected byte[]	encodeBytes(byte[] bytes) Escape special symbols or convert to hexadecimal string.
protected boolean	encrypt(PdfEncryption encrypt) Encrypt content of value and set as content.
boolean	equals(Object o)
protected void	generateContent()
protected void	generateValue()
String	getEncoding() Gets the encoding of this string.
byte	getType() Gets object type.
String	getValue()
byte[]	getValueBytes() Gets bytes of String-value considering encoding.
int	hashCode()
boolean	isHexWriting()
PdfString	makeIndirect(PdfDocument document) Marks object to be saved as indirect.
PdfString	makeIndirect(PdfDocument document, PdfIndirectReference reference) Marks object to be saved as indirect.
void	markAsUnencryptedObject() Marks this string object as not encrypted in the encrypted document.
protected PdfString	newInstance() Creates new instance of object.
void	setEncoding(String encoding) Deprecated. Create a new instance with PdfString(String, String) instead.
PdfString	setHexWriting(boolean hexWriting)
String	toString()
String	toUnicodeString() Returns the Unicode String value of this PdfString-object.

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

value

protected String value

encoding

protected String encoding

hexWriting

protected boolean hexWriting

Constructor Detail

PdfString

public PdfString(String value,
                 String encoding)

PdfString

public PdfString(String value)

PdfString

public PdfString(byte[] content)

PdfString

protected PdfString(byte[] content,
                    boolean hexWriting)

Only PdfReader can use this method!

Method Detail

getType

public byte getType()

Description copied from class: PdfObject

Gets object type.

Specified by:

getType in class PdfObject

Returns:

object type.

isHexWriting

public boolean isHexWriting()

setHexWriting

public PdfString setHexWriting(boolean hexWriting)

getValue

public String getValue()

getEncoding

public String getEncoding()

Gets the encoding of this string.

setEncoding

@Deprecated
public void setEncoding(String encoding)

Deprecated. Create a new instance with PdfString(String, String) instead.

Sets the encoding of this string. NOTE. Byte content will be removed.

toUnicodeString

public String toUnicodeString()

Returns the Unicode String value of this PdfString-object.

getValueBytes

public byte[] getValueBytes()

Gets bytes of String-value considering encoding.

Returns:

byte array

makeIndirect

public PdfString 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 PdfString 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 PdfString 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 PdfString 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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

markAsUnencryptedObject

public void markAsUnencryptedObject()

Marks this string object as not encrypted in the encrypted document.

If it's marked so, it will be considered as already in plaintext and decryption will not be performed for it. In order to have effect, this method shall be called before getValue() and getValueBytes() methods.

NOTE: this method is only needed in a very specific cases of encrypted documents. E.g. digital signature dictionary /Contents entry shall not be encrypted. Also this method isn't meaningful in non-encrypted documents.

generateValue

protected void generateValue()

generateContent

protected void generateContent()

Specified by:

generateContent in class PdfPrimitiveObject

decrypt

@Deprecated
protected PdfString decrypt(PdfEncryption decrypt)

Deprecated. use decodeContent() or getValue() methods, they will decrypt bytes if they are encrypted. Will be removed in iText 7.1

Decrypt content of an encrypted PdfString.

encrypt

protected boolean encrypt(PdfEncryption encrypt)

Encrypt content of value and set as content. generateContent() won't be called.

Parameters:

encrypt - @see PdfEncryption

Returns:

true if value was encrypted, otherwise false.

decodeContent

protected byte[] decodeContent()

encodeBytes

protected byte[] encodeBytes(byte[] bytes)

Escape special symbols or convert to hexadecimal string. This method don't change either value or content ot the PdfString.

Parameters:

bytes - byte array to manipulate with.

Returns:

Hexadecimal string or string with escaped symbols in byte array view.

newInstance

protected PdfString 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.