net.freeutils.tnef

Class MAPIValue

java.lang.Object

net.freeutils.tnef.MAPIValue

public class MAPIValue
extends java.lang.Object

The MAPIProp class encapsulates the value of a MAPI property.

Since:

2003-07-25

Author:

Amichai Rothman

Constructor Summary

Constructors

Constructor and Description
MAPIValue(int type, RawInputStream data, int length) Constructs a MAPIValue containing a given value.

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Gets the MAPIValue data.
int	getLength() Gets the MAPIValue data length (in bytes).
RawInputStream	getRawData() Gets the MAPIValue raw data.
int	getType() Gets the MAPIValue type.
java.lang.Object	getValue() Returns the value encapsulated by this MAPIValue.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MAPIValue

public MAPIValue(int type,
                 RawInputStream data,
                 int length)
          throws java.io.IOException

Constructs a MAPIValue containing a given value.

Parameters:

type - the value type

data - the TNEF stream containing the value

length - the length of the value data (in bytes)

Throws:

java.lang.IllegalArgumentException - if type is invalid

java.io.IOException - if the stream end is reached, or if an I/O error occurs

Method Detail

getType

public int getType()

Gets the MAPIValue type.

Returns:

the MAPIValue type

getLength

public int getLength()

Gets the MAPIValue data length (in bytes).

Returns:

the MAPIValue data length (in bytes)

getData

public byte[] getData()

Gets the MAPIValue data.

Returns:

the MAPIValue data

getRawData

public RawInputStream getRawData()
                          throws java.io.IOException

Gets the MAPIValue raw data.

Returns:

the MAPIValue raw data

Throws:

java.io.IOException - if the stream end is reached, or if an I/O error occurs

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this object

getValue

public java.lang.Object getValue()
                          throws java.io.IOException

Returns the value encapsulated by this MAPIValue. The returned Object should be cast into an appropriate class, according to the MAPIValue's type.

Returns:

the value encapsulated by this MAPIValue

Throws:

java.io.IOException - if the stream end is reached, or if an I/O error occurs