org.apache.poi.hsmf.datatypes

Class PropertiesChunk

java.lang.Object

org.apache.poi.hsmf.datatypes.Chunk

org.apache.poi.hsmf.datatypes.PropertiesChunk

Direct Known Subclasses:

MessagePropertiesChunk, StoragePropertiesChunk

public abstract class PropertiesChunk
extends Chunk

A Chunk which holds fixed-length properties, and pointer to the variable length ones (which get their own chunk). There are two kinds of PropertiesChunks, which differ only in their headers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class org.apache.poi.hsmf.datatypes.Chunk

chunkId, DEFAULT_NAME_PREFIX, namePrefix, type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertiesChunk(ChunkGroup parentGroup) Creates a Properties Chunk.

Method Summary

Methods

Modifier and Type	Method and Description
String	getEntryName() Creates a string to use to identify this chunk in the POI file system object.
Map<MAPIProperty,List<PropertyValue>>	getProperties() Returns all the properties in the chunk
PropertyValue	getValue(MAPIProperty property) Returns the (first/only) value for the given property, or null if none exist
List<PropertyValue>	getValues(MAPIProperty property) Returns all values for the given property, of null if none exist
protected void	matchVariableSizedPropertiesToChunks() Called once the parent ChunkGroup has been populated, to match up the Chunks in it with our Variable Sized Properties.
protected void	readProperties(InputStream value)
protected void	writeProperties(OutputStream out)

Methods inherited from class org.apache.poi.hsmf.datatypes.Chunk

getChunkId, getType, readValue, writeValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

PropertiesChunk

protected PropertiesChunk(ChunkGroup parentGroup)

Creates a Properties Chunk.

Method Detail

getEntryName

public String getEntryName()

Description copied from class: Chunk

Creates a string to use to identify this chunk in the POI file system object.

Overrides:

getEntryName in class Chunk

getProperties

public Map<MAPIProperty,List<PropertyValue>> getProperties()

Returns all the properties in the chunk

getValues

public List<PropertyValue> getValues(MAPIProperty property)

Returns all values for the given property, of null if none exist

getValue

public PropertyValue getValue(MAPIProperty property)

Returns the (first/only) value for the given property, or null if none exist

matchVariableSizedPropertiesToChunks

protected void matchVariableSizedPropertiesToChunks()

Called once the parent ChunkGroup has been populated, to match up the Chunks in it with our Variable Sized Properties.

readProperties

protected void readProperties(InputStream value)
                       throws IOException

Throws:

IOException

writeProperties

protected void writeProperties(OutputStream out)
                        throws IOException

Throws:

IOException