Class SectionIDMap
- All Implemented Interfaces:
Serializable,Cloneable,Map
Maps section format IDs to PropertyIDMaps. It is
initialized with two well-known section format IDs: those of the
\005SummaryInformation stream and the
\005DocumentSummaryInformation stream.
If you have a section format ID you can use it as a key to query
this map. If you get a PropertyIDMap returned your section
is well-known and you can query the PropertyIDMap for PID
strings. If you get back null you are on your own.
This Map expects the byte arrays of section format IDs
as keys. A key maps to a PropertyIDMap describing the
property IDs in sections with the specified section format ID.
- Since:
- 2002-02-09
- Version:
- $Id: SectionIDMap.java 489730 2006-12-22 19:18:16Z bayard $
- Author:
- Rainer Klute (klute@rainer-klute.de)
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object, V extends Object> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final byte[][]The DocumentSummaryInformation's first and second sections' format ID.static final byte[]The SummaryInformation's section's format ID.static final StringA property without a known name is described by this string. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionget(byte[] sectionFormatID) Returns thePropertyIDMapfor a given section format ID.Deprecated.static SectionIDMapReturns the singleton instance of the defaultSectionIDMap.static StringgetPIDString(byte[] sectionFormatID, long pid) Returns the property ID string that is associated with a given property ID in a section format ID's namespace.put(byte[] sectionFormatID, PropertyIDMap propertyIDMap) Associates a section format ID with aPropertyIDMap.Deprecated.Useput(byte[], PropertyIDMap)instead!Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, valuesMethods inherited from class java.util.AbstractMap
equals, hashCode, toString
-
Field Details
-
SUMMARY_INFORMATION_ID
public static final byte[] SUMMARY_INFORMATION_IDThe SummaryInformation's section's format ID.
-
DOCUMENT_SUMMARY_INFORMATION_ID
public static final byte[][] DOCUMENT_SUMMARY_INFORMATION_IDThe DocumentSummaryInformation's first and second sections' format ID.
-
UNDEFINED
A property without a known name is described by this string.
- See Also:
-
-
Constructor Details
-
SectionIDMap
public SectionIDMap()
-
-
Method Details
-
getInstance
Returns the singleton instance of the default
SectionIDMap.- Returns:
- The instance value
-
getPIDString
Returns the property ID string that is associated with a given property ID in a section format ID's namespace.
- Parameters:
sectionFormatID- Each section format ID has its own name space of property ID strings and thus must be specified.pid- The property ID- Returns:
- The well-known property ID string associated with the property ID pid in the name space spanned by sectionFormatID . If the pid /sectionFormatID combination is not well-known, the string "[undefined]" is returned.
-
get
Returns the
PropertyIDMapfor a given section format ID.- Parameters:
sectionFormatID- the section format ID- Returns:
- the property ID map
-
get
Deprecated.Useget(byte[])instead!Returns the
PropertyIDMapfor a given section format ID. -
put
Associates a section format ID with a
PropertyIDMap.- Parameters:
sectionFormatID- the section format IDpropertyIDMap- the property ID map- Returns:
- as defined by
Map.put(K, V)
-
put
Deprecated.Useput(byte[], PropertyIDMap)instead!- Specified by:
putin interfaceMap- Overrides:
putin classHashMap- Parameters:
key- This parameter remains undocumented since the method is deprecated.value- This parameter remains undocumented since the method is deprecated.- Returns:
- The return value remains undocumented since the method is deprecated.
- See Also:
-
get(byte[])instead!