org.apache.poi.hsmf.datatypes
Class PropertiesChunk

java.lang.Object
  extended by org.apache.poi.hsmf.datatypes.Chunk
      extended by org.apache.poi.hsmf.datatypes.PropertiesChunk
Direct Known Subclasses:
MessagePropertiesChunk, StoragePropertiesChunk

public abstract class PropertiesChunk
extends Chunk

A Chunk which holds (single) fixed-length properties, and pointer to the variable length ones / multi-valued ones (which get their own chunk).

There are two kinds of PropertiesChunks, which differ only in their headers.


Field Summary
static java.lang.String NAME
           
 
Fields inherited from class org.apache.poi.hsmf.datatypes.Chunk
chunkId, DEFAULT_NAME_PREFIX, namePrefix, type
 
Constructor Summary
protected PropertiesChunk(ChunkGroup parentGroup)
          Creates a Properties Chunk.
 
Method Summary
 java.lang.String getEntryName()
          Creates a string to use to identify this chunk in the POI file system object.
 java.util.Map<MAPIProperty,java.util.List<PropertyValue>> getProperties()
          Returns all the properties in the chunk, along with their values.
 java.util.Map<MAPIProperty,PropertyValue> getRawProperties()
          Returns all the properties in the chunk, without looking up any chunk-based values
 PropertyValue getRawValue(MAPIProperty property)
          Returns the value / pointer to the value chunk of the property, or null if none exists
 java.util.List<PropertyValue> getValues(MAPIProperty property)
          Returns all values for the given property, looking up chunk based ones as required, 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(java.io.InputStream value)
           
protected  void writeProperties(java.io.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 java.lang.String NAME
See Also:
Constant Field Values
Constructor Detail

PropertiesChunk

protected PropertiesChunk(ChunkGroup parentGroup)
Creates a Properties Chunk.

Method Detail

getEntryName

public java.lang.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

getRawProperties

public java.util.Map<MAPIProperty,PropertyValue> getRawProperties()
Returns all the properties in the chunk, without looking up any chunk-based values


getProperties

public java.util.Map<MAPIProperty,java.util.List<PropertyValue>> getProperties()

Returns all the properties in the chunk, along with their values.

Any chunk-based values will be looked up and returned as such


getValues

public java.util.List<PropertyValue> getValues(MAPIProperty property)
Returns all values for the given property, looking up chunk based ones as required, of null if none exist


getRawValue

public PropertyValue getRawValue(MAPIProperty property)
Returns the value / pointer to the value chunk of the property, or null if none exists


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(java.io.InputStream value)
                       throws java.io.IOException
Throws:
java.io.IOException

writeProperties

protected void writeProperties(java.io.OutputStream out)
                        throws java.io.IOException
Throws:
java.io.IOException


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.