org.apache.poi.hmef
Class Attribute

java.lang.Object
  extended by org.apache.poi.hmef.Attribute

public final class Attribute
extends java.lang.Object

An attribute which applies to a HMEFMessage or one of its Attachments. Note - the types and IDs differ from standard Outlook/MAPI ones, so we can't just re-use the HSMF ones.


Nested Class Summary
static class Attribute.AttributeID
          Holds information on one potential ID of an attribute, and provides handy lookups for it.
 
Field Summary
static Attribute.AttributeID ID_AIDOWNER
           
static Attribute.AttributeID ID_ATTACHCREATEDATE
           
static Attribute.AttributeID ID_ATTACHDATA
           
static Attribute.AttributeID ID_ATTACHMENT
           
static Attribute.AttributeID ID_ATTACHMETAFILE
           
static Attribute.AttributeID ID_ATTACHMODIFYDATE
           
static Attribute.AttributeID ID_ATTACHRENDERDATA
           
static Attribute.AttributeID ID_ATTACHTITLE
           
static Attribute.AttributeID ID_ATTACHTRANSPORTFILENAME
           
static Attribute.AttributeID ID_BODY
           
static Attribute.AttributeID ID_CONVERSATIONID
           
static Attribute.AttributeID ID_DATEEND
           
static Attribute.AttributeID ID_DATEMODIFIED
           
static Attribute.AttributeID ID_DATERECEIVED
           
static Attribute.AttributeID ID_DATESENT
           
static Attribute.AttributeID ID_DATESTART
           
static Attribute.AttributeID ID_DELEGATE
           
static Attribute.AttributeID ID_FROM
           
static Attribute.AttributeID ID_MAPIPROPERTIES
           
static Attribute.AttributeID ID_MESSAGECLASS
           
static Attribute.AttributeID ID_MESSAGEID
           
static Attribute.AttributeID ID_MESSAGESTATUS
           
static Attribute.AttributeID ID_NULL
           
static Attribute.AttributeID ID_OEMCODEPAGE
           
static Attribute.AttributeID ID_ORIGINALMESSAGECLASS
           
static Attribute.AttributeID ID_OWNER
           
static Attribute.AttributeID ID_PARENTID
           
static Attribute.AttributeID ID_PRIORITY
           
static Attribute.AttributeID ID_RECIPIENTTABLE
           
static Attribute.AttributeID ID_REQUESTRESPONSE
           
static Attribute.AttributeID ID_SENTFOR
           
static Attribute.AttributeID ID_SUBJECT
           
static Attribute.AttributeID ID_TNEFVERSION
           
static Attribute.AttributeID ID_UNKNOWN
           
static int LEVEL_ATTACHMENT
           
static int LEVEL_END_OF_FILE
           
static int LEVEL_MESSAGE
           
static int PTYPE_APPTIME
          AppTime - application time value
static int PTYPE_BINARY
          Binary - counted byte array
static int PTYPE_BOOLEAN
          Boolean - 16-bit Boolean value.
static int PTYPE_CLASSID
          ClassId - OLE GUID
static int PTYPE_CURRENCY
          Currency - signed 64-bit integer that represents a base ten decimal with four digits to the right of the decimal point
static int PTYPE_DOUBLE
          Double - floating point double
static int PTYPE_ERROR
          Error - 32-bit error value
static int PTYPE_I2
          I2 - signed 16-bit value
static int PTYPE_I8
          I8 - 8-byte signed integer
static int PTYPE_LONG
          Long - signed 32-bit value
static int PTYPE_MULTIVALUED
          MultiValued - Value part contains multiple values
static int PTYPE_NULL
          Null - NULL property value
static int PTYPE_OBJECT
          Object - embedded object in a property
static int PTYPE_R4
          R4 - 4-byte floating point value
static int PTYPE_STRING8
          String8 - null-terminated 8-bit character string
static int PTYPE_SYSTIME
          SysTime - FILETIME 64-bit integer specifying the number of 100ns periods since Jan 1, 1601
static int PTYPE_UNICODE
          Unicode - null-terminated Unicode string
static int PTYPE_UNSPECIFIED
          Unspecified
static int TYPE_BYTE
           
static int TYPE_DATE
           
static int TYPE_DWORD
           
static int TYPE_LONG
           
static int TYPE_MAX
           
static int TYPE_SHORT
           
static int TYPE_STRING
           
static int TYPE_TEXT
           
static int TYPE_TRIPLES
           
static int TYPE_WORD
           
 
Constructor Summary
Attribute(java.io.InputStream inp)
          Constructs a single new attribute from the contents of the stream
 
Method Summary
 byte[] getData()
           
 Attribute.AttributeID getId()
           
 int getType()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE_TRIPLES

public static final int TYPE_TRIPLES
See Also:
Constant Field Values

TYPE_STRING

public static final int TYPE_STRING
See Also:
Constant Field Values

TYPE_TEXT

public static final int TYPE_TEXT
See Also:
Constant Field Values

TYPE_DATE

public static final int TYPE_DATE
See Also:
Constant Field Values

TYPE_SHORT

public static final int TYPE_SHORT
See Also:
Constant Field Values

TYPE_LONG

public static final int TYPE_LONG
See Also:
Constant Field Values

TYPE_BYTE

public static final int TYPE_BYTE
See Also:
Constant Field Values

TYPE_WORD

public static final int TYPE_WORD
See Also:
Constant Field Values

TYPE_DWORD

public static final int TYPE_DWORD
See Also:
Constant Field Values

TYPE_MAX

public static final int TYPE_MAX
See Also:
Constant Field Values

PTYPE_APPTIME

public static final int PTYPE_APPTIME
AppTime - application time value

See Also:
Constant Field Values

PTYPE_BINARY

public static final int PTYPE_BINARY
Binary - counted byte array

See Also:
Constant Field Values

PTYPE_BOOLEAN

public static final int PTYPE_BOOLEAN
Boolean - 16-bit Boolean value. '0' is false. Non-zero is true

See Also:
Constant Field Values

PTYPE_CLASSID

public static final int PTYPE_CLASSID
ClassId - OLE GUID

See Also:
Constant Field Values

PTYPE_CURRENCY

public static final int PTYPE_CURRENCY
Currency - signed 64-bit integer that represents a base ten decimal with four digits to the right of the decimal point

See Also:
Constant Field Values

PTYPE_DOUBLE

public static final int PTYPE_DOUBLE
Double - floating point double

See Also:
Constant Field Values

PTYPE_ERROR

public static final int PTYPE_ERROR
Error - 32-bit error value

See Also:
Constant Field Values

PTYPE_I2

public static final int PTYPE_I2
I2 - signed 16-bit value

See Also:
Constant Field Values

PTYPE_I8

public static final int PTYPE_I8
I8 - 8-byte signed integer

See Also:
Constant Field Values

PTYPE_LONG

public static final int PTYPE_LONG
Long - signed 32-bit value

See Also:
Constant Field Values

PTYPE_MULTIVALUED

public static final int PTYPE_MULTIVALUED
MultiValued - Value part contains multiple values

See Also:
Constant Field Values

PTYPE_NULL

public static final int PTYPE_NULL
Null - NULL property value

See Also:
Constant Field Values

PTYPE_OBJECT

public static final int PTYPE_OBJECT
Object - embedded object in a property

See Also:
Constant Field Values

PTYPE_R4

public static final int PTYPE_R4
R4 - 4-byte floating point value

See Also:
Constant Field Values

PTYPE_STRING8

public static final int PTYPE_STRING8
String8 - null-terminated 8-bit character string

See Also:
Constant Field Values

PTYPE_SYSTIME

public static final int PTYPE_SYSTIME
SysTime - FILETIME 64-bit integer specifying the number of 100ns periods since Jan 1, 1601

See Also:
Constant Field Values

PTYPE_UNICODE

public static final int PTYPE_UNICODE
Unicode - null-terminated Unicode string

See Also:
Constant Field Values

PTYPE_UNSPECIFIED

public static final int PTYPE_UNSPECIFIED
Unspecified

See Also:
Constant Field Values

LEVEL_MESSAGE

public static final int LEVEL_MESSAGE
See Also:
Constant Field Values

LEVEL_ATTACHMENT

public static final int LEVEL_ATTACHMENT
See Also:
Constant Field Values

LEVEL_END_OF_FILE

public static final int LEVEL_END_OF_FILE
See Also:
Constant Field Values

ID_AIDOWNER

public static final Attribute.AttributeID ID_AIDOWNER

ID_ATTACHCREATEDATE

public static final Attribute.AttributeID ID_ATTACHCREATEDATE

ID_ATTACHDATA

public static final Attribute.AttributeID ID_ATTACHDATA

ID_ATTACHMENT

public static final Attribute.AttributeID ID_ATTACHMENT

ID_ATTACHMETAFILE

public static final Attribute.AttributeID ID_ATTACHMETAFILE

ID_ATTACHMODIFYDATE

public static final Attribute.AttributeID ID_ATTACHMODIFYDATE

ID_ATTACHRENDERDATA

public static final Attribute.AttributeID ID_ATTACHRENDERDATA

ID_ATTACHTITLE

public static final Attribute.AttributeID ID_ATTACHTITLE

ID_ATTACHTRANSPORTFILENAME

public static final Attribute.AttributeID ID_ATTACHTRANSPORTFILENAME

ID_BODY

public static final Attribute.AttributeID ID_BODY

ID_CONVERSATIONID

public static final Attribute.AttributeID ID_CONVERSATIONID

ID_DATEEND

public static final Attribute.AttributeID ID_DATEEND

ID_DATEMODIFIED

public static final Attribute.AttributeID ID_DATEMODIFIED

ID_DATERECEIVED

public static final Attribute.AttributeID ID_DATERECEIVED

ID_DATESENT

public static final Attribute.AttributeID ID_DATESENT

ID_DATESTART

public static final Attribute.AttributeID ID_DATESTART

ID_DELEGATE

public static final Attribute.AttributeID ID_DELEGATE

ID_FROM

public static final Attribute.AttributeID ID_FROM

ID_MAPIPROPERTIES

public static final Attribute.AttributeID ID_MAPIPROPERTIES

ID_MESSAGECLASS

public static final Attribute.AttributeID ID_MESSAGECLASS

ID_MESSAGEID

public static final Attribute.AttributeID ID_MESSAGEID

ID_MESSAGESTATUS

public static final Attribute.AttributeID ID_MESSAGESTATUS

ID_NULL

public static final Attribute.AttributeID ID_NULL

ID_OEMCODEPAGE

public static final Attribute.AttributeID ID_OEMCODEPAGE

ID_ORIGINALMESSAGECLASS

public static final Attribute.AttributeID ID_ORIGINALMESSAGECLASS

ID_OWNER

public static final Attribute.AttributeID ID_OWNER

ID_PARENTID

public static final Attribute.AttributeID ID_PARENTID

ID_PRIORITY

public static final Attribute.AttributeID ID_PRIORITY

ID_RECIPIENTTABLE

public static final Attribute.AttributeID ID_RECIPIENTTABLE

ID_REQUESTRESPONSE

public static final Attribute.AttributeID ID_REQUESTRESPONSE

ID_SENTFOR

public static final Attribute.AttributeID ID_SENTFOR

ID_SUBJECT

public static final Attribute.AttributeID ID_SUBJECT

ID_TNEFVERSION

public static final Attribute.AttributeID ID_TNEFVERSION

ID_UNKNOWN

public static final Attribute.AttributeID ID_UNKNOWN
Constructor Detail

Attribute

public Attribute(java.io.InputStream inp)
          throws java.io.IOException
Constructs a single new attribute from the contents of the stream

Throws:
java.io.IOException
Method Detail

getId

public Attribute.AttributeID getId()

getType

public int getType()

getData

public byte[] getData()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object


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