org.apache.pdfbox.cos
Class COSDictionary

java.lang.Object
  extended by org.apache.pdfbox.cos.COSBase
      extended by org.apache.pdfbox.cos.COSDictionary
All Implemented Interfaces:
COSObjectable
Direct Known Subclasses:
COSStream

public class COSDictionary
extends COSBase

This class represents a dictionary where name/value pairs reside.

Version:
$Revision: 1.32 $
Author:
Ben Litchfield

Constructor Summary
COSDictionary()
          Constructor.
COSDictionary(COSDictionary dict)
          Copy Constructor.
 
Method Summary
 Object accept(ICOSVisitor visitor)
          visitor pattern double dispatch method.
 void addAll(COSDictionary dic)
          This will add all of the dictionarys keys/values to this dictionary.
 void clear()
          This will clear all items in the map.
 boolean containsValue(Object value)
           
 Set<Map.Entry<COSName,COSBase>> entrySet()
          Returns the name-value entries in this dictionary.
 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.
 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.
 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.
 Calendar getDate(COSName key, Calendar defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be a date.
 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.
 Calendar getDate(String key, Calendar defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be a date.
 COSBase getDictionaryObject(COSName key)
          This will get an object from this dictionary.
 COSBase getDictionaryObject(String key)
          This will get an object from this dictionary.
 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.
 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.
 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.
 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.
 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.
 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.
 int getEmbeddedInt(String embeddedDictionary, COSName key)
          Get an integer from an embedded dictionary.
 int getEmbeddedInt(String embeddedDictionary, COSName key, int defaultValue)
          Get an integer from an embedded dictionary.
 int getEmbeddedInt(String embeddedDictionary, String key)
          Get an integer from an embedded dictionary.
 int getEmbeddedInt(String embeddedDictionary, String key, int defaultValue)
          Get an integer from an embedded dictionary.
 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.
 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.
 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.
 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.
 float getFloat(COSName key)
          This is a convenience method that will get the dictionary object that is expected to be an float
 float getFloat(COSName key, float defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an float.
 float getFloat(String key)
          This is a convenience method that will get the dictionary object that is expected to be an float
 float getFloat(String key, float defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be a float.
 int getInt(COSName key)
          This is a convenience method that will get the dictionary object that is expected to be an int
 int getInt(COSName key, int defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an integer.
 int getInt(String key)
          This is a convenience method that will get the dictionary object that is expected to be an int
 int getInt(String[] keyList, int defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an integer.
 int getInt(String key, int defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an integer.
 COSBase getItem(COSName key)
          This will do a lookup into the dictionary.
 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.
 long getLong(COSName key)
          This is a convenience method that will get the dictionary object that is expected to be an long
 long getLong(COSName key, long defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an integer.
 long getLong(String key)
          This is a convenience method that will get the dictionary object that is expected to be an long
 long getLong(String[] keyList, long defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an long.
 long getLong(String key, long defaultValue)
          This is a convenience method that will get the dictionary object that is expected to be an integer.
 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.
 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.
 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.
 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.
 COSBase getObjectFromPath(String objPath)
          Nice method, gives you every object you want Arrays works properly too.
 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.
 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.
 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.
 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.
 Collection<COSBase> getValues()
          This will get all of the values for the dictionary.
 List<COSName> keyList()
          Deprecated. Use the entrySet() method instead.
 Set<COSName> keySet()
          Returns the names of the entries in this dictionary.
 void mergeInto(COSDictionary dic)
          This will add all of the dictionarys keys/values to this dictionary, but only if they don't already exist.
 void removeItem(COSName key)
          This will remove an item for the dictionary.
 void setBoolean(COSName key, boolean value)
          This will set an item in the dictionary.
 void setBoolean(String key, boolean value)
          This will set an item in the dictionary.
 void setDate(COSName key, Calendar date)
          Set the date object.
 void setDate(String key, Calendar date)
          Set the value of a date entry in the dictionary.
 void setEmbeddedDate(String embedded, COSName key, Calendar date)
          Set the date object.
 void setEmbeddedDate(String embedded, String key, Calendar date)
          Set the value of a date entry in the dictionary.
 void setEmbeddedInt(String embeddedDictionary, COSName key, int value)
          This is a convenience method that will convert the value to a COSInteger object.
 void setEmbeddedInt(String embeddedDictionary, String key, int value)
          This is a convenience method that will convert the value to a COSInteger object.
 void setEmbeddedString(String embedded, COSName key, String value)
          This is a convenience method that will convert the value to a COSString object.
 void setEmbeddedString(String embedded, String key, String value)
          This is a convenience method that will convert the value to a COSString object.
 void setFloat(COSName key, float value)
          This is a convenience method that will convert the value to a COSFloat object.
 void setFloat(String key, float value)
          This is a convenience method that will convert the value to a COSFloat object.
 void setInt(COSName key, int value)
          This is a convenience method that will convert the value to a COSInteger object.
 void setInt(String key, int value)
          This is a convenience method that will convert the value to a COSInteger object.
 void setItem(COSName key, COSBase value)
          This will set an item in the dictionary.
 void setItem(COSName key, COSObjectable value)
          This will set an item in the dictionary.
 void setItem(String key, COSBase value)
          This will set an item in the dictionary.
 void setItem(String key, COSObjectable value)
          This will set an item in the dictionary.
 void setLong(COSName key, long value)
          This is a convenience method that will convert the value to a COSInteger object.
 void setLong(String key, long value)
          This is a convenience method that will convert the value to a COSInteger object.
 void setName(COSName key, String value)
          This is a convenience method that will convert the value to a COSName object.
 void setName(String key, String value)
          This is a convenience method that will convert the value to a COSName object.
 void setString(COSName key, String value)
          This is a convenience method that will convert the value to a COSString object.
 void setString(String key, String value)
          This is a convenience method that will convert the value to a COSString object.
 int size()
          This will return the number of elements in this dictionary.
 String toString()
          
 
Methods inherited from class org.apache.pdfbox.cos.COSBase
getCOSObject, getFilterManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

COSDictionary

public COSDictionary()
Constructor.


COSDictionary

public COSDictionary(COSDictionary dict)
Copy Constructor. This will make a shallow copy of this dictionary.

Parameters:
dict - The dictionary to copy.
Method Detail

containsValue

public boolean containsValue(Object value)
Parameters:
value - The value to find in the map.
Returns:
true if the map contains this value.
See Also:
Map.containsValue(java.lang.Object)

getKeyForValue

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.
Returns:
The key for the value in the map or null if it does not exist.

size

public int size()
This will return the number of elements in this dictionary.

Returns:
The number of elements in the dictionary.

clear

public void clear()
This will clear all items in the map.


getDictionaryObject

public COSBase getDictionaryObject(String key)
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.
Returns:
The object that matches the key.

getDictionaryObject

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. 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.
secondKey - The second key to try.
Returns:
The object that matches the key.

getDictionaryObject

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. 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.
Returns:
The object that matches the key.

getDictionaryObject

public COSBase getDictionaryObject(COSName key)
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.
Returns:
The object that matches the key.

setItem

public void setItem(COSName key,
                    COSBase value)
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.
value - The value to the dictionary object.

setItem

public void setItem(COSName key,
                    COSObjectable value)
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.
value - The value to the dictionary object.

setItem

public void setItem(String key,
                    COSObjectable value)
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.
value - The value to the dictionary object.

setBoolean

public void setBoolean(String key,
                       boolean value)
This will set an item in the dictionary.

Parameters:
key - The key to the dictionary object.
value - The value to the dictionary object.

setBoolean

public void setBoolean(COSName key,
                       boolean value)
This will set an item in the dictionary.

Parameters:
key - The key to the dictionary object.
value - The value to the dictionary object.

setItem

public void setItem(String key,
                    COSBase value)
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.
value - The value to the dictionary object.

setName

public void setName(String key,
                    String value)
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,
value - The string value for the name.

setName

public void setName(COSName key,
                    String value)
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,
value - The string value for the name.

setDate

public void setDate(String key,
                    Calendar date)
Set the value of a date entry in the dictionary.

Parameters:
key - The key to the date value.
date - The date value.

setDate

public void setDate(COSName key,
                    Calendar date)
Set the date object.

Parameters:
key - The key to the date.
date - The date to set.

setEmbeddedDate

public void setEmbeddedDate(String embedded,
                            String key,
                            Calendar date)
Set the value of a date entry in the dictionary.

Parameters:
embedded - The embedded dictionary.
key - The key to the date value.
date - The date value.

setEmbeddedDate

public void setEmbeddedDate(String embedded,
                            COSName key,
                            Calendar date)
Set the date object.

Parameters:
embedded - The embedded dictionary.
key - The key to the date.
date - The date to set.

setString

public void setString(String key,
                      String value)
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,
value - The string value for the name.

setString

public void setString(COSName key,
                      String value)
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,
value - The string value for the name.

setEmbeddedString

public void setEmbeddedString(String embedded,
                              String key,
                              String value)
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.
key - The key to the object,
value - The string value for the name.

setEmbeddedString

public void setEmbeddedString(String embedded,
                              COSName key,
                              String value)
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.
key - The key to the object,
value - The string value for the name.

setInt

public void setInt(String key,
                   int value)
This is a convenience method that will convert the value to a COSInteger object.

Parameters:
key - The key to the object,
value - The int value for the name.

setInt

public void setInt(COSName key,
                   int value)
This is a convenience method that will convert the value to a COSInteger object.

Parameters:
key - The key to the object,
value - The int value for the name.

setLong

public void setLong(String key,
                    long value)
This is a convenience method that will convert the value to a COSInteger object.

Parameters:
key - The key to the object,
value - The int value for the name.

setLong

public void setLong(COSName key,
                    long value)
This is a convenience method that will convert the value to a COSInteger object.

Parameters:
key - The key to the object,
value - The int value for the name.

setEmbeddedInt

public void setEmbeddedInt(String embeddedDictionary,
                           String key,
                           int value)
This is a convenience method that will convert the value to a COSInteger object.

Parameters:
embeddedDictionary - The embedded dictionary.
key - The key to the object,
value - The int value for the name.

setEmbeddedInt

public void setEmbeddedInt(String embeddedDictionary,
                           COSName key,
                           int value)
This is a convenience method that will convert the value to a COSInteger object.

Parameters:
embeddedDictionary - The embedded dictionary.
key - The key to the object,
value - The int value for the name.

setFloat

public void setFloat(String key,
                     float value)
This is a convenience method that will convert the value to a COSFloat object.

Parameters:
key - The key to the object,
value - The int value for the name.

setFloat

public void setFloat(COSName key,
                     float value)
This is a convenience method that will convert the value to a COSFloat object.

Parameters:
key - The key to the object,
value - The int value for the name.

getNameAsString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
Returns:
The name converted to a string.

getNameAsString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
Returns:
The name converted to a string.

getNameAsString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The name converted to a string.

getNameAsString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The name converted to a string.

getString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
Returns:
The name converted to a string.

getString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
Returns:
The name converted to a string.

getString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The default value to return.
Returns:
The name converted to a string.

getString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The default value to return.
Returns:
The name converted to a string.

getEmbeddedString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
embedded - The embedded dictionary.
key - The key to the item in the dictionary.
Returns:
The name converted to a string.

getEmbeddedString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
embedded - The embedded dictionary.
key - The key to the item in the dictionary.
Returns:
The name converted to a string.

getEmbeddedString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
embedded - The embedded dictionary.
key - The key to the item in the dictionary.
defaultValue - The default value to return.
Returns:
The name converted to a string.

getEmbeddedString

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. Null is returned if the entry does not exist in the dictionary.

Parameters:
embedded - The embedded dictionary.
key - The key to the item in the dictionary.
defaultValue - The default value to return.
Returns:
The name converted to a string.

getDate

public Calendar getDate(String key)
                 throws IOException
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.
Returns:
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
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.
Returns:
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
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.
defaultValue - The default value to return.
Returns:
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
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.
defaultValue - The default value to return.
Returns:
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)
                         throws IOException
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.
key - The key to the item in the dictionary.
Returns:
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
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.
key - The key to the item in the dictionary.
Returns:
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
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.
key - The key to the item in the dictionary.
defaultValue - The default value to return.
Returns:
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
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.
key - The key to the item in the dictionary.
defaultValue - The default value to return.
Returns:
The name converted to a string.
Throws:
IOException - If there is an error converting to a date.

getBoolean

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.
defaultValue - The value returned if the entry is null.
Returns:
The value converted to a boolean.

getBoolean

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.
defaultValue - The value returned if the entry is null.
Returns:
The entry converted to a boolean.

getEmbeddedInt

public int getEmbeddedInt(String embeddedDictionary,
                          String key)
Get an integer from an embedded dictionary. Useful for 1-1 mappings. default:-1

Parameters:
embeddedDictionary - The name of the embedded dictionary.
key - The key in the embedded dictionary.
Returns:
The value of the embedded integer.

getEmbeddedInt

public int getEmbeddedInt(String embeddedDictionary,
                          COSName key)
Get an integer from an embedded dictionary. Useful for 1-1 mappings. default:-1

Parameters:
embeddedDictionary - The name of the embedded dictionary.
key - The key in the embedded dictionary.
Returns:
The value of the embedded integer.

getEmbeddedInt

public int getEmbeddedInt(String embeddedDictionary,
                          String key,
                          int defaultValue)
Get an integer from an embedded dictionary. Useful for 1-1 mappings.

Parameters:
embeddedDictionary - The name of the embedded dictionary.
key - The key in the embedded dictionary.
defaultValue - The value if there is no embedded dictionary or it does not contain the key.
Returns:
The value of the embedded integer.

getEmbeddedInt

public int getEmbeddedInt(String embeddedDictionary,
                          COSName key,
                          int defaultValue)
Get an integer from an embedded dictionary. Useful for 1-1 mappings.

Parameters:
embeddedDictionary - The name of the embedded dictionary.
key - The key in the embedded dictionary.
defaultValue - The value if there is no embedded dictionary or it does not contain the key.
Returns:
The value of the embedded integer.

getInt

public int getInt(String key)
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.
Returns:
The integer value.

getInt

public int getInt(COSName key)
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.
Returns:
The integer value..

getInt

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. If the dictionary value is null then the default Value will be returned.

Parameters:
keyList - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The integer value.

getInt

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. If the dictionary value is null then the default Value will be returned.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The integer value.

getInt

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. If the dictionary value is null then the default Value will be returned.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The integer value.

getLong

public long getLong(String key)
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.
Returns:
The long value.

getLong

public long getLong(COSName key)
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.
Returns:
The long value.

getLong

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. If the dictionary value is null then the default Value will be returned.

Parameters:
keyList - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The long value.

getLong

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. If the dictionary value is null then the default Value will be returned.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The integer value.

getLong

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. If the dictionary value is null then the default Value will be returned.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The integer value.

getFloat

public float getFloat(String key)
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.
Returns:
The float value.

getFloat

public float getFloat(COSName key)
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.
Returns:
The float value.

getFloat

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. If the dictionary value is null then the default Value will be returned.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The float value.

getFloat

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. If the dictionary value is null then the default Value will be returned.

Parameters:
key - The key to the item in the dictionary.
defaultValue - The value to return if the dictionary item is null.
Returns:
The float value.

removeItem

public void removeItem(COSName key)
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.

getItem

public COSBase getItem(COSName key)
This will do a lookup into the dictionary.

Parameters:
key - The key to the object.
Returns:
The item that matches the key.

keyList

public List<COSName> keyList()
Deprecated. Use the entrySet() method instead.

This will get the keys for all objects in the dictionary in the sequence that they were added.

Returns:
a list of the keys in the sequence of insertion

keySet

public Set<COSName> keySet()
Returns the names of the entries in this dictionary. The returned set is in the order the entries were added to the dictionary.

Returns:
names of the entries in this dictionary
Since:
Apache PDFBox 1.1.0

entrySet

public Set<Map.Entry<COSName,COSBase>> entrySet()
Returns the name-value entries in this dictionary. The returned set is in the order the entries were added to the dictionary.

Returns:
name-value entries in this dictionary
Since:
Apache PDFBox 1.1.0

getValues

public Collection<COSBase> getValues()
This will get all of the values for the dictionary.

Returns:
All the values for the dictionary.

accept

public Object accept(ICOSVisitor visitor)
              throws COSVisitorException
visitor pattern double dispatch method.

Specified by:
accept in class COSBase
Parameters:
visitor - The object to notify when visiting this object.
Returns:
The object that the visitor returns.
Throws:
COSVisitorException - If there is an error visiting this object.

addAll

public void addAll(COSDictionary dic)
This will add all of the dictionarys keys/values to this dictionary. Only called when adding keys to a trailer that already exists.

Parameters:
dic - The dic to get the keys from.

mergeInto

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. If a key already exists in this dictionary then nothing is changed.

Parameters:
dic - The dic to get the keys from.

getObjectFromPath

public COSBase getObjectFromPath(String objPath)
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.
Returns:
the object

toString

public String toString()

Overrides:
toString in class Object


Copyright © 2002-2010 The Apache Software Foundation. All Rights Reserved.