org.apache.james.mime4j.stream

Interface ContentDescriptor

All Known Subinterfaces:

BodyDescriptor

All Known Implementing Classes:

BasicBodyDescriptor, MaximalBodyDescriptor

public interface ContentDescriptor

A descriptor containing common MIME content properties.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCharset() The body descriptors character set, defaulted appropriately for the MIME type.
long	getContentLength() Returns the body descriptors content-length.
java.lang.String	getMediaType() Gets the defaulted MIME media type for this content.
java.lang.String	getMimeType() Returns the body descriptors MIME type.
java.lang.String	getSubType() Gets the defaulted MIME sub type for this content.
java.lang.String	getTransferEncoding() Returns the body descriptors transfer encoding.

Method Detail

getMimeType

java.lang.String getMimeType()

Returns the body descriptors MIME type.

Returns:

The MIME type, which has been parsed from the content-type definition. Must not be null, but "text/plain", if no content-type was specified.

See Also:

getMediaType(), getSubType()

getMediaType

java.lang.String getMediaType()

Gets the defaulted MIME media type for this content. For example TEXT, IMAGE, MULTIPART

Returns:

the MIME media type when content-type specified, otherwise the correct default (TEXT)

See Also:

getMimeType()

getSubType

java.lang.String getSubType()

Gets the defaulted MIME sub type for this content.

Returns:

the MIME media type when content-type is specified, otherwise the correct default (PLAIN)

See Also:

getMimeType()

getCharset

java.lang.String getCharset()

The body descriptors character set, defaulted appropriately for the MIME type.

For TEXT types, this will be defaulted to us-ascii. For other types, when the charset parameter is missing this property will be null.

Returns:

Character set, which has been parsed from the content-type definition. Not null for TEXT types, when unset will be set to default us-ascii. For other types, when unset, null will be returned.

getTransferEncoding

java.lang.String getTransferEncoding()

Returns the body descriptors transfer encoding.

Returns:

The transfer encoding. Must not be null, but "7bit", if no transfer-encoding was specified.

getContentLength

long getContentLength()

Returns the body descriptors content-length.

Returns:

Content length, if known, or -1, to indicate the absence of a content-length header.