public class CustomProperties extends Object implements Map<String,Object>
CustomProperty
that belong to a
DocumentSummaryInformation
. The class maintains the names of the
custom properties in a dictionary. It implements the Map
interface
and by this provides a simplified view on custom properties: A property's
name is the key that maps to a typed value. This implementation hides
property IDs from the developer and regards the property names as keys to
typed values.While this class provides a simple API to custom properties, it ignores the fact that not names, but IDs are the real keys to properties. Under the hood this class maintains a 1:1 relationship between IDs and names. Therefore you should not use this class to process property sets with several IDs mapping to the same name or with properties without a name: the result will contain only a subset of the original properties. If you really need to deal such property sets, use HPSF's low-level access methods.
An application can call the isPure
method to check whether a
property set parsed by CustomProperties
is still pure (i.e.
unmodified) or whether one or more properties have been dropped.
This class is not thread-safe; concurrent access to instances of this class must be synchronized.
While this class is roughly HashMap<Long,CustomProperty>, that's the internal representation. To external calls, it should appear as HashMap<String,Object> mapping between Names and Custom Property Values.
Constructor and Description |
---|
CustomProperties() |
Modifier and Type | Method and Description |
---|---|
void |
clear() |
boolean |
containsKey(Object key)
Checks against both String Name and Long ID
|
boolean |
containsValue(Object value)
Checks against both the property, and its values.
|
Set<Map.Entry<String,Object>> |
entrySet() |
boolean |
equals(Object obj) |
Object |
get(Object key)
Gets a named value from the custom properties - only works for keys of type String
|
int |
getCodepage()
Gets the codepage.
|
int |
hashCode() |
Set<Long> |
idSet()
Returns a set of all the IDs of our custom properties
|
boolean |
isEmpty() |
boolean |
isPure()
Tells whether this
CustomProperties instance is pure or one or
more properties of the underlying low-level property set has been
dropped. |
Set |
keySet()
Returns a set of all the names of our custom properties.
|
Set<String> |
nameSet()
Returns a set of all the names of our custom properties
|
List<CustomProperty> |
properties() |
CustomProperty |
put(String name,
CustomProperty cp)
Puts a
CustomProperty into this map. |
Object |
put(String key,
Object value)
Adds a named property.
|
void |
putAll(Map<? extends String,?> m) |
CustomProperty |
remove(Object key)
Removes a custom property - only works for keys of type String
|
void |
setCodepage(int codepage)
Sets the codepage.
|
void |
setPure(boolean isPure)
Sets the purity of the custom property set.
|
int |
size() |
Collection<Object> |
values() |
getClass, notify, notifyAll, toString, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public CustomProperty put(String name, CustomProperty cp)
CustomProperty
into this map. It is assumed that the
CustomProperty
already has a valid ID. Otherwise use
put(CustomProperty)
.name
- the property namecp
- the propertypublic Object get(Object key)
public CustomProperty remove(Object key)
public int hashCode()
public boolean equals(Object obj)
public List<CustomProperty> properties()
public Collection<Object> values()
values
in interface Map<String,Object>
properties()
for the wrapped valuespublic Set keySet()
nameSet()
public Set<String> nameSet()
public Set<Long> idSet()
public void setCodepage(int codepage)
codepage
- the codepagepublic int getCodepage()
public boolean containsKey(Object key)
containsKey
in interface Map<String,Object>
public boolean containsValue(Object value)
containsValue
in interface Map<String,Object>
public boolean isPure()
CustomProperties
instance is pure or one or
more properties of the underlying low-level property set has been
dropped.true
if the CustomProperties
is pure, else
false
.public void setPure(boolean isPure)
isPure
- the purityCopyright © 2010 - 2020 Adobe. All Rights Reserved