dk.heick.properties.types

Class MimeTypePropertyType

java.lang.Object

dk.heick.properties.PropertyType<MimeType>

dk.heick.properties.types.MimeTypePropertyType

All Implemented Interfaces:

Serializable

public class MimeTypePropertyType
extends PropertyType<MimeType>

PropertyType that validates to a MimeType value.
The string is trimmed before validation.
This type convert and validates a string to a javax.activation.MimeType.
IMPORTANT: MimeType has not implemented the equals method properly (as I see it) since it is not overloaded in the MimeType class.
To make a valid equals use aMimeType.match(bMimeType).
A list of all known MimeTypes is present in the enum "ContentType".

Constructor Example			Comments
Property<MimeType> A_PROPERTY = new Property<MimeType>("name", new MimeTypePropertyType());			Default value is null.
Property<MimeType> A_PROPERTY = new Property<MimeType>("name", new MimeTypePropertyType(new MimeType("text/html")));			Default value is new MimeType("text/html").
Type of value(s)	Examples	Result	Comments
Valid	text/html	ew MimeType("text/html")	Validate successfully.
Invalid	cow	null		Validate will throw an exception. The resulting value is null.
Invalid	«only spaces»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.9

Version:

1.1

Author:

Frederik Heick

See Also:

ContentType, ContentType.getAsMimeType(), ContentType.parse(String), ContentType.convert(MimeType), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE The type name string constant of MimeTypePropertyType.

Constructor Summary

Constructors

Constructor and Description
MimeTypePropertyType() Default constructor, with null as default value.
MimeTypePropertyType(MimeType defaultValue) Constructor.
MimeTypePropertyType(String defaultValue) Constructor, using a string as default value.

Method Summary

Modifier and Type	Method and Description
static boolean	equalsMimeType(MimeType mt1, MimeType mt2) Since MimType do not implements a property Equals method.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
MimeType	validateValue(String propertyName, String value) Validates the MimeType using the new MimeType(rawvalue) method.

Methods inherited from class dk.heick.properties.PropertyType

equals, getDefaultValue, getDefaultValueAsString, getDefaultValueDescription, getDescription, getDescription, getInitializationPriority, getIo, getLogger, getTypeName, hasDefaultValue, isDefaultValueValid, postGetValueProcessing, setDefaultValue, setInitializationPriority, setIo, setTypedValue, setTypeName, toString, toType, validate, validateConstraints, validateNullType

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

The type name string constant of MimeTypePropertyType.

See Also:

Constant Field Values

Constructor Detail

MimeTypePropertyType

public MimeTypePropertyType()

Default constructor, with null as default value.

MimeTypePropertyType

public MimeTypePropertyType(MimeType defaultValue)

Constructor.

Parameters:

defaultValue - the default MimeType value.

MimeTypePropertyType

public MimeTypePropertyType(String defaultValue)

Constructor, using a string as default value.

Parameters:

defaultValue - the default value as String, if not valid an error is logged and null used.

Method Detail

getRestrictions

public List<String> getRestrictions()

Description copied from class: PropertyType

Gets a detailed description of the PropertyType with any constraints that might influence the validation.
This includes a description for the default value, if the default do not it self parse the validation of the type, the exception is appended to the description.

Specified by:

getRestrictions in class PropertyType<MimeType>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public MimeType validateValue(String propertyName,
                              String value)
                       throws PropertyException

Validates the MimeType using the new MimeType(rawvalue) method.

Specified by:

validateValue in class PropertyType<MimeType>

Parameters:

propertyName - the name of the property used for logging purposes. To uniquely identify the Property with validation issues.

value - the string representation of the property

Returns:

the typed converted value.

Throws:

PropertyException - if the conversion failed.

See Also:

MimeType.MimeType(String)

equalsMimeType

public static boolean equalsMimeType(MimeType mt1,
                                     MimeType mt2)

Since MimType do not implements a property Equals method. Here is a method for it.

Parameters:

mt1 -

mt2 -

Returns:

true if both mt1 and mt2 is null, false if either is null, otherwise a match is returned.

See Also:

MimeType.match(MimeType)