org.apache.james.mime4j.field

Class AbstractField

java.lang.Object

org.apache.james.mime4j.field.AbstractField

All Implemented Interfaces:

ParsedField, Field

Direct Known Subclasses:

AddressListFieldImpl, AddressListFieldLenientImpl, ContentDescriptionFieldImpl, ContentDispositionFieldImpl, ContentDispositionFieldLenientImpl, ContentIdFieldImpl, ContentLanguageFieldImpl, ContentLanguageFieldLenientImpl, ContentLengthFieldImpl, ContentLocationFieldImpl, ContentLocationFieldLenientImpl, ContentMD5FieldImpl, ContentTransferEncodingFieldImpl, ContentTypeFieldImpl, ContentTypeFieldLenientImpl, DateTimeFieldImpl, DateTimeFieldLenientImpl, MailboxFieldImpl, MailboxFieldLenientImpl, MailboxListFieldImpl, MailboxListFieldLenientImpl, MimeVersionFieldImpl, MimeVersionFieldLenientImpl, UnstructuredFieldImpl

public abstract class AbstractField
extends Object
implements ParsedField

The base class of all field classes.

Field Summary

Fields

Modifier and Type	Field and Description
protected DecodeMonitor	monitor
protected Field	rawField

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractField(Field rawField, DecodeMonitor monitor)

Method Summary

Methods

Modifier and Type	Method and Description
String	getBody() Gets the unfolded, unparsed and possibly encoded (see RFC 2047) field body string.
String	getName() Gets the name of the field (Subject, From, etc).
ParseException	getParseException() Returns the exception that was thrown by the field parser while parsing the field value.
ByteSequence	getRaw() Gets original (raw) representation of the field, if available, null otherwise.
protected RawField	getRawField()
boolean	isValidField() Returns true if this field is valid, i.e.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

rawField

protected final Field rawField

monitor

protected final DecodeMonitor monitor

Constructor Detail

AbstractField

protected AbstractField(Field rawField,
             DecodeMonitor monitor)

Method Detail

getName

public String getName()

Gets the name of the field (Subject, From, etc).

Specified by:

getName in interface Field

Returns:

the field name.

getBody

public String getBody()

Gets the unfolded, unparsed and possibly encoded (see RFC 2047) field body string.

Specified by:

getBody in interface Field

Returns:

the unfolded unparsed field body string.

getRaw

public ByteSequence getRaw()

Gets original (raw) representation of the field, if available, null otherwise.

Specified by:

getRaw in interface Field

isValidField

public boolean isValidField()

Description copied from interface: ParsedField

Returns true if this field is valid, i.e. no errors were encountered while parsing the field value.

Specified by:

isValidField in interface ParsedField

Returns:

true if this field is valid, false otherwise.

See Also:

ParsedField.isValidField()

getParseException

public ParseException getParseException()

Description copied from interface: ParsedField

Returns the exception that was thrown by the field parser while parsing the field value. The result is null if the field is valid and no errors were encountered.

Specified by:

getParseException in interface ParsedField

Returns:

the exception that was thrown by the field parser or null if the field is valid.

See Also:

ParsedField.getParseException()

getRawField

protected RawField getRawField()

toString

public String toString()

Overrides:

toString in class Object