com.adobe.internal.pdftoolkit.core.cos

Class CosString

java.lang.Object

com.adobe.internal.pdftoolkit.core.cos.CosObject

com.adobe.internal.pdftoolkit.core.cos.CosScalar

com.adobe.internal.pdftoolkit.core.cos.CosString

public class CosString
extends CosScalar

Represents a COS string as defined in section 3.2.3 of the PDF Reference Manual version 1.4.

Field Summary

Fields inherited from class com.adobe.internal.pdftoolkit.core.cos.CosObject

DIRECT, INDIRECT, t_Array, t_Boolean, t_Dictionary, t_KeyAbsent, t_Name, t_Null, t_Numeric, t_ObjectRef, t_Stream, t_String

Method Summary

Modifier and Type	Method and Description
ASDate	asDate() Returns this string as ASDate if it's in proper date format else throws exception.
String	asString() Returns String value.
byte[]	byteArrayValue() Obtains the string data.
boolean	equals(ASString string)
boolean	equals(byte[] b)
boolean	equals(CosObject value) This method returns true if both CosStrings have same byte array inside.
boolean	equals(CosString string)
boolean	getIsEncrypted() Tells whether this string is already encrypted or not.
boolean	getToEncrypt() Returns true if string is to be encrypted.
int	getType() return the type of this CosObject
Object	getValue()
boolean	getWriteHex() Returns true if this string is written in hex format.
ASHexString	hexStringValue() Returns hex string value if it's type of CosString else throws exception.
boolean	isOddBall() Returns true if this is hex string and ended on odd nibble.
void	setDataInternal(byte[] newData, boolean markDirty) Only for internal engineering use.
void	setIsEncrypted(boolean encrypted) Sets the flag which tells whether this string is already encrypted or not.
void	setToEncrypt(boolean encrypted) Sets true if string is to be encrypted.
void	setWriteHex(boolean b) If true is passed here then this string is written in hex format.
ASString	stringValue() Returns string value if it's type of CosString else throws exception.
String	textValue() Creates an instance of a String object "wrapping" the specified CosString.
String	toString()

Methods inherited from class com.adobe.internal.pdftoolkit.core.cos.CosObject

booleanValue, doubleValue, equals, getDocument, getObjEOF, getObjGen, getObjNum, getObjPos, getObjRevision, getStreamManager, intValue, isCompressed, isDirty, isIndirect, longValue, nameValue, numberValue

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getType

public int getType()

return the type of this CosObject

Specified by:

getType in class CosObject

Returns:

one of the t_Mumble static final int values defined above

byteArrayValue

public byte[] byteArrayValue()
                      throws PDFSecurityException

Obtains the string data. The first time the method is called, the string data is decrypted, if necessary, and the desired portion of the original data buffer is extracted.

Returns:

Byte array containing the string data.

Throws:

PDFSecurityException

stringValue

public ASString stringValue()
                     throws PDFSecurityException

Description copied from class: CosObject

Returns string value if it's type of CosString else throws exception.

Overrides:

stringValue in class CosObject

Throws:

PDFSecurityException

hexStringValue

public ASHexString hexStringValue()
                           throws PDFSecurityException

Description copied from class: CosObject

Returns hex string value if it's type of CosString else throws exception.

Overrides:

hexStringValue in class CosObject

Throws:

PDFSecurityException

asString

public String asString()
                throws PDFSecurityException

Returns String value.

Throws:

PDFSecurityException

getValue

public Object getValue()
                throws PDFSecurityException

Specified by:

getValue in class CosObject

Returns:

Object value of CosObject

Throws:

PDFSecurityException

textValue

public String textValue()
                 throws PDFSecurityException

Creates an instance of a String object "wrapping" the specified CosString. This method is called by the Factory class. A Class implementing the Constructible interface must implement this method.

Overrides:

textValue in class CosObject

Returns:

Newly created String object or null if data is null.

Throws:

PDFSecurityException

RuntimeException, - hard failure, if basic encodings aren't supported This represents a "can't happen" situation

setDataInternal

public void setDataInternal(byte[] newData,
                            boolean markDirty)
                     throws PDFCosParseException,
                            PDFIOException,
                            PDFSecurityException

Only for internal engineering use. This api can change without notice. Hack for DigSig. Overwrite string contents with passed byte array.

Throws:

PDFCosParseException

PDFIOException

PDFSecurityException

toString

public String toString()

Overrides:

toString in class CosObject

asDate

public ASDate asDate()
              throws PDFCosParseException,
                     PDFSecurityException

Returns this string as ASDate if it's in proper date format else throws exception.

Throws:

PDFCosParseException

PDFSecurityException

setWriteHex

public void setWriteHex(boolean b)

If true is passed here then this string is written in hex format.

getWriteHex

public boolean getWriteHex()

Returns true if this string is written in hex format.

isOddBall

public boolean isOddBall()

Returns true if this is hex string and ended on odd nibble.

setToEncrypt

public void setToEncrypt(boolean encrypted)

Sets true if string is to be encrypted.

getToEncrypt

public boolean getToEncrypt()

Returns true if string is to be encrypted.

setIsEncrypted

public void setIsEncrypted(boolean encrypted)

Sets the flag which tells whether this string is already encrypted or not.

getIsEncrypted

public boolean getIsEncrypted()

Tells whether this string is already encrypted or not.

equals

public boolean equals(ASString string)

equals

public boolean equals(CosString string)

equals

public boolean equals(CosObject value)

This method returns true if both CosStrings have same byte array inside. Returns false if passed CosObject is not an instance of CosString or not on same document.

Specified by:

equals in class CosObject

Parameters:

value -

Returns:

boolean

equals

public boolean equals(byte[] b)