com.helger.commons.mime

Class MimeType

java.lang.Object

com.helger.commons.mime.MimeType

All Implemented Interfaces:

ICloneable<IMimeType>, IHasStringRepresentation, IMimeType, Serializable, Comparable<MimeType>

@NotThreadSafe
public class MimeType
extends Object
implements IMimeType, Comparable<MimeType>

Represents a single MIME type as the combination of the content type and the sub-type and parameters.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MimeType(EMimeContentType eContentType, String sContentSubType) Constructor without parameters.
MimeType(EMimeContentType eContentType, String sContentSubType, Collection<? extends MimeTypeParameter> aParameters) Constructor without parameters.
MimeType(IMimeType aOther) Kind of a copy constructor

Method Summary

Methods

Modifier and Type	Method and Description
MimeType	addParameter(MimeTypeParameter aParameter) Add a parameter.
MimeType	addParameter(String sAttribute, String sValue) Add a parameter.
int	compareTo(MimeType o)
boolean	equals(Object o)
List<MimeTypeParameter>	getAllParameters()
String	getAsString() Get the MIME type including all parameters as a single string.
String	getAsString(EMimeQuoting eQuotingAlgorithm) Get the MIME type including all parameters as a single string.
String	getAsStringWithoutParameters()
MimeType	getClone()
String	getContentSubType()
EMimeContentType	getContentType()
MimeType	getCopyWithoutParameters()
MimeTypeParameter	getParameterAtIndex(int nIndex) Get the parameter at the specified index.
int	getParameterCount()
String	getParametersAsString(EMimeQuoting eQuotingAlgorithm) Get all MIME type parameters as a single string but without the leading content and sub type.
String	getParameterValueWithName(String sParamName) Get the value of the parameter with the specified name.
MimeTypeParameter	getParameterWithName(String sParamName) Get the parameter with the specified name.
boolean	hasAnyParameters()
int	hashCode()
boolean	hasParameterWithName(String sParamName) Check if a parameter with the specified name is present.
EChange	removeAllParameters() Remove all existing parameters.
EChange	removeParameter(MimeTypeParameter aParameter) Remove the specified parameter from this MIME type.
EChange	removeParameterAtIndex(int nIndex) Remove the parameter at the specified index.
EChange	removeParameterWithName(String sParamName) Remove the parameter with the specified name.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeType

public MimeType(@Nonnull
        IMimeType aOther)

Kind of a copy constructor

Parameters:

aOther - The other object to copy the data from

MimeType

public MimeType(@Nonnull
        EMimeContentType eContentType,
        @Nonnull@Nonempty
        String sContentSubType)

Constructor without parameters. To construct the MIME type "text/xml" you need to pass EMimeContentType.TEXT and the String "xml" to this constructor.

Parameters:

eContentType - MIME content type. May not be null.

sContentSubType - MIME content sub type. May neither be null nor empty.

MimeType

public MimeType(@Nonnull
        EMimeContentType eContentType,
        @Nonnull@Nonempty
        String sContentSubType,
        @Nullable
        Collection<? extends MimeTypeParameter> aParameters)

Constructor without parameters. To construct the MIME type "text/xml" you need to pass EMimeContentType.TEXT and the String "xml" to this constructor.

Parameters:

eContentType - MIME content type. May not be null.

sContentSubType - MIME content sub type. May neither be null nor empty.

aParameters - MIME type parameters. May be null or empty.

Method Detail

getContentType

@Nonnull
public EMimeContentType getContentType()

Specified by:

getContentType in interface IMimeType

Returns:

The content type. Never null.

getContentSubType

@Nonnull
@Nonempty
public String getContentSubType()

Specified by:

getContentSubType in interface IMimeType

Returns:

The content sub type. Never null.

getAsString

@Nonnull
@Nonempty
public String getAsString()

Description copied from interface: IMimeType

Get the MIME type including all parameters as a single string. By default the CMimeType.DEFAULT_QUOTING quoting algorithm is used.

Specified by:

getAsString in interface IHasStringRepresentation

Specified by:

getAsString in interface IMimeType

Returns:

The combined string to be used as text representation: contentType '/' subType ( ';' parameterName '=' parameterValue )*

See Also:

IMimeType.getAsString(EMimeQuoting), IMimeType.getAsStringWithoutParameters()

getAsString

@Nonnull
@Nonempty
public String getAsString(@Nonnull
                                  EMimeQuoting eQuotingAlgorithm)

Description copied from interface: IMimeType

Get the MIME type including all parameters as a single string. The specified quoting algorithm is used to quote parameter values (if necessary).

Specified by:

getAsString in interface IMimeType

Parameters:

eQuotingAlgorithm - Quoting algorithm to be used

Returns:

The combined string to be used as text representation: contentType '/' subType ( ';' parameterName '=' parameterValue )*

See Also:

IMimeType.getAsStringWithoutParameters(), IMimeType.getParametersAsString(EMimeQuoting)

getAsStringWithoutParameters

@Nonnull
public String getAsStringWithoutParameters()

Specified by:

getAsStringWithoutParameters in interface IMimeType

Returns:

The combined string to be used as text representation but without the parameters: contentType '/' subType

See Also:

IMimeType.getAsString()

getParametersAsString

@Nonnull
public String getParametersAsString(@Nonnull
                                   EMimeQuoting eQuotingAlgorithm)

Description copied from interface: IMimeType

Get all MIME type parameters as a single string but without the leading content and sub type. The specified quoting algorithm is used to quote parameter values.

Specified by:

getParametersAsString in interface IMimeType

Parameters:

eQuotingAlgorithm - Quoting algorithm to be used

Returns:

The combined string to be used as text representation: (';' parameterName '=' parameterValue )* . If no parameters are present, an empty String is returned!

See Also:

IMimeType.getAsString(EMimeQuoting), IMimeType.getAsStringWithoutParameters()

addParameter

@Nonnull
public MimeType addParameter(@Nonnull@Nonempty
                            String sAttribute,
                            @Nonnull@Nonempty
                            String sValue)

Add a parameter.

Parameters:

sAttribute - Parameter name. Must neither be null nor empty and must match MimeTypeParser.isToken(String).

sValue - The value to use. May neither be null nor empty. Must not be a valid MIME token.

Returns:

this

addParameter

@Nonnull
public MimeType addParameter(@Nonnull
                            MimeTypeParameter aParameter)

Add a parameter.

Parameters:

aParameter - The parameter to be added. May not be null.

Returns:

this

removeParameter

@Nonnull
public EChange removeParameter(@Nullable
                              MimeTypeParameter aParameter)

Remove the specified parameter from this MIME type.

Parameters:

aParameter - The parameter to be removed. May be null.

Returns:

EChange.CHANGED if removal was successful

removeParameterAtIndex

@Nonnull
public EChange removeParameterAtIndex(int nIndex)

Remove the parameter at the specified index.

Parameters:

nIndex - The index to remove. Should be ≥ 0.

Returns:

EChange.CHANGED if removal was successful

removeAllParameters

@Nonnull
public EChange removeAllParameters()

Remove all existing parameters.

Returns:

EChange.CHANGED if at least one parameter was present

removeParameterWithName

@Nonnull
public EChange removeParameterWithName(@Nullable
                                      String sParamName)

Remove the parameter with the specified name.

Parameters:

sParamName - The name of the parameter to remove. May be null.

Returns:

EChange.CHANGED if the parameter was removed, EChange.UNCHANGED otherwise.

hasAnyParameters

public boolean hasAnyParameters()

Specified by:

hasAnyParameters in interface IMimeType

Returns:

true if at least one parameter is present, false if no parameter is present.

getParameterCount

@Nonnegative
public int getParameterCount()

Specified by:

getParameterCount in interface IMimeType

Returns:

The number of parameters. Alway ≥ 0.

getAllParameters

@Nonnull
@ReturnsMutableCopy
public List<MimeTypeParameter> getAllParameters()

Specified by:

getAllParameters in interface IMimeType

Returns:

All present parameters. May not be null but empty.

getParameterAtIndex

@Nullable
public MimeTypeParameter getParameterAtIndex(@Nonnegative
                                             int nIndex)

Description copied from interface: IMimeType

Get the parameter at the specified index.

Specified by:

getParameterAtIndex in interface IMimeType

Parameters:

nIndex - The index to use. Should be ≥ 0.

Returns:

null if the provided index is illegal.

hasParameterWithName

public boolean hasParameterWithName(@Nullable
                           String sParamName)

Description copied from interface: IMimeType

Check if a parameter with the specified name is present. The names are matched case sensitive!

Specified by:

hasParameterWithName in interface IMimeType

Parameters:

sParamName - The parameter name to search. May be null.

Returns:

true if such a parameter exists.

getParameterWithName

@Nullable
public MimeTypeParameter getParameterWithName(@Nullable
                                              String sParamName)

Description copied from interface: IMimeType

Get the parameter with the specified name. The names are matched case sensitive!

Specified by:

getParameterWithName in interface IMimeType

Parameters:

sParamName - The parameter name to search. May be null.

Returns:

null if no such parameter exists.

getParameterValueWithName

@Nullable
public String getParameterValueWithName(@Nullable
                                        String sParamName)

Description copied from interface: IMimeType

Get the value of the parameter with the specified name. The names are matched case sensitive!

Specified by:

getParameterValueWithName in interface IMimeType

Parameters:

sParamName - The parameter name to search. May be null.

Returns:

null if no such parameter exists.

getClone

@Nonnull
public MimeType getClone()

Specified by:

getClone in interface ICloneable<IMimeType>

Returns:

A 100% deep-copy of the implementing class.

getCopyWithoutParameters

@Nonnull
public MimeType getCopyWithoutParameters()

Specified by:

getCopyWithoutParameters in interface IMimeType

Returns:

A copy of this MIME type but only the content type and the sub type. This method must even deliver a copy if no parameter are present! May not return null.

compareTo

public int compareTo(MimeType o)

Specified by:

compareTo in interface Comparable<MimeType>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object