org.dmfs.httpclientinterfaces

Class ContentType

java.lang.Object

org.dmfs.httpclientinterfaces.ContentType

public final class ContentType
extends java.lang.Object

Wrapper for content types as defined in RFC 2045 Section 5

At present this class doesn't support multiple parameters with the same name. Each occurrence of a key will override any previous occurrences of the same key.

ContentTypes are immutable. To derive a new ContentType with different parameters from an existing one use ContentType(ContentType, Parameter...).

Note that equals(Object) returns true for two ContentTypes if mainType and subType equal. Parameters are not taken into account. Use same(ContentType) to take parameters into account when comparing two ContentTypes.

TODO: make this an interface

Author:

Marten Gajda

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentType.Parameter A content type parameter as defined in RFC 2045 Section 5.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	mainType The main type of the content type.
java.lang.String	subType The sub-type of the content type.
java.lang.String	type The content type as maintype/subtype.

Constructor Summary

Constructors

Constructor and Description
ContentType(ContentType contentType, ContentType.Parameter... params) Clone constructor that adds/overrides ContentType.Parameters.
ContentType(java.lang.String contentType) Create a new ContentType from a content type string.
ContentType(java.lang.String contentType, ContentType.Parameter... params) Creates a new ContentType object from the given string representation, while adding or overriding ContentType.Parameters.

Method Summary

Modifier and Type	Method and Description
static ContentType.Parameter	CharSet(java.lang.String charset)
boolean	equals(java.lang.Object obj)
boolean	equalsAny(ContentType... contentTypes) Returns whether this ContentType equals any of the given content types.
java.lang.String	getCharset() Returns the value of the charset parameter or null if there is no charset parameter.
java.lang.String	getCharset(java.lang.String defaultCharset) Returns the value of the charset parameter or default if there is no charset parameter.
int	hashCode()
boolean	isAnySubType()
boolean	isAnyType()
boolean	matches(ContentType other) Checks if another content type matches this content type.
ContentType.Parameter	param(java.lang.String key) Return the parameter value for a specific key.
boolean	same(ContentType other) Indicates whether another ContentType is the same as this one.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

type

public final java.lang.String type

The content type as maintype/subtype.

mainType

public final java.lang.String mainType

The main type of the content type.

subType

public final java.lang.String subType

The sub-type of the content type.

Constructor Detail

ContentType

public ContentType(java.lang.String contentType)

Create a new ContentType from a content type string. If contentType is null type, mainType and subType will be null.

Parameters:

contentType - The content type string to parse.

ContentType

public ContentType(java.lang.String contentType,
                   ContentType.Parameter... params)

Creates a new ContentType object from the given string representation, while adding or overriding ContentType.Parameters.

Parameters:

contentType - A string representation of a content-type.

params - ContentType.Parameters to add or override.

ContentType

public ContentType(ContentType contentType,
                   ContentType.Parameter... params)

Clone constructor that adds/overrides ContentType.Parameters.

Parameters:

contentType - The original content type.

params - The ContentType.Parameters to add or override.

Method Detail

param

public ContentType.Parameter param(java.lang.String key)

Return the parameter value for a specific key.

Parameters:

key - The key of the parameter.

Returns:

The value String.

getCharset

public java.lang.String getCharset()

Returns the value of the charset parameter or null if there is no charset parameter.

Returns:

A String containing the charset or null.

getCharset

public java.lang.String getCharset(java.lang.String defaultCharset)

Returns the value of the charset parameter or default if there is no charset parameter.

Returns:

A String containing the charset.

isAnySubType

public boolean isAnySubType()

isAnyType

public boolean isAnyType()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

CharSet

public static ContentType.Parameter CharSet(java.lang.String charset)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsAny

public boolean equalsAny(ContentType... contentTypes)

Returns whether this ContentType equals any of the given content types.

Parameters:

contentTypes - Non-empty list of other ContentTypes.

Returns:

true if this equals one of the given ContentTypes, false otherwise.

same

public boolean same(ContentType other)

Indicates whether another ContentType is the same as this one. In contrast to equals(Object) this also takes any parameters into account.

Parameters:

other - The other ContentType.

Returns:

true if maintype, subtype and parameters of both content-types equal.

matches

public boolean matches(ContentType other)

Checks if another content type matches this content type. The result is like equals(Object) returns it, except that this method honors place holders in this instance. Parameters are not taken into account.

Parameters:

other - The ContentType to match.

Returns:

If the other ContentType matches this content type.