com.phloc.commons.mime

Class MimeTypeParameter

java.lang.Object

com.phloc.commons.mime.MimeTypeParameter

All Implemented Interfaces:

Serializable

@Immutable
public class MimeTypeParameter
extends Object
implements Serializable

This class represents a single MIME type parameter.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MimeTypeParameter(String sAttribute, String sValue) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAttribute()
String	getValue()
String	getValueQuotedIfNecessary(EMimeQuoting eQuotingAlgorithm)
int	hashCode()
boolean	isValueRequiringQuoting()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MimeTypeParameter

public MimeTypeParameter(@Nonnull@Nonempty
                 String sAttribute,
                 @Nonnull@Nonempty
                 String sValue)

Constructor.

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.

Method Detail

getAttribute

@Nonnull
@Nonempty
public String getAttribute()

Returns:

The parameter name. Neither null nor empty and confirmed to be a valid MIME token.

getValue

@Nonnull
@Nonempty
public String getValue()

Returns:

The value of the parameter. Neither null nor empty. No quoting or escaping is applied to this value!

isValueRequiringQuoting

public boolean isValueRequiringQuoting()

Returns:

true if the value required quoting/escaping. This is determined by checking, if the value is a valid MIME token in which case no quoting is necessary.

getValueQuotedIfNecessary

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

Parameters:

eQuotingAlgorithm - The quoting algorithm to be used. May not be null.

Returns:

The value of the parameter. Neither null nor empty. If necessary, quoting is applied according to the passed algorithm.

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