Class MimeType encapsulates a Multipurpose Internet Mail Extensions (MIME) media type as defined in RFC 2045 and RFC 2046. A MIME type object is part of a DocFlavor object and specifies the format of the print data.

Class MimeType is similar to the like-named class in package java.awt.datatransfer. Class java.awt.datatransfer.MimeType is not used in the Jini Print Service API for two reasons:

Since not all Java profiles include the AWT, the Jini Print Service should not depend on an AWT class.
The implementation of class java.awt.datatransfer.MimeType does not guarantee that equivalent MIME types will have the same serialized representation. Thus, since the Jini Lookup Service (JLUS) matches service attributes based on equality of serialized representations, JLUS searches involving MIME types encapsulated in class java.awt.datatransfer.MimeType may incorrectly fail to match.

Class MimeType's serialized representation is based on the following canonical form of a MIME type string. Thus, two MIME types that are not identical but that are equivalent (that have the same canonical form) will be considered equal by the JLUS's matching algorithm.

The media type, media subtype, and parameters are retained, but all comments and whitespace characters are discarded.
The media type, media subtype, and parameter names are converted to lowercase.
The parameter values retain their original case, except a charset parameter value for a text media type is converted to lowercase.
Quote characters surrounding parameter values are removed.
Quoting backslash characters inside parameter values are removed.
The parameters are arranged in ascending order of parameter name.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	MimeType.LexicalAnalyzer Class for a lexical analyzer.
private class	MimeType.ParameterMap Parameter map.
private class	MimeType.ParameterMapEntry Parameter map entry.
private class	MimeType.ParameterMapEntrySet Parameter map entry set.
private class	MimeType.ParameterMapEntrySetIterator Parameter map entry set iterator.

Field Summary

Modifier and Type	Field and Description
private static final int	EOF_LEXEME
private static final int	ILLEGAL_LEXEME
private transient MimeType.ParameterMapEntrySet	myEntrySet Parameter map entry set.
private transient MimeType.ParameterMap	myParameterMap Parameter map.
private String[]	myPieces Array of strings that hold pieces of this MIME type's canonical form.
private transient String	myStringValue String value for this MIME type.
private static final int	QUOTED_STRING_LEXEME
private static final long	serialVersionUID Use serialVersionUID from JDK 1.4 for interoperability.
private static final int	TOKEN_LEXEME
private static final int	TSPECIAL_LEXEME

Access	Constructor and Description
public	MimeType(String MIME media type string s) Construct a new MIME type object from the given string.

Method Summary

Modifier and Type	Method and Description
private static String	Returns: the string surrounded by quotes and with interior quotes preceded by a backslash addQuotes(String the string s) Returns a version of the string surrounded by quotes and with interior quotes preceded by a backslash.
public boolean	Returns: `true` if this MIME type object equals `obj`, `false` otherwise equals(Object `object` to test obj) Overrides java.lang.Object.equals. Determine if this MIME type object is equal to the given object.
public String	Returns: the media subtype getMediaSubtype() Returns this MIME type object's media subtype.
public String	Returns: the media type getMediaType() Returns this MIME type object's media type.
public String	Returns: the mime type getMimeType() Returns this MIME type object's MIME type string based on the canonical form.
public Map<String, String>	Returns: parameter map for this MIME type object getParameterMap() Returns an unmodifiable map view of the parameters in this MIME type object.
private String	Returns: the MIME type's string value in canonical form getStringValue() Returns this MIME type's string value in canonical form.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this MIME type object.
private void	parse(String MIME media type string s) Parses the given string into canonical pieces and stores the pieces in `myPieces`.
private static String	Returns: the string with backslashes removed removeBackslashes(String the string s) Returns a version of the given string with backslashes removed.
public String	Returns: MIME type string based on the canonical form. Each parameter value is enclosed in quotes. toString() Overrides java.lang.Object.toString. Converts this MIME type object to a string.
private static String	Returns: the lowercase version of the string toUnicodeLowerCase(String the string s) Returns a lowercase version of the given string.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

EOF_LEXEME	back to summary
private static final int EOF_LEXEME

ILLEGAL_LEXEME	back to summary
private static final int ILLEGAL_LEXEME

myEntrySet	back to summary
private transient MimeType.ParameterMapEntrySet myEntrySet Parameter map entry set. Computed when needed and cached.

myParameterMap	back to summary
private transient MimeType.ParameterMap myParameterMap Parameter map. Computed when needed and cached.

myPieces	back to summary
private String[] myPieces Array of strings that hold pieces of this MIME type's canonical form. If the MIME type has n parameters, n >= 0, then the strings in the array are: Index 0 -- Media type. Index 1 -- Media subtype. Index 2i+2 -- Name of parameter i, i=0,1,...,n-1. Index 2i+3 -- Value of parameter i, i=0,1,...,n-1. Parameters are arranged in ascending order of parameter name.

myStringValue	back to summary
private transient String myStringValue String value for this MIME type. Computed when needed and cached.

QUOTED_STRING_LEXEME	back to summary
private static final int QUOTED_STRING_LEXEME

serialVersionUID	back to summary
private static final long serialVersionUID Use serialVersionUID from JDK 1.4 for interoperability. Annotations @Serial

TOKEN_LEXEME	back to summary
private static final int TOKEN_LEXEME

TSPECIAL_LEXEME	back to summary
private static final int TSPECIAL_LEXEME

MimeType	back to summary
public MimeType(String s) Construct a new MIME type object from the given string. The given string is converted into canonical form and stored internally. Parameters s:String MIME media type string Exceptions NullPointerException: if `s` is `null` IllegalArgumentException: if `s` does not obey the syntax for a MIME media type string

Method Detail

addQuotes	back to summary
private static String addQuotes(String s) Returns a version of the string surrounded by quotes and with interior quotes preceded by a backslash. Parameters s:String the string Returns:String the string surrounded by quotes and with interior quotes preceded by a backslash

addQuotes

back to summary

private static String addQuotes(String s)

Returns a version of the string surrounded by quotes and with interior quotes preceded by a backslash.

Parameters

s:String: the string

Returns:String

the string surrounded by quotes and with interior quotes preceded by a backslash

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Determine if this MIME type object is equal to the given object. The two are equal if the given object is not `null`, is an instance of class `javax.print.data.MimeType`, and has the same canonical form as this MIME type object (that is, has the same type, subtype, and parameters). Thus, if two MIME type objects are the same except for comments, they are considered equal. However, "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). Parameters obj:Object `object` to test Returns:boolean `true` if this MIME type object equals `obj`, `false` otherwise

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Determine if this MIME type object is equal to the given object. The two are equal if the given object is not null, is an instance of class javax.print.data.MimeType, and has the same canonical form as this MIME type object (that is, has the same type, subtype, and parameters). Thus, if two MIME type objects are the same except for comments, they are considered equal. However, "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).

Parameters

obj:Object: object to test

Returns:boolean

true if this MIME type object equals obj, false otherwise

getMediaSubtype	back to summary
public String getMediaSubtype() Returns this MIME type object's media subtype. Returns:String the media subtype

getMediaSubtype

back to summary

public String getMediaSubtype()

Returns this MIME type object's media subtype.

Returns:String: the media subtype

getMediaType	back to summary
public String getMediaType() Returns this MIME type object's media type. Returns:String the media type

getMediaType

back to summary

public String getMediaType()

Returns this MIME type object's media type.

Returns:String: the media type

getMimeType	back to summary
public String getMimeType() Returns this MIME type object's MIME type string based on the canonical form. Each parameter value is enclosed in quotes. Returns:String the mime type

getMimeType

back to summary

public String getMimeType()

Returns this MIME type object's MIME type string based on the canonical form. Each parameter value is enclosed in quotes.

Returns:String: the mime type

getParameterMap back to summary

getParameterMap	back to summary
public Map<String, String> getParameterMap() Returns an unmodifiable map view of the parameters in this MIME type object. Each entry in the parameter map view consists of a parameter name `String` (key) mapping to a parameter value `String`. If this MIME type object has no parameters, an empty map is returned. Returns:Map<String, String> parameter map for this MIME type object

public Map<String, String> getParameterMap()

Returns an unmodifiable map view of the parameters in this MIME type object. Each entry in the parameter map view consists of a parameter name String (key) mapping to a parameter value String. If this MIME type object has no parameters, an empty map is returned.

Returns:Map<String, String>: parameter map for this MIME type object

getStringValue	back to summary
private String getStringValue() Returns this MIME type's string value in canonical form. Returns:String the MIME type's string value in canonical form

getStringValue

back to summary

private String getStringValue()

Returns this MIME type's string value in canonical form.

Returns:String: the MIME type's string value in canonical form

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this MIME type object.

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this MIME type object.

parse back to summary

parse	back to summary
private void parse(String s) Parses the given string into canonical pieces and stores the pieces in `myPieces`. Special rules applied: If the media type is text, the value of a charset parameter is converted to lowercase. Parameters s:String MIME media type string Exceptions NullPointerException: if `s` is `null` IllegalArgumentException: if `s` does not obey the syntax for a MIME media type string

private void parse(String s)

Parses the given string into canonical pieces and stores the pieces in myPieces.

Special rules applied:

If the media type is text, the value of a charset parameter is converted to lowercase.

Parameters

s:String: MIME media type string

Exceptions

NullPointerException:: if s is null
IllegalArgumentException:: if s does not obey the syntax for a MIME media type string

removeBackslashes	back to summary
private static String removeBackslashes(String s) Returns a version of the given string with backslashes removed. Parameters s:String the string Returns:String the string with backslashes removed

removeBackslashes

back to summary

private static String removeBackslashes(String s)

Returns a version of the given string with backslashes removed.

Parameters

s:String: the string

Returns:String

the string with backslashes removed

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Converts this MIME type object to a string. Returns:String MIME type string based on the canonical form. Each parameter value is enclosed in quotes.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Converts this MIME type object to a string.

Returns:String: MIME type string based on the canonical form. Each parameter value is enclosed in quotes.

toUnicodeLowerCase back to summary

toUnicodeLowerCase	back to summary
private static String toUnicodeLowerCase(String s) Returns a lowercase version of the given string. The lowercase version is constructed by applying `Character.toLowerCase()` to each character of the given string, which maps characters to lowercase using the rules of Unicode. This mapping is the same regardless of locale, whereas the mapping of `String.toLowerCase()` may be different depending on the default locale. Parameters s:String the string Returns:String the lowercase version of the string

private static String toUnicodeLowerCase(String s)

Returns a lowercase version of the given string. The lowercase version is constructed by applying Character.toLowerCase() to each character of the given string, which maps characters to lowercase using the rules of Unicode. This mapping is the same regardless of locale, whereas the mapping of String.toLowerCase() may be different depending on the default locale.

Parameters

s:String: the string

Returns:String

the lowercase version of the string

javax.print back to summary

private Class MimeType.LexicalAnalyzer

Class Inheritance

extends Object

java.lang.Object
javax.print.MimeType.LexicalAnalyzer

Class for a lexical analyzer.

Field Summary

Modifier and Type	Field and Description
protected int	myCurrentIndex
protected int	myLexemeBeginIndex
protected int	myLexemeEndIndex
protected int	myLexemeType
protected String	mySource
protected int	mySourceLength

Constructor Summary

Access	Constructor and Description
public	LexicalAnalyzer(String theSource)

Method Summary

Modifier and Type	Method and Description
public String	getLexeme()
public char	getLexemeFirstCharacter()
public int	getLexemeType()
public void	nextLexeme()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

myCurrentIndex	back to summary
protected int myCurrentIndex

myLexemeBeginIndex	back to summary
protected int myLexemeBeginIndex

myLexemeEndIndex	back to summary
protected int myLexemeEndIndex

myLexemeType	back to summary
protected int myLexemeType

mySource	back to summary
protected String mySource

mySourceLength	back to summary
protected int mySourceLength

Constructor Detail

LexicalAnalyzer	back to summary
public LexicalAnalyzer(String theSource)

Method Detail

getLexeme	back to summary
public String getLexeme()

getLexemeFirstCharacter	back to summary
public char getLexemeFirstCharacter()

getLexemeType	back to summary
public int getLexemeType()

nextLexeme	back to summary
public void nextLexeme()

javax.print back to summary

private Class MimeType.ParameterMap

Class Inheritance

extends AbstractMap<String, String>

java.lang.Object
java.util.AbstractMap
javax.print.MimeType.ParameterMap

Parameter map.

Constructor Summary

Access	Constructor and Description
private	ParameterMap()

Method Summary

Modifier and Type	Method and Description
public Set<Map.Entry<String, String>>	entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map.

Inherited from java.util.AbstractMap:: clear clone containsKey containsValue equals get hashCode isEmpty keySet put putAll remove size toString values

Constructor Detail

ParameterMap	back to summary
private ParameterMap()

Method Detail

entrySet back to summary

entrySet	back to summary
public Set<Map.Entry<String, String>> entrySet() Implements abstract java.util.AbstractMap.entrySet. Implements java.util.Map.entrySet. Doc from java.util.Map.entrySet. Returns a `Set` view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own `remove` operation, or through the `setValue` operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the `Iterator.remove`, `Set.remove`, `removeAll`, `retainAll` and `clear` operations. It does not support the `add` or `addAll` operations.

public Set<Map.Entry<String, String>> entrySet()

Implements abstract java.util.AbstractMap.entrySet.

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

javax.print back to summary

private Class MimeType.ParameterMapEntry

Class Inheritance

extends Object
implements Map.Entry<String, String>

java.lang.Object
javax.print.MimeType.ParameterMapEntry

All Implemented Interfaces

java.util.Map.Entry

Parameter map entry.

Field Summary

Modifier and Type	Field and Description
private int	myIndex The index of the entry.

Constructor Summary

Access	Constructor and Description
public	ParameterMapEntry(int the index of the entry theIndex) Constructs a new parameter map entry.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Implements java.util.Map.Entry.equals. Compares the specified object with this entry for equality.
public String	getKey() Implements java.util.Map.Entry.getKey. Returns the key corresponding to this entry.
public String	getValue() Implements java.util.Map.Entry.getValue. Returns the value corresponding to this entry.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements java.util.Map.Entry.hashCode. Returns the hash code value for this map entry.
public String	setValue(String value) Implements java.util.Map.Entry.setValue. Replaces the value corresponding to this entry with the specified value (optional operation).

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

myIndex	back to summary
private int myIndex The index of the entry.

Constructor Detail

ParameterMapEntry	back to summary
public ParameterMapEntry(int theIndex) Constructs a new parameter map entry. Parameters theIndex:int the index of the entry

ParameterMapEntry

back to summary

public ParameterMapEntry(int theIndex)

Constructs a new parameter map entry.

Parameters

theIndex:int: the index of the entry

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.util.Map.Entry.equals.

Doc from java.util.Map.Entry.equals.

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries represent the same mapping. More formally, two entries e1 and e2 represent the same mapping if

    (e1.getKey()==null ?
     e2.getKey()==null : e1.getKey().equals(e2.getKey()))  &&
    (e1.getValue()==null ?
     e2.getValue()==null : e1.getValue().equals(e2.getValue()))

This ensures that the equals method works properly across different implementations of the Map.Entry interface.

getKey

back to summary

public String getKey()

Implements java.util.Map.Entry.getKey.

Doc from java.util.Map.Entry.getKey.

Returns the key corresponding to this entry.

getValue back to summary

public String getValue()

Implements java.util.Map.Entry.getValue.

Doc from java.util.Map.Entry.getValue.

Returns the value corresponding to this entry. If the mapping has been removed from the backing map (by the iterator's remove operation), the results of this call are undefined.

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.Entry.hashCode.

Doc from java.util.Map.Entry.hashCode.

Returns the hash code value for this map entry. The hash code of a map entry e is defined to be:

    (e.getKey()==null   ? 0 : e.getKey().hashCode()) ^
    (e.getValue()==null ? 0 : e.getValue().hashCode())

This ensures that e1.equals(e2) implies that e1.hashCode()==e2.hashCode() for any two Entries e1 and e2, as required by the general contract of Object.hashCode.

setValue back to summary

public String setValue(String value)

Implements java.util.Map.Entry.setValue.

Doc from java.util.Map.Entry.setValue.

Replaces the value corresponding to this entry with the specified value (optional operation). (Writes through to the map.) The behavior of this call is undefined if the mapping has already been removed from the map (by the iterator's remove operation).

javax.print back to summary

private Class MimeType.ParameterMapEntrySet

Class Inheritance

extends AbstractSet<Map.Entry<String, String>>

java.lang.Object
java.util.AbstractCollection
java.util.AbstractSet
javax.print.MimeType.ParameterMapEntrySet

Parameter map entry set.

Constructor Summary

Access	Constructor and Description
private	ParameterMapEntrySet()

Method Summary

Modifier and Type	Method and Description
public Iterator<Map.Entry<String, String>>	iterator() Implements abstract java.util.AbstractCollection.iterator. Implements java.util.Set.iterator, java.util.Collection.iterator. Returns an iterator over the elements in this set.
public int	size() Implements abstract java.util.AbstractCollection.size. Implements java.util.Set.size, java.util.Collection.size. Returns the number of elements in this set (its cardinality).

Inherited from java.util.AbstractSet:: equals hashCode removeAll

Constructor Detail

ParameterMapEntrySet	back to summary
private ParameterMapEntrySet()

Method Detail

iterator

back to summary

public Iterator<Map.Entry<String, String>> iterator()

Implements abstract java.util.AbstractCollection.iterator.

Implements java.util.Set.iterator, java.util.Collection.iterator.

Doc from java.util.Set.iterator.

Returns an iterator over the elements in this set. The elements are returned in no particular order (unless this set is an instance of some class that provides a guarantee).

size back to summary

public int size()

Implements abstract java.util.AbstractCollection.size.

Implements java.util.Set.size, java.util.Collection.size.

Doc from java.util.Set.size.

Returns the number of elements in this set (its cardinality). If this set contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

javax.print back to summary

private Class MimeType.ParameterMapEntrySetIterator

Class Inheritance

extends Object
implements Iterator<Map.Entry<String, String>>

java.lang.Object
javax.print.MimeType.ParameterMapEntrySetIterator

All Implemented Interfaces

java.util.Iterator

Parameter map entry set iterator.

Field Summary

Modifier and Type	Field and Description
private int	myIndex The current index of the iterator.

Constructor Summary

Access	Constructor and Description
private	ParameterMapEntrySetIterator()

Method Summary

Modifier and Type	Method and Description
public boolean	hasNext() Implements java.util.Iterator.hasNext. Returns `true` if the iteration has more elements.
public Map.Entry<String, String>	next() Implements java.util.Iterator.next. Returns the next element in the iteration.
public void	remove() Overrides default java.util.Iterator.remove. Removes from the underlying collection the last element returned by this iterator (optional operation).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

myIndex	back to summary
private int myIndex The current index of the iterator.

Constructor Detail

ParameterMapEntrySetIterator	back to summary
private ParameterMapEntrySetIterator()

Method Detail

hasNext back to summary

public boolean hasNext()

Implements java.util.Iterator.hasNext.

Doc from java.util.Iterator.hasNext.

Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

back to summary

public Map.Entry<String, String> next()

Implements java.util.Iterator.next.

Doc from java.util.Iterator.next.

Returns the next element in the iteration.

remove back to summary

public void remove()

Overrides default java.util.Iterator.remove.

Doc from java.util.Iterator.remove.

Removes from the underlying collection the last element returned by this iterator (optional operation). This method can be called only once per call to next.

The behavior of an iterator is unspecified if the underlying collection is modified while the iteration is in progress in any way other than by calling this method, unless an overriding class has specified a concurrent modification policy.

The behavior of an iterator is unspecified if this method is called after a call to the forEachRemaining method.

pack-priv Class MimeType

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MimeType.LexicalAnalyzer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MimeType.ParameterMap

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MimeType.ParameterMapEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class MimeType.ParameterMapEntrySet

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class MimeType.ParameterMapEntrySetIterator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail