| java.lang.Object org.pdfbox.cos.COSBase org.pdfbox.cos.COSDictionary
All known Subclasses: org.pdfbox.cos.COSStream,
COSDictionary | public class COSDictionary extends COSBase (Code) | | This class represents a dictionary where name/value pairs reside.
author: Ben Litchfield version: $Revision: 1.32 $ |
Method Summary | |
public Object | accept(ICOSVisitor visitor) visitor pattern double dispatch method.
Parameters: visitor - The object to notify when visiting this object. | public void | addAll(COSDictionary dic) This will add all of the dictionarys keys/values to this dictionary. | public void | clear() This will clear all items in the map. | public boolean | containsValue(Object value) See Also: java.util.Map.containsValue(java.lang.Object) Parameters: value - The value to find in the map. | public boolean | getBoolean(String key, boolean defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a cos boolean and convert it to a primitive boolean.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value returned if the entry is null. | public boolean | getBoolean(COSName key, boolean defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a COSBoolean and convert it to a primitive boolean.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value returned if the entry is null. | public Calendar | getDate(String key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public Calendar | getDate(COSName key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public Calendar | getDate(String key, Calendar defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a date. | public Calendar | getDate(COSName key, Calendar defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a date. | public COSBase | getDictionaryObject(String key) This will get an object from this dictionary. | public COSBase | getDictionaryObject(String firstKey, String secondKey) This is a special case of getDictionaryObject that takes multiple keys, it will handle
the situation where multiple keys could get the same value, ie if either CS or ColorSpace
is used to get the colorspace.
This will get an object from this dictionary. | public COSBase | getDictionaryObject(String[] keyList) This is a special case of getDictionaryObject that takes multiple keys, it will handle
the situation where multiple keys could get the same value, ie if either CS or ColorSpace
is used to get the colorspace.
This will get an object from this dictionary. | public COSBase | getDictionaryObject(COSName key) This will get an object from this dictionary. | public Calendar | getEmbeddedDate(String embedded, String key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public Calendar | getEmbeddedDate(String embedded, COSName key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public Calendar | getEmbeddedDate(String embedded, String key, Calendar defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a date. | public Calendar | getEmbeddedDate(String embedded, COSName key, Calendar defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a date. | public int | getEmbeddedInt(String embeddedDictionary, String key) Get an integer from an embedded dictionary. | public int | getEmbeddedInt(String embeddedDictionary, COSName key) Get an integer from an embedded dictionary. | public int | getEmbeddedInt(String embeddedDictionary, String key, int defaultValue) Get an integer from an embedded dictionary. | public int | getEmbeddedInt(String embeddedDictionary, COSName key, int defaultValue) Get an integer from an embedded dictionary. | public String | getEmbeddedString(String embedded, String key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getEmbeddedString(String embedded, COSName key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getEmbeddedString(String embedded, String key, String defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getEmbeddedString(String embedded, COSName key, String defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public float | getFloat(String key) This is a convenience method that will get the dictionary object that
is expected to be an int. | public float | getFloat(COSName key) This is a convenience method that will get the dictionary object that
is expected to be an float. | public float | getFloat(String key, float defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a float. | public float | getFloat(COSName key, float defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an float. | public int | getInt(String key) This is a convenience method that will get the dictionary object that
is expected to be an int. | public int | getInt(COSName key) This is a convenience method that will get the dictionary object that
is expected to be an int. | public int | getInt(String[] keyList, int defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an integer. | public int | getInt(String key, int defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an integer. | public int | getInt(COSName key, int defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an integer. | public COSBase | getItem(COSName key) This will do a lookup into the dictionary.
Parameters: key - The key to the object. | public COSName | getKeyForValue(Object value) Search in the map for the value that matches the parameter
and return the first key that maps to that value.
Parameters: value - The value to search for in the map. | public long | getLong(String key) This is a convenience method that will get the dictionary object that
is expected to be an long. | public long | getLong(COSName key) This is a convenience method that will get the dictionary object that
is expected to be an long. | public long | getLong(String[] keyList, long defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an long. | public long | getLong(String key, long defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an integer. | public long | getLong(COSName key, long defaultValue) This is a convenience method that will get the dictionary object that
is expected to be an integer. | public String | getNameAsString(String key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getNameAsString(COSName key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getNameAsString(String key, String defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getNameAsString(COSName key, String defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public COSBase | getObjectFromPath(String objPath) Nice method, gives you every object you want
Arrays works properly too. | public String | getString(String key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getString(COSName key) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getString(String key, String defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public String | getString(COSName key, String defaultValue) This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. | public Collection | getValues() This will get all of the values for the dictionary. | public List | keyList() This will get the keys for all objects in the dictionary in the sequence that
they were added. | public void | mergeInto(COSDictionary dic) This will add all of the dictionarys keys/values to this dictionary, but only
if they don't already exist. | public void | removeItem(COSName key) This will remove an item for the dictionary. | public void | setBoolean(String key, boolean value) This will set an item in the dictionary. | public void | setBoolean(COSName key, boolean value) This will set an item in the dictionary. | public void | setDate(String key, Calendar date) Set the value of a date entry in the dictionary. | public void | setDate(COSName key, Calendar date) Set the date object. | public void | setEmbeddedDate(String embedded, String key, Calendar date) Set the value of a date entry in the dictionary. | public void | setEmbeddedDate(String embedded, COSName key, Calendar date) Set the date object. | public void | setEmbeddedInt(String embeddedDictionary, String key, int value) This is a convenience method that will convert the value to a COSInteger
object. | public void | setEmbeddedInt(String embeddedDictionary, COSName key, int value) This is a convenience method that will convert the value to a COSInteger
object. | public void | setEmbeddedString(String embedded, String key, String value) This is a convenience method that will convert the value to a COSString
object. | public void | setEmbeddedString(String embedded, COSName key, String value) This is a convenience method that will convert the value to a COSString
object. | public void | setFloat(String key, float value) This is a convenience method that will convert the value to a COSFloat
object. | public void | setFloat(COSName key, float value) This is a convenience method that will convert the value to a COSFloat
object. | public void | setInt(String key, int value) This is a convenience method that will convert the value to a COSInteger
object. | public void | setInt(COSName key, int value) This is a convenience method that will convert the value to a COSInteger
object. | public void | setItem(COSName key, COSBase value) This will set an item in the dictionary. | public void | setItem(COSName key, COSObjectable value) This will set an item in the dictionary. | public void | setItem(String key, COSObjectable value) This will set an item in the dictionary. | public void | setItem(String key, COSBase value) This will set an item in the dictionary. | public void | setLong(String key, long value) This is a convenience method that will convert the value to a COSInteger
object. | public void | setLong(COSName key, long value) This is a convenience method that will convert the value to a COSInteger
object. | public void | setName(String key, String value) This is a convenience method that will convert the value to a COSName
object. | public void | setName(COSName key, String value) This is a convenience method that will convert the value to a COSName
object. | public void | setString(String key, String value) This is a convenience method that will convert the value to a COSString
object. | public void | setString(COSName key, String value) This is a convenience method that will convert the value to a COSString
object. | public int | size() This will return the number of elements in this dictionary. |
COSDictionary | public COSDictionary()(Code) | | Constructor.
|
COSDictionary | public COSDictionary(COSDictionary dict)(Code) | | Copy Constructor. This will make a shallow copy of this dictionary.
Parameters: dict - The dictionary to copy. |
addAll | public void addAll(COSDictionary dic)(Code) | | This will add all of the dictionarys keys/values to this dictionary.
Parameters: dic - The dic to get the keys from. |
clear | public void clear()(Code) | | This will clear all items in the map.
|
getBoolean | public boolean getBoolean(String key, boolean defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a cos boolean and convert it to a primitive boolean.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value returned if the entry is null. The value converted to a boolean. |
getBoolean | public boolean getBoolean(COSName key, boolean defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a COSBoolean and convert it to a primitive boolean.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value returned if the entry is null. The entry converted to a boolean. |
getDate | public Calendar getDate(String key) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getDate | public Calendar getDate(COSName key) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getDate | public Calendar getDate(String key, Calendar defaultValue) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a date. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getDate | public Calendar getDate(COSName key, Calendar defaultValue) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a date. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getDictionaryObject | public COSBase getDictionaryObject(String key)(Code) | | This will get an object from this dictionary. If the object is a reference then it will
dereference it and get it from the document. If the object is COSNull then
null will be returned.
Parameters: key - The key to the object that we are getting. The object that matches the key. |
getDictionaryObject | public COSBase getDictionaryObject(String firstKey, String secondKey)(Code) | | This is a special case of getDictionaryObject that takes multiple keys, it will handle
the situation where multiple keys could get the same value, ie if either CS or ColorSpace
is used to get the colorspace.
This will get an object from this dictionary. If the object is a reference then it will
dereference it and get it from the document. If the object is COSNull then
null will be returned.
Parameters: firstKey - The first key to try. Parameters: secondKey - The second key to try. The object that matches the key. |
getDictionaryObject | public COSBase getDictionaryObject(String[] keyList)(Code) | | This is a special case of getDictionaryObject that takes multiple keys, it will handle
the situation where multiple keys could get the same value, ie if either CS or ColorSpace
is used to get the colorspace.
This will get an object from this dictionary. If the object is a reference then it will
dereference it and get it from the document. If the object is COSNull then
null will be returned.
Parameters: keyList - The list of keys to find a value. The object that matches the key. |
getDictionaryObject | public COSBase getDictionaryObject(COSName key)(Code) | | This will get an object from this dictionary. If the object is a reference then it will
dereference it and get it from the document. If the object is COSNull then
null will be returned.
Parameters: key - The key to the object that we are getting. The object that matches the key. |
getEmbeddedDate | public Calendar getEmbeddedDate(String embedded, String key) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary to get. Parameters: key - The key to the item in the dictionary. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getEmbeddedDate | public Calendar getEmbeddedDate(String embedded, COSName key) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary to get. Parameters: key - The key to the item in the dictionary. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getEmbeddedDate | public Calendar getEmbeddedDate(String embedded, String key, Calendar defaultValue) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a date. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary to get. Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getEmbeddedDate | public Calendar getEmbeddedDate(String embedded, COSName key, Calendar defaultValue) throws IOException(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a date. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary to get. Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. throws: IOException - If there is an error converting to a date. |
getEmbeddedInt | public int getEmbeddedInt(String embeddedDictionary, String key)(Code) | | Get an integer from an embedded dictionary. Useful for 1-1 mappings. default:-1
Parameters: embeddedDictionary - The name of the embedded dictionary. Parameters: key - The key in the embedded dictionary. The value of the embedded integer. |
getEmbeddedInt | public int getEmbeddedInt(String embeddedDictionary, COSName key)(Code) | | Get an integer from an embedded dictionary. Useful for 1-1 mappings. default:-1
Parameters: embeddedDictionary - The name of the embedded dictionary. Parameters: key - The key in the embedded dictionary. The value of the embedded integer. |
getEmbeddedInt | public int getEmbeddedInt(String embeddedDictionary, String key, int defaultValue)(Code) | | Get an integer from an embedded dictionary. Useful for 1-1 mappings.
Parameters: embeddedDictionary - The name of the embedded dictionary. Parameters: key - The key in the embedded dictionary. Parameters: defaultValue - The value if there is no embedded dictionary or it does not contain the key. The value of the embedded integer. |
getEmbeddedInt | public int getEmbeddedInt(String embeddedDictionary, COSName key, int defaultValue)(Code) | | Get an integer from an embedded dictionary. Useful for 1-1 mappings.
Parameters: embeddedDictionary - The name of the embedded dictionary. Parameters: key - The key in the embedded dictionary. Parameters: defaultValue - The value if there is no embedded dictionary or it does not contain the key. The value of the embedded integer. |
getEmbeddedString | public String getEmbeddedString(String embedded, String key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary. Parameters: key - The key to the item in the dictionary. The name converted to a string. |
getEmbeddedString | public String getEmbeddedString(String embedded, COSName key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary. Parameters: key - The key to the item in the dictionary. The name converted to a string. |
getEmbeddedString | public String getEmbeddedString(String embedded, String key, String defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary. Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. |
getEmbeddedString | public String getEmbeddedString(String embedded, COSName key, String defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: embedded - The embedded dictionary. Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. |
getFloat | public float getFloat(String key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an int. -1 is returned if there is no value.
Parameters: key - The key to the item in the dictionary. The float value. |
getFloat | public float getFloat(COSName key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an float. -1 is returned if there is no value.
Parameters: key - The key to the item in the dictionary. The float value. |
getFloat | public float getFloat(String key, float defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a float. If the dictionary value is null then the
default Value will be returned.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The float value. |
getFloat | public float getFloat(COSName key, float defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an float. If the dictionary value is null then the
default Value will be returned.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The float value. |
getInt | public int getInt(String key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an int. -1 is returned if there is no value.
Parameters: key - The key to the item in the dictionary. The integer value. |
getInt | public int getInt(COSName key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an int. -1 is returned if there is no value.
Parameters: key - The key to the item in the dictionary. The integer value.. |
getInt | public int getInt(String[] keyList, int defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an integer. If the dictionary value is null then the
default Value will be returned.
Parameters: keyList - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The integer value. |
getInt | public int getInt(String key, int defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an integer. If the dictionary value is null then the
default Value will be returned.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The integer value. |
getInt | public int getInt(COSName key, int defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an integer. If the dictionary value is null then the
default Value will be returned.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The integer value. |
getItem | public COSBase getItem(COSName key)(Code) | | This will do a lookup into the dictionary.
Parameters: key - The key to the object. The item that matches the key. |
getKeyForValue | public COSName getKeyForValue(Object value)(Code) | | Search in the map for the value that matches the parameter
and return the first key that maps to that value.
Parameters: value - The value to search for in the map. The key for the value in the map or null if it does not exist. |
getLong | public long getLong(String key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an long. -1 is returned if there is no value.
Parameters: key - The key to the item in the dictionary. The long value. |
getLong | public long getLong(COSName key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an long. -1 is returned if there is no value.
Parameters: key - The key to the item in the dictionary. The long value. |
getLong | public long getLong(String[] keyList, long defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an long. If the dictionary value is null then the
default Value will be returned.
Parameters: keyList - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The long value. |
getLong | public long getLong(String key, long defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an integer. If the dictionary value is null then the
default Value will be returned.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The integer value. |
getLong | public long getLong(COSName key, long defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be an integer. If the dictionary value is null then the
default Value will be returned.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The integer value. |
getNameAsString | public String getNameAsString(String key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. The name converted to a string. |
getNameAsString | public String getNameAsString(COSName key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. The name converted to a string. |
getNameAsString | public String getNameAsString(String key, String defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The name converted to a string. |
getNameAsString | public String getNameAsString(COSName key, String defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The value to return if the dictionary item is null. The name converted to a string. |
getObjectFromPath | public COSBase getObjectFromPath(String objPath)(Code) | | Nice method, gives you every object you want
Arrays works properly too. Try "P/Annots/[k]/Rect"
where k means the index of the Annotsarray.
Parameters: objPath - the relative path to the object. the object |
getString | public String getString(String key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. The name converted to a string. |
getString | public String getString(COSName key)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. The name converted to a string. |
getString | public String getString(String key, String defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. |
getString | public String getString(COSName key, String defaultValue)(Code) | | This is a convenience method that will get the dictionary object that
is expected to be a name and convert it to a string. Null is returned
if the entry does not exist in the dictionary.
Parameters: key - The key to the item in the dictionary. Parameters: defaultValue - The default value to return. The name converted to a string. |
getValues | public Collection getValues()(Code) | | This will get all of the values for the dictionary.
All the values for the dictionary. |
keyList | public List keyList()(Code) | | This will get the keys for all objects in the dictionary in the sequence that
they were added.
a list of the keys in the sequence of insertion |
mergeInto | public void mergeInto(COSDictionary dic)(Code) | | This will add all of the dictionarys keys/values to this dictionary, but only
if they don't already exist. If a key already exists in this dictionary then
nothing is changed.
Parameters: dic - The dic to get the keys from. |
removeItem | public void removeItem(COSName key)(Code) | | This will remove an item for the dictionary. This
will do nothing of the object does not exist.
Parameters: key - The key to the item to remove from the dictionary. |
setBoolean | public void setBoolean(String key, boolean value)(Code) | | This will set an item in the dictionary.
Parameters: key - The key to the dictionary object. Parameters: value - The value to the dictionary object. |
setBoolean | public void setBoolean(COSName key, boolean value)(Code) | | This will set an item in the dictionary.
Parameters: key - The key to the dictionary object. Parameters: value - The value to the dictionary object. |
setDate | public void setDate(String key, Calendar date)(Code) | | Set the value of a date entry in the dictionary.
Parameters: key - The key to the date value. Parameters: date - The date value. |
setDate | public void setDate(COSName key, Calendar date)(Code) | | Set the date object.
Parameters: key - The key to the date. Parameters: date - The date to set. |
setEmbeddedDate | public void setEmbeddedDate(String embedded, String key, Calendar date)(Code) | | Set the value of a date entry in the dictionary.
Parameters: embedded - The embedded dictionary. Parameters: key - The key to the date value. Parameters: date - The date value. |
setEmbeddedDate | public void setEmbeddedDate(String embedded, COSName key, Calendar date)(Code) | | Set the date object.
Parameters: embedded - The embedded dictionary. Parameters: key - The key to the date. Parameters: date - The date to set. |
setEmbeddedInt | public void setEmbeddedInt(String embeddedDictionary, String key, int value)(Code) | | This is a convenience method that will convert the value to a COSInteger
object.
Parameters: embeddedDictionary - The embedded dictionary. Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setEmbeddedInt | public void setEmbeddedInt(String embeddedDictionary, COSName key, int value)(Code) | | This is a convenience method that will convert the value to a COSInteger
object.
Parameters: embeddedDictionary - The embedded dictionary. Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setEmbeddedString | public void setEmbeddedString(String embedded, String key, String value)(Code) | | This is a convenience method that will convert the value to a COSString
object. If it is null then the object will be removed.
Parameters: embedded - The embedded dictionary to set the item in. Parameters: key - The key to the object, Parameters: value - The string value for the name. |
setEmbeddedString | public void setEmbeddedString(String embedded, COSName key, String value)(Code) | | This is a convenience method that will convert the value to a COSString
object. If it is null then the object will be removed.
Parameters: embedded - The embedded dictionary to set the item in. Parameters: key - The key to the object, Parameters: value - The string value for the name. |
setFloat | public void setFloat(String key, float value)(Code) | | This is a convenience method that will convert the value to a COSFloat
object.
Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setFloat | public void setFloat(COSName key, float value)(Code) | | This is a convenience method that will convert the value to a COSFloat
object.
Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setInt | public void setInt(String key, int value)(Code) | | This is a convenience method that will convert the value to a COSInteger
object.
Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setInt | public void setInt(COSName key, int value)(Code) | | This is a convenience method that will convert the value to a COSInteger
object.
Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setItem | public void setItem(COSName key, COSBase value)(Code) | | This will set an item in the dictionary. If value is null then the result
will be the same as removeItem( key ).
Parameters: key - The key to the dictionary object. Parameters: value - The value to the dictionary object. |
setItem | public void setItem(COSName key, COSObjectable value)(Code) | | This will set an item in the dictionary. If value is null then the result
will be the same as removeItem( key ).
Parameters: key - The key to the dictionary object. Parameters: value - The value to the dictionary object. |
setItem | public void setItem(String key, COSObjectable value)(Code) | | This will set an item in the dictionary. If value is null then the result
will be the same as removeItem( key ).
Parameters: key - The key to the dictionary object. Parameters: value - The value to the dictionary object. |
setItem | public void setItem(String key, COSBase value)(Code) | | This will set an item in the dictionary. If value is null then the result
will be the same as removeItem( key ).
Parameters: key - The key to the dictionary object. Parameters: value - The value to the dictionary object. |
setLong | public void setLong(String key, long value)(Code) | | This is a convenience method that will convert the value to a COSInteger
object.
Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setLong | public void setLong(COSName key, long value)(Code) | | This is a convenience method that will convert the value to a COSInteger
object.
Parameters: key - The key to the object, Parameters: value - The int value for the name. |
setName | public void setName(String key, String value)(Code) | | This is a convenience method that will convert the value to a COSName
object. If it is null then the object will be removed.
Parameters: key - The key to the object, Parameters: value - The string value for the name. |
setName | public void setName(COSName key, String value)(Code) | | This is a convenience method that will convert the value to a COSName
object. If it is null then the object will be removed.
Parameters: key - The key to the object, Parameters: value - The string value for the name. |
setString | public void setString(String key, String value)(Code) | | This is a convenience method that will convert the value to a COSString
object. If it is null then the object will be removed.
Parameters: key - The key to the object, Parameters: value - The string value for the name. |
setString | public void setString(COSName key, String value)(Code) | | This is a convenience method that will convert the value to a COSString
object. If it is null then the object will be removed.
Parameters: key - The key to the object, Parameters: value - The string value for the name. |
size | public int size()(Code) | | This will return the number of elements in this dictionary.
The number of elements in the dictionary. |
|
|