COSDictionary

Overview

COSDictionary is a class in Aspose.Pdf FOSS for Java. Inherits from: COSBase, Iterable<Map.Entry<COSName, COSBase>>.

PDF dictionary object (§7.3.7, ISO 32000-1:2008).

Properties

Name	Type	Access	Description
`empty`	`boolean`	Read	Returns whether the dictionary is empty.
`type`	`String`	Read	Returns the /Type value as a string (e.g.
`subtype`	`String`	Read	Returns the /Subtype (or /S) value as a string, or null.
`path`	`COSBase`	Read	Traverses nested dictionaries by key path.
`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.

Methods

Signature	Description
`COSDictionary()`	Creates an empty dictionary.
`COSDictionary(other: COSDictionary)`	Creates a dictionary as a shallow copy of another dictionary.
`size()` → `int`	Returns the number of entries.
`isEmpty()` → `boolean`	Returns whether the dictionary is empty.
`containsKey(key: COSName)` → `boolean`	Returns whether the dictionary contains the given key.
`containsKey(key: String)` → `boolean`	Returns whether the dictionary contains the given key (convenience method).
`get(key: COSName)` → `COSBase`	Returns the value for the given key, or null.
`get(key: String)` → `COSBase`	Returns the value for the given key (convenience method), or null.
`set(key: COSName, value: COSBase)`	Sets a key-value pair.
`set(key: String, value: COSBase)`	Sets a key-value pair (convenience method).
`remove(key: COSName)` → `COSBase`	Removes a key.
`keySet()` → `Set<COSName>`	Returns the set of keys.
`values()` → `Collection<COSBase>`	Returns the collection of values.
`getInt(key: String, defaultValue: int)` → `int`	Returns the value as an int, or the default.
`getInt(key: COSName, defaultValue: int)` → `int`	Returns the value as an int, or the default (COSName key variant).
`getLong(key: String, defaultValue: long)` → `long`	Returns the value as a long, or the default.
`getFloat(key: String, defaultValue: float)` → `float`	Returns the value as a float, or the default.
`getBoolean(key: String, defaultValue: boolean)` → `boolean`	Returns the value as a boolean, or the default.
`getNameAsString(key: String)` → `String`	Returns the value as a name string, or null.
`getString(key: String)` → `String`	Returns the value as a decoded string, or null.
`getDictionary(key: String)` → `COSDictionary`	Returns the value as a COSDictionary, or null.
`getArray(key: String)` → `COSArray`	Returns the value as a COSArray, or null.
`setInt(key: String, value: int)`	Sets an integer value.
`setFloat(key: String, value: float)`	Sets a float value.
`setBoolean(key: String, value: boolean)`	Sets a boolean value.
`setName(key: String, nameValue: String)`	Sets a name value.
`setString(key: String, stringValue: String)`	Sets a string value.
`getType()` → `String`	Returns the /Type value as a string (e.g.
`getSubtype()` → `String`	Returns the /Subtype (or /S) value as a string, or null.
`getPath()` → `COSBase`	Traverses nested dictionaries by key path.
`writeTo(os: OutputStream)`
`iterator()` → `Iterator<Map.Entry<COSName, COSBase>>`
`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.

COSDictionary

Overview

Properties

Methods

See Also