org.apache.james.mime4j.stream

Class RawEntity

java.lang.Object

org.apache.james.mime4j.stream.RawEntity

All Implemented Interfaces:

EntityStateMachine

public class RawEntity
extends Object
implements EntityStateMachine

Raw MIME entity. Such entities will not be parsed into elements by the parser. They are meant to be consumed as a raw data stream by the caller.

Method Summary

Methods

Modifier and Type	Method and Description
EntityStateMachine	advance() Advances the state machine to the next state in the process of the MIME stream parsing.
BodyDescriptor	getBodyDescriptor() This method has no effect and always returns null.
InputStream	getContentStream() Returns raw data stream.
InputStream	getDecodedContentStream() Returns the decoded content stream of the entity body.
RawField	getField() This method has no effect and always returns null.
String	getFieldName() This method has no effect and always returns null.
String	getFieldValue() This method has no effect and always returns null.
EntityState	getState() Return the current state of the entity.
void	setRecursionMode(RecursionMode recursionMode) This method has no effect.

Methods inherited from class java.lang.Object

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

Method Detail

getState

public EntityState getState()

Description copied from interface: EntityStateMachine

Return the current state of the entity.

Specified by:

getState in interface EntityStateMachine

Returns:

current state

See Also:

EntityState

setRecursionMode

public void setRecursionMode(RecursionMode recursionMode)

This method has no effect.

Specified by:

setRecursionMode in interface EntityStateMachine

See Also:

RecursionMode

advance

public EntityStateMachine advance()

Description copied from interface: EntityStateMachine

Advances the state machine to the next state in the process of the MIME stream parsing. This method may return an new state machine that represents an embedded entity, which must be parsed before the parsing process of the current entity can proceed.

Specified by:

advance in interface EntityStateMachine

Returns:

a state machine of an embedded entity, if encountered, null otherwise.

getContentStream

public InputStream getContentStream()

Returns raw data stream.

Specified by:

getContentStream in interface EntityStateMachine

Returns:

input stream

getBodyDescriptor

public BodyDescriptor getBodyDescriptor()

This method has no effect and always returns null.

Specified by:

getBodyDescriptor in interface EntityStateMachine

Returns:

body description

getField

public RawField getField()

This method has no effect and always returns null.

Specified by:

getField in interface EntityStateMachine

Returns:

header field

getFieldName

public String getFieldName()

This method has no effect and always returns null.

getFieldValue

public String getFieldValue()

This method has no effect and always returns null.

getDecodedContentStream

public InputStream getDecodedContentStream()
                                    throws IllegalStateException

Description copied from interface: EntityStateMachine

Returns the decoded content stream of the entity body.

Specified by:

getDecodedContentStream in interface EntityStateMachine

Returns:

input stream

Throws:

IllegalStateException - if the content stream cannot be obtained at the current stage of the parsing process.

See Also:

EntityStateMachine.getDecodedContentStream()