|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.james.mime4j.parser.AbstractContentHandler
public abstract class AbstractContentHandler
Abstract base class for custom ContentHandler implementations. Methods of this class
take no action and are expected to be selectively overridden by super-classes.
| Constructor Summary | |
|---|---|
AbstractContentHandler()
|
|
| Method Summary | |
|---|---|
void |
body(BodyDescriptor bd,
InputStream is)
Called when the body of a discrete (non-multipart) entity is about to be parsed. |
void |
endBodyPart()
Called when a body part ends. |
void |
endHeader()
Called when there are no more header fields in a message or body part. |
void |
endMessage()
Called when a message ends. |
void |
endMultipart()
Called when the body of an entity has been parsed. |
void |
epilogue(InputStream is)
Called for the epilogue (whatever comes after the final body part) of a multipart/* entity. |
void |
field(Field field)
Called for each field of a header. |
void |
preamble(InputStream is)
Called for the preamble (whatever comes before the first body part) of a multipart/* entity. |
void |
raw(InputStream is)
Called when a new entity (message or body part) starts and the parser is in raw mode. |
void |
startBodyPart()
Called when a new body part starts inside a multipart/* entity. |
void |
startHeader()
Called when a header (of a message or body part) is about to be parsed. |
void |
startMessage()
Called when a new message starts (a top level message or an embedded rfc822 message). |
void |
startMultipart(BodyDescriptor bd)
Called when the body of a multipart entity is about to be parsed. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public AbstractContentHandler()
| Method Detail |
|---|
public void endMultipart()
throws MimeException
ContentHandler
endMultipart in interface ContentHandlerMimeException - on processing errors
public void startMultipart(BodyDescriptor bd)
throws MimeException
ContentHandler
startMultipart in interface ContentHandlerbd - encapsulates the values (either read from the
message stream or, if not present, determined implictly
as described in the
MIME rfc:s) of the Content-Type and
Content-Transfer-Encoding header fields.
MimeException - on processing errors
public void body(BodyDescriptor bd,
InputStream is)
throws MimeException,
IOException
ContentHandler
body in interface ContentHandlerbd - see ContentHandler.startMultipart(BodyDescriptor)is - the contents of the body. NOTE: this is the raw body contents
- it will not be decoded if encoded. The bd
parameter should be used to determine how the stream data
should be decoded.
MimeException - on processing errors
IOException - should be thrown on I/O errors.
public void endBodyPart()
throws MimeException
ContentHandler
endBodyPart in interface ContentHandlerMimeException - on processing errors
public void endHeader()
throws MimeException
ContentHandler
endHeader in interface ContentHandlerMimeException - on processing errors
public void endMessage()
throws MimeException
ContentHandler
endMessage in interface ContentHandlerMimeException - on processing errors
public void epilogue(InputStream is)
throws MimeException,
IOException
ContentHandlermultipart/* entity.
epilogue in interface ContentHandleris - used to get the contents of the epilogue.
MimeException - on processing errors
IOException - should be thrown on I/O errors.
public void field(Field field)
throws MimeException
ContentHandler
field in interface ContentHandlerfield - the MIME field.
MimeException - on processing errors
public void preamble(InputStream is)
throws MimeException,
IOException
ContentHandlermultipart/* entity.
preamble in interface ContentHandleris - used to get the contents of the preamble.
MimeException - on processing errors
IOException - should be thrown on I/O errors.
public void startBodyPart()
throws MimeException
ContentHandlermultipart/* entity.
startBodyPart in interface ContentHandlerMimeException - on processing errors
public void startHeader()
throws MimeException
ContentHandler
startHeader in interface ContentHandlerMimeException - on processing errors
public void startMessage()
throws MimeException
ContentHandler
startMessage in interface ContentHandlerMimeException - on processing errors
public void raw(InputStream is)
throws MimeException,
IOException
ContentHandlerraw mode.
raw in interface ContentHandleris - the raw contents of the entity.
MimeException - on processing errors
IOException - should be thrown on I/O errors.MimeStreamParser.setRaw()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||