EntityState

java.lang.Object
- java.lang.Enum<EntityState>
- - org.apache.james.mime4j.stream.EntityState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EntityState>
```
public enum EntityState
extends java.lang.Enum<EntityState>
```
Enumeration of states an entity is expected to go through in the process of the MIME stream parsing.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`T_BODY` This token indicates, that an atomic entity is being parsed.
`T_END_BODYPART` This token indicates, that the MIME stream is currently at the end of a body part.
`T_END_HEADER` This token indicates, that part headers have now been parsed.
`T_END_MESSAGE` This token indicates, that the MIME stream is currently at the end of a message.
`T_END_MULTIPART` This token indicates, that a multipart body has been parsed.
`T_END_OF_STREAM` This token indicates, that the MIME stream has been completely and successfully parsed, and no more data is available.
`T_EPILOGUE` This token indicates, that a multiparts epilogue is being parsed.
`T_FIELD` This token indicates, that a message parts field has now been parsed.
`T_PREAMBLE` This token indicates, that a multiparts preamble is being parsed.
`T_RAW_ENTITY` This token indicates, that a raw entity is currently being processed.
`T_START_BODYPART` This token indicates, that the MIME stream is currently at the beginning of a body part.
`T_START_HEADER` This token indicates, that a message parts headers are now being parsed.
`T_START_MESSAGE` This token indicates, that the MIME stream is currently at the beginning of a message.
`T_START_MULTIPART` This token indicates, that a multipart body is being parsed.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static EntityState`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EntityState[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - T_START_MESSAGE
```
public static final EntityState T_START_MESSAGE
```
    This token indicates, that the MIME stream is currently at the beginning of a message.
  - T_END_MESSAGE
```
public static final EntityState T_END_MESSAGE
```
    This token indicates, that the MIME stream is currently at the end of a message.
  - T_RAW_ENTITY
```
public static final EntityState T_RAW_ENTITY
```
    This token indicates, that a raw entity is currently being processed.
  - T_START_HEADER
```
public static final EntityState T_START_HEADER
```
    This token indicates, that a message parts headers are now being parsed.
  - T_FIELD
```
public static final EntityState T_FIELD
```
    This token indicates, that a message parts field has now been parsed.
  - T_END_HEADER
```
public static final EntityState T_END_HEADER
```
    This token indicates, that part headers have now been parsed.
  - T_START_MULTIPART
```
public static final EntityState T_START_MULTIPART
```
    This token indicates, that a multipart body is being parsed.
  - T_END_MULTIPART
```
public static final EntityState T_END_MULTIPART
```
    This token indicates, that a multipart body has been parsed.
  - T_PREAMBLE
```
public static final EntityState T_PREAMBLE
```
    This token indicates, that a multiparts preamble is being parsed.
  - T_EPILOGUE
```
public static final EntityState T_EPILOGUE
```
    This token indicates, that a multiparts epilogue is being parsed.
  - T_START_BODYPART
```
public static final EntityState T_START_BODYPART
```
    This token indicates, that the MIME stream is currently at the beginning of a body part.
  - T_END_BODYPART
```
public static final EntityState T_END_BODYPART
```
    This token indicates, that the MIME stream is currently at the end of a body part.
  - T_BODY
```
public static final EntityState T_BODY
```
    This token indicates, that an atomic entity is being parsed.
  - T_END_OF_STREAM
```
public static final EntityState T_END_OF_STREAM
```
    This token indicates, that the MIME stream has been completely and successfully parsed, and no more data is available.
- Method Detail
  - values
```
public static EntityState[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EntityState c : EntityState.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EntityState valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null

Enum EntityState

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

T_START_MESSAGE

T_END_MESSAGE

T_RAW_ENTITY

T_START_HEADER

T_FIELD

T_END_HEADER

T_START_MULTIPART

T_END_MULTIPART

T_PREAMBLE

T_EPILOGUE

T_START_BODYPART

T_END_BODYPART

T_BODY

T_END_OF_STREAM

Method Detail

values

valueOf