org.apache.poi.hsmf.datatypes

Class Chunk

java.lang.Object

org.apache.poi.hsmf.datatypes.Chunk

Direct Known Subclasses:

ByteChunk, DirectoryChunk, MessageSubmissionChunk, PropertiesChunk, StringChunk

public abstract class Chunk
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Chunk(int chunkId, Types.MAPIType type)
protected	Chunk(String namePrefix, int chunkId, Types.MAPIType type)

Method Summary

Modifier and Type	Method and Description
int	getChunkId() Gets the id of this chunk
String	getEntryName() Creates a string to use to identify this chunk in the POI file system object.
Types.MAPIType	getType() Gets the numeric type of this chunk.
abstract void	readValue(InputStream value) Reads the value of this chunk using an InputStream
abstract void	writeValue(OutputStream out) Writes the value of this chunk back out again.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAME_PREFIX

public static final String DEFAULT_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

Chunk

protected Chunk(String namePrefix,
                int chunkId,
                Types.MAPIType type)

Chunk

protected Chunk(int chunkId,
                Types.MAPIType type)

Method Detail

getChunkId

public int getChunkId()

Gets the id of this chunk

getType

public Types.MAPIType getType()

Gets the numeric type of this chunk.

getEntryName

public String getEntryName()

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

writeValue

public abstract void writeValue(OutputStream out)
                         throws IOException

Writes the value of this chunk back out again.

Throws:

IOException

readValue

public abstract void readValue(InputStream value)
                        throws IOException

Reads the value of this chunk using an InputStream

Throws:

IOException