COSString

Overview

COSString is a class in Aspose.Pdf FOSS for Java. Inherits from: COSBase.

PDF string object (§7.3.4, ISO 32000-1:2008).

Name	Type	Access	Description
`bytes`	`byte[]`	Read	Returns the raw bytes of this string.
`string`	`String`	Read	Decodes the bytes as text: if BOM present, UTF-16BE; otherwise PDFDocEncoding.
`forceHex`	`boolean`	Read	Returns whether this string forces hex serialization.
`asDate`	`LocalDateTime`	Read	Attempts to decode this string as a date value.
`hexString`	`String`	Read	Returns the string in hex representation: <AABBCC…>
Used for binary strings (IDs, encryption keys).
`binary`	`boolean`	Read	Returns true if this string contains non-printable bytes
(likely binary data like file ID or encryption key).
`dirty`	`boolean`	Read	Returns {@code true} if this object was modified since loading.
`indirect`	`boolean`	Read	Returns whether this object is an indirect object (has an object key).
`objectKey`	`COSObjectKey`	Read	Returns the indirect object key, or {@code null} for direct objects.

Signature	Description
`COSString(bytes: byte[])`	Creates a COSString from raw bytes.
`COSString(text: String)`	Creates a COSString from a Java string.
`fromHex(hex: String)` → `COSString`	Creates a COSString from a hex string (without angle brackets).
`getBytes()` → `byte[]`	Returns the raw bytes of this string.
`getString()` → `String`	Decodes the bytes as text: if BOM present, UTF-16BE; otherwise PDFDocEncoding.
`setForceHex(forceHex: boolean)`	Sets whether this string should always be serialized in hex form.
`isForceHex()` → `boolean`	Returns whether this string forces hex serialization.
`getAsDate()` → `LocalDateTime`	Attempts to decode this string as a date value.
`getHexString()` → `String`	Returns the string in hex representation: <AABBCC…>
Used for binary strings (IDs, encryption keys).
`isBinary()` → `boolean`	Returns true if this string contains non-printable bytes
(likely binary data like file ID or encryption key).
`writeTo(os: OutputStream)`
`accept(visitor: ICOSVisitor<T>)` → `T`
`equals(o: Object)` → `boolean`
`hashCode()` → `int`
`toString()` → `String`
`isDirty()` → `boolean`	Returns {@code true} if this object was modified since loading.
`setDirty(dirty: boolean)`	Sets the dirty flag on this object.
`isIndirect()` → `boolean`	Returns whether this object is an indirect object (has an object key).
`getObjectKey()` → `COSObjectKey`	Returns the indirect object key, or {@code null} for direct objects.
`setObjectKey(key: COSObjectKey)`	Sets the indirect object key.