DocFlavor.STRING JDK 1.6)

Description

publicstatic class DocFlavor.STRING

Class DocFlavor.STRING provides predefined static constant DocFlavor objects for example doc flavors using a string (java.lang.String) as the print data representation class.

See also:

Constructors

public DocFlavor.STRING (String mimeType)

Constructs a new doc flavor with the given MIME type and a print data representation class name of "java.lang.String".

Constructs a new doc flavor with the given MIME type and a print
data representation class name of "java.lang.String".
Parameters:
- mimeType - MIME media type string. If it is a text media type, it is assumed to contain a "charset=utf-16" parameter.
Throws:
- NullPointerException - (unchecked exception) Thrown if mimeType is null.
- IllegalArgumentException - (unchecked exception) Thrown if mimeType does not obey the syntax for a MIME media type string.

Methods

Hide/Show inherited methods

public boolean equals (Object obj) [Inherited From DocFlavor]

Determines if this doc flavor object is equal to the given object.

Determines if this doc flavor object is equal to the given object.
The two are equal if the given object is not null, is an instance
of DocFlavor, has a MIME type equivalent to this doc
flavor object's MIME type (that is, the MIME types have the same media
type, media subtype, and parameters), and has the same representation
class name as this doc flavor object. Thus, if two doc flavor objects'
MIME types are the same except for comments, they are considered equal.
However, two doc flavor objects with MIME types of "text/plain" and
"text/plain; charset=US-ASCII" are not considered equal, even though
they represent the same media type (because the default character
set for plain text is US-ASCII).
Returns: True if this doc flavor object equals obj, false otherwise.
Parameters:
- obj - Object to test.

public String getMediaSubtype () [Inherited From DocFlavor]

Returns this doc flavor object's media subtype (from the MIME type).

public String getMediaType () [Inherited From DocFlavor]

Returns this doc flavor object's media type (from the MIME type).

public String getMimeType () [Inherited From DocFlavor]

Returns this doc flavor object's MIME type string based on the canonical form.

public String getParameter (String paramName) [Inherited From DocFlavor]

Returns a String representing a MIME parameter.

Returns a String representing a MIME parameter. Mime types may include parameters which are usually optional. The charset for text types is a commonly useful example. This convenience method will return the value of the specified parameter if one was specified in the mime type for this flavor.

Returns: String representing a mime parameter, or null if that parameter is not in the mime type string.
Parameters:
- paramName - the name of the paramater. This name is internally converted to the canonical lower case format before performing the match.
Throws:
- throws - NullPointerException if paramName is null.

public String getRepresentationClassName () [Inherited From DocFlavor]

Returns the name of this doc flavor object's representation class.

public int hashCode () [Inherited From DocFlavor]

Returns a hash code for this doc flavor object.

public String toString () [Inherited From DocFlavor]

Converts this DocFlavor to a string.

Converts this DocFlavor to a string.
Returns: MIME type string based on the canonical form. Each parameter value is enclosed in quotes. A "class=" parameter is appended to the MIME type string to indicate the representation class name.

Fields

Hide/Show inherited fields

publicfinalstatic String hostEncoding [Inherited From DocFlavor]

A String representing the host operating system encoding.

publicfinalstatic STRING TEXT_HTML

Doc flavor with MIME type =

"text/html; 
 charset=utf-16"

, print data representation class name = "java.lang.String".

publicfinalstatic STRING TEXT_PLAIN

Doc flavor with MIME type =

"text/plain; 
 charset=utf-16"

, print data representation class name = "java.lang.String".

Nested Classes

DocFlavor.BYTE_ARRAY

Class DocFlavor.BYTE_ARRAY provides predefined static constant DocFlavor objects for example doc flavors using a byte array (byte[]) as the print data representation class.

DocFlavor.INPUT_STREAM

Class DocFlavor.INPUT_STREAM provides predefined static constant DocFlavor objects for example doc flavors using a byte stream (java.io.InputStream) as the print data representation class.

DocFlavor.URL

Class DocFlavor.URL provides predefined static constant DocFlavor objects.

DocFlavor.CHAR_ARRAY

Class DocFlavor.CHAR_ARRAY provides predefined static constant DocFlavor objects for example doc flavors using a character array (char[]) as the print data representation class.

DocFlavor.STRING

Class DocFlavor.STRING provides predefined static constant DocFlavor objects for example doc flavors using a string (java.lang.String) as the print data representation class.

DocFlavor.READER

Class DocFlavor.READER provides predefined static constant DocFlavor objects for example doc flavors using a character stream (java.io.Reader) as the print data representation class.

DocFlavor.SERVICE_FORMATTED

Class DocFlavor.SERVICE_FORMATTED provides predefined static constant DocFlavor objects for example doc flavors for service formatted print data.