org.apache.poi.hsmf.datatypes

Class NameIdChunks

java.lang.Object

org.apache.poi.hsmf.datatypes.NameIdChunks

All Implemented Interfaces:

ChunkGroup

public final class NameIdChunks
extends java.lang.Object
implements ChunkGroup

Collection of convenience chunks for the NameID part of an outlook file

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameIdChunks.PredefinedPropertySet
static class	NameIdChunks.PropertySetType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor and Description
NameIdChunks()

Method Summary

Modifier and Type	Method and Description
void	chunksComplete() Used to flag that all the chunks of the NameID have now been located.
Chunk[]	getAll()
Chunk[]	getChunks() Returns the chunks that make up the group.
long	getPropertyTag(ClassID guid, java.lang.String name, long id) Get property tag id by property set GUID and string name or numerical name from named properties mapping
void	record(Chunk chunk) Called by the parser whenever a chunk is found.

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

NameIdChunks

public NameIdChunks()

Method Detail

getAll

public Chunk[] getAll()

getChunks

public Chunk[] getChunks()

Description copied from interface: ChunkGroup

Returns the chunks that make up the group. Should certainly contain all the interesting Chunks, but needn't always contain all of the Chunks.

Specified by:

getChunks in interface ChunkGroup

record

public void record(Chunk chunk)

Called by the parser whenever a chunk is found.

Specified by:

record in interface ChunkGroup

chunksComplete

public void chunksComplete()

Used to flag that all the chunks of the NameID have now been located.

Specified by:

chunksComplete in interface ChunkGroup

getPropertyTag

public long getPropertyTag(ClassID guid,
                           java.lang.String name,
                           long id)

Get property tag id by property set GUID and string name or numerical name from named properties mapping

Parameters:

guid - Property set GUID in registry format without brackets. May be one of the PS_* or PSETID_* constants

name - Property name in case of string named property

id - Property id in case of numerical named property

Returns:

Property tag which can be matched with MAPIProperty.id or 0 if the property could not be found.