⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
gnu.mail.handler

Class Text

java.lang.Object
|
+--gnu.mail.handler.Text

All Implemented Interfaces:
DataContentHandler

Known Direct Subclasses:
TextHtml, TextPlain, TextXml


public abstract class Text
extends java.lang.Object
implements DataContentHandler

A JAF data content handler for the text/* family of MIME content types. This provides the basic behaviour for any number of text-handling subtypes which simply need to override their default constructor to provide the correct MIME content-type and description.

Field Summary

DataFlavor

flavor

Our favorite data flavor.

Constructor Summary

Text(String mimeType, String description)

Constructor specifying the data flavor.

Method Summary

Object

getContent(DataSource source)

Return an object representing the data in its most preferred form.

static String

getJavaCharset(String contentType)

Returns the Java character set corresponding to the MIME charset parameter of the content type value.

Object

getTransferData(DataFlavor flavor, DataSource source)

Returns an object which represents the data to be transferred.

DataFlavor[]

getTransferDataFlavors()

Returns an array of DataFlavor objects indicating the flavors the data can be provided in.

void

writeTo(Object object, String mimeType, OutputStream out)

Convert the object to a byte stream of the specified MIME type and write it to the output stream.

Field Details

flavor

protected DataFlavor flavor

Our favorite data flavor. Yum yum.

Constructor Details

Text

protected Text(String mimeType, String description)

Constructor specifying the data flavor.

Parameters:
mimeType - the MIME content type
description - the description of the content type

Method Details

getContent

public Object getContent(DataSource source)

Return an object representing the data in its most preferred form. Generally this will be the form described by the first data flavor returned by the getTransferDataFlavors method.

Parameters:
source - the data source representing the data to be converted
Returns:
the constructed object

getJavaCharset

protected static String getJavaCharset(String contentType)

Returns the Java character set corresponding to the MIME charset parameter of the content type value. The default value is the Java character set mapped to the MIME charset "us-ascii".

Parameters:
contentType
Returns:
a java charset name

getTransferData

public Object getTransferData(DataFlavor flavor, DataSource source)

Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Parameters:
flavor - the data flavor representing the requested type
source - the data source representing the data to be converted
Returns:
the constructed object

getTransferDataFlavors

public DataFlavor[] getTransferDataFlavors()

Returns an array of DataFlavor objects indicating the flavors the data can be provided in.

Returns:
the DataFlavors

writeTo

public void writeTo(Object object, String mimeType, OutputStream out)

Convert the object to a byte stream of the specified MIME type and write it to the output stream.

Parameters:
object - the object to be converted
mimeType - the requested MIME content type to write as
out - the output stream into which to write the converted object