Attr (net.bluemind.parent 4.1.62132 API)

java.lang.Object
- net.freeutils.tnef.Attr

```
public class Attr
extends java.lang.Object
```
The Attr class encapsulates a TNEF attribute. A TNEF stream consists of a flat list of attributes, which belong either to the message level or attachment level. An attAttachRenddata attribute marks the beginning of an attachment, and all subsequent attributes (until the next attachment begins) belong to it. Different attributes have a different meaning for the underlying raw data, thus the getValue() method returns different types of objects. The object returned is determined by the attribute type, except for several special cases.

Since:

2003-04-25

Author:

Amichai Rothman

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`atpByte` Attribute type constant.
`static int`	`atpDate` Attribute type constant.
`static int`	`atpDword` Attribute type constant.
`static int`	`atpLong` Attribute type constant.
`static int`	`atpMax` Attribute type constant.
`static int`	`atpShort` Attribute type constant.
`static int`	`atpString` Attribute type constant.
`static int`	`atpText` Attribute type constant.
`static int`	`atpTriples` Attribute type constant.
`static int`	`atpWord` Attribute type constant.
`static int`	`attAidOwner` Attribute ID constant.
`static int`	`attAttachCreateDate` Attribute ID constant.
`static int`	`attAttachData` Attribute ID constant.
`static int`	`attAttachment` Attribute ID constant.
`static int`	`attAttachMetaFile` Attribute ID constant.
`static int`	`attAttachModifyDate` Attribute ID constant.
`static int`	`attAttachRenddata` Attribute ID constant.
`static int`	`attAttachTitle` Attribute ID constant.
`static int`	`attAttachTransportFilename` Attribute ID constant.
`static int`	`attBody` Attribute ID constant.
`static int`	`attConversationID` Attribute ID constant.
`static int`	`attDateEnd` Attribute ID constant.
`static int`	`attDateModified` Attribute ID constant.
`static int`	`attDateRecd` Attribute ID constant.
`static int`	`attDateSent` Attribute ID constant.
`static int`	`attDateStart` Attribute ID constant.
`static int`	`attDelegate` Attribute ID constant.
`static int`	`attFrom` Attribute ID constant.
`static int`	`attMAPIProps` Attribute ID constant.
`static int`	`attMessageClass` Attribute ID constant.
`static int`	`attMessageID` Attribute ID constant.
`static int`	`attMessageStatus` Attribute ID constant.
`static int`	`attNull` Attribute ID constant.
`static int`	`attOemCodepage` Attribute ID constant.
`static int`	`attOriginalMessageClass` Attribute ID constant.
`static int`	`attOwner` Attribute ID constant.
`static int`	`attParentID` Attribute ID constant.
`static int`	`attPriority` Attribute ID constant.
`static int`	`attRecipTable` Attribute ID constant.
`static int`	`attRequestRes` Attribute ID constant.
`static int`	`attSentFor` Attribute ID constant.
`static int`	`attSubject` Attribute ID constant.
`static int`	`attTnefVersion` Attribute ID constant.
`static byte`	`LVL_ATTACHMENT` Attribute level constant.
`static byte`	`LVL_MESSAGE` Attribute level constant.

Constructor Summary

Constructors
Constructor and Description
`Attr(byte level, int type, int ID, java.lang.Object data)` Constructs an Attr containing the specified values.
`Attr(byte level, int type, int ID, RawInputStream rawData)` Constructs an Attr containing the specified values.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Attr`	`findAttr(java.util.List<Attr> attributes, int ID)` Finds an attribute with the specified ID within given attribute list.
`int`	`getID()` Gets the Attr ID.
`int`	`getLength()` Gets the Attr data length (in bytes).
`byte`	`getLevel()` Gets the Attr level.
`RawInputStream`	`getRawData()` Gets the Attr raw data.
`int`	`getType()` Gets the Attr type.
`java.lang.Object`	`getValue()` Returns the value of the Attr's data.
`protected void`	`read(RawInputStream in)` Reads this attribute's data from the given RawInputStream.
`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

- Field Detail
  - atpTriples
```
public static final int atpTriples
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpString
```
public static final int atpString
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpText
```
public static final int atpText
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpDate
```
public static final int atpDate
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpShort
```
public static final int atpShort
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpLong
```
public static final int atpLong
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpByte
```
public static final int atpByte
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpWord
```
public static final int atpWord
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpDword
```
public static final int atpDword
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - atpMax
```
public static final int atpMax
```
    Attribute type constant.
    
    See Also:
    
    Constant Field Values
  - LVL_MESSAGE
```
public static final byte LVL_MESSAGE
```
    Attribute level constant.
    
    See Also:
    
    Constant Field Values
  - LVL_ATTACHMENT
```
public static final byte LVL_ATTACHMENT
```
    Attribute level constant.
    
    See Also:
    
    Constant Field Values
  - attNull
```
public static final int attNull
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attFrom
```
public static final int attFrom
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attSubject
```
public static final int attSubject
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attDateSent
```
public static final int attDateSent
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attDateRecd
```
public static final int attDateRecd
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attMessageStatus
```
public static final int attMessageStatus
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attMessageClass
```
public static final int attMessageClass
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attMessageID
```
public static final int attMessageID
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attParentID
```
public static final int attParentID
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attConversationID
```
public static final int attConversationID
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attBody
```
public static final int attBody
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attPriority
```
public static final int attPriority
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachData
```
public static final int attAttachData
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachTitle
```
public static final int attAttachTitle
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachMetaFile
```
public static final int attAttachMetaFile
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachCreateDate
```
public static final int attAttachCreateDate
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachModifyDate
```
public static final int attAttachModifyDate
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attDateModified
```
public static final int attDateModified
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachTransportFilename
```
public static final int attAttachTransportFilename
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachRenddata
```
public static final int attAttachRenddata
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attMAPIProps
```
public static final int attMAPIProps
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attRecipTable
```
public static final int attRecipTable
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAttachment
```
public static final int attAttachment
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attTnefVersion
```
public static final int attTnefVersion
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attOemCodepage
```
public static final int attOemCodepage
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attOriginalMessageClass
```
public static final int attOriginalMessageClass
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attOwner
```
public static final int attOwner
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attSentFor
```
public static final int attSentFor
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attDelegate
```
public static final int attDelegate
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attDateStart
```
public static final int attDateStart
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attDateEnd
```
public static final int attDateEnd
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attAidOwner
```
public static final int attAidOwner
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
  - attRequestRes
```
public static final int attRequestRes
```
    Attribute ID constant.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Attr
```
public Attr(byte level,
            int type,
            int ID,
            java.lang.Object data)
```
    Constructs an Attr containing the specified values.
    
    Parameters:
    
    level - the attribute level (from LVL_* constants)
    
    type - the attribute type (from atp* constants)
    
    ID - the attribute ID (from att* constants)
    
    data - the attribute data
  - Attr
```
public Attr(byte level,
            int type,
            int ID,
            RawInputStream rawData)
```
    Constructs an Attr containing the specified values.
    
    Parameters:
    
    level - the attribute level (from LVL_* constants)
    
    type - the attribute type (from atp* constants)
    
    ID - the attribute ID (from att* constants)
    
    rawData - the attribute's raw data
- Method Detail
  - getLevel
```
public byte getLevel()
```
    Gets the Attr level.
    
    Returns:
    
    the Attr level
  - getType
```
public int getType()
```
    Gets the Attr type.
    
    Returns:
    
    the Attr type
  - getID
```
public int getID()
```
    Gets the Attr ID.
    
    Returns:
    
    the Attr ID
  - getLength
```
public int getLength()
```
    Gets the Attr data length (in bytes).
    
    Returns:
    
    the Attr data length (in bytes), or -1 if it is unknown
  - getRawData
```
public RawInputStream getRawData()
```
    Gets the Attr raw data.
    
    Returns:
    
    the Attr raw data
  - 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 of the Attr's data. Different attributes have a different meaning for the underlying raw data, thus the getValue() method returns different types of objects. The object returned is determined by the attribute type, except for several special cases. The returned Object should be cast into the appropriate class.
    
    Returns:
    
    the value of the Attr's data
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - read
```
protected void read(RawInputStream in)
             throws java.io.IOException
```
    Reads this attribute's data from the given RawInputStream.
    
    Parameters:
    
    in - the RawInputStream containing attribute data
    
    Throws:
    
    java.io.IOException - if an I/O error occurs
  - findAttr
```
public static Attr findAttr(java.util.List<Attr> attributes,
                            int ID)
```
    Finds an attribute with the specified ID within given attribute list.
    
    Parameters:
    
    attributes - the attribute list to search
    
    ID - the ID of the attribute to search for
    
    Returns:
    
    an attribute with given ID found in the attribute list, or null if no such attribute exists

Class Attr

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

atpTriples

atpString

atpText

atpDate

atpShort

atpLong

atpByte

atpWord

atpDword

atpMax

LVL_MESSAGE

LVL_ATTACHMENT

attNull

attFrom

attSubject

attDateSent

attDateRecd

attMessageStatus

attMessageClass

attMessageID

attParentID

attConversationID

attBody

attPriority

attAttachData

attAttachTitle

attAttachMetaFile

attAttachCreateDate

attAttachModifyDate

attDateModified

attAttachTransportFilename

attAttachRenddata

attMAPIProps

attRecipTable

attAttachment

attTnefVersion

attOemCodepage

attOriginalMessageClass

attOwner

attSentFor

attDelegate

attDateStart

attDateEnd

attAidOwner

attRequestRes

Constructor Detail

Attr

Attr

Method Detail

getLevel

getType

getID

getLength

getRawData

toString

getValue

read

findAttr