org.apache.pdfbox.pdmodel.common

Class COSDictionaryMap

java.lang.Object

org.apache.pdfbox.pdmodel.common.COSDictionaryMap

All Implemented Interfaces:

java.util.Map

public class COSDictionaryMap
extends java.lang.Object
implements java.util.Map

This is a Map that will automatically sync the contents to a COSDictionary.

Version:

$Revision: 1.10 $

Author:

Ben Litchfield

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
COSDictionaryMap(java.util.Map actualsMap, COSDictionary dicMap) Constructor for this map.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
static COSDictionary	convert(java.util.Map someMap) This will take a map<java.lang.String,org.apache.pdfbox.pdmodel.COSObjectable> and convert it into a COSDictionary<COSName,COSBase>.
static COSDictionaryMap	convertBasicTypesToMap(COSDictionary map) This will take a COS dictionary and convert it into COSDictionaryMap.
java.util.Set	entrySet()
boolean	equals(java.lang.Object o)
java.lang.Object	get(java.lang.Object key)
int	hashCode()
boolean	isEmpty()
java.util.Set	keySet()
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map t)
java.lang.Object	remove(java.lang.Object key)
int	size()
java.lang.String	toString()
java.util.Collection	values()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

COSDictionaryMap

public COSDictionaryMap(java.util.Map actualsMap,
                COSDictionary dicMap)

Constructor for this map.

Parameters:

actualsMap - The map with standard java objects as values.

dicMap - The map with COSBase objects as values.

Method Detail

size

public int size()

Specified by:

size in interface java.util.Map

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map

get

public java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map

put

public java.lang.Object put(java.lang.Object key,
                   java.lang.Object value)

Specified by:

put in interface java.util.Map

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

putAll

public void putAll(java.util.Map t)

Specified by:

putAll in interface java.util.Map

clear

public void clear()

Specified by:

clear in interface java.util.Map

keySet

public java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

values

public java.util.Collection values()

Specified by:

values in interface java.util.Map

entrySet

public java.util.Set entrySet()

Specified by:

entrySet in interface java.util.Map

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Map

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map

Overrides:

hashCode in class java.lang.Object

convert

public static COSDictionary convert(java.util.Map someMap)

This will take a map<java.lang.String,org.apache.pdfbox.pdmodel.COSObjectable> and convert it into a COSDictionary<COSName,COSBase>.

Parameters:

someMap - A map containing COSObjectables

Returns:

A proper COSDictionary

convertBasicTypesToMap

public static COSDictionaryMap convertBasicTypesToMap(COSDictionary map)
                                               throws java.io.IOException

This will take a COS dictionary and convert it into COSDictionaryMap. All cos objects will be converted to their primitive form.

Parameters:

map - The COS mappings.

Returns:

A standard java map.

Throws:

java.io.IOException - If there is an error during the conversion.