dk.heick.properties.types

Class CountryPropertyType

java.lang.Object

dk.heick.properties.PropertyType<Locale>

dk.heick.properties.types.CountryPropertyType

All Implemented Interfaces:

Serializable

public class CountryPropertyType
extends PropertyType<Locale>

PropertyType that validates to a Locale value only based on country code.
It will look through the list of available Locales, and choose the first with country.
The value must be not-null and not-empty (trimmed).
This means that if a default Locale is set to the Property it must be a Locale where the Country is not-null and none-empty.
The comparison is not case sensitive.

This type convert and validates a string to a java.util.Locale.
IMPORTANT: When using Locale to only store Country infomation, then there is no quaranty that (locale.equals) will work.
To be sure use aLocale.getCountry().equals(bLocale.getCountry()).

Constructor Example			Comments
Property<Locale> A_PROPERTY = new Property<Locale>("name", new CountryPropertyType());			Creates LocalePropertyType with no default value.
Property<Locale> A_PROPERTY = new Property<Locale>("name", new CountryPropertyType(Locale.ENGLISH));			Creates LocalePropertyType with default value "Locale.ENGLISH".
Type of value(s)	Examples	Result	Comments
Valid	DK	new Locale("da","DK")	Validate successfully.
Valid	us	new Locale("en","us")	Validate successfully.
Invalid	cow	null	Validate will throw an exception. The resulting value is null.
Invalid	«empty string»	null
Invalid	«empty string after trim»	null
Invalid	null	defaultValue OR null	Validate will throw an exception. Return default value if set, otherwise null.

Since:

1.8

Author:

Frederik Heick

See Also:

Locale.getAvailableLocales(), Locale, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CountryPropertyType() Default constructor, with null as default value.
CountryPropertyType(Locale defaultValue) Constructor.

Method Summary

Modifier and Type	Method and Description
static String[]	getAvailableCountries() Get a list of all countries from "Locale.getAvailableLocales()" which is not empty.
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
String	toString(String propertyName, Locale t) Converts a typed to the string representation.
void	validateConstraints(String propertyName) A PropertyType can have some constraints here is where they are validated.
Locale	validateValue(String propertyName, String value) Converts the string representation of to a typed value.

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, toType, validate, 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 ClassnamePropertyType.

See Also:

Constant Field Values

Constructor Detail

CountryPropertyType

public CountryPropertyType()

Default constructor, with null as default value.

CountryPropertyType

public CountryPropertyType(Locale defaultValue)

Constructor.

Parameters:

defaultValue - default value returned if property value is undefined.

Method Detail

toString

public String toString(String propertyName,
                       Locale t)
                throws PropertyException

Description copied from class: PropertyType

Converts a typed to the string representation. This must be associative, so the string generate here will successful validate. This is enforced, so the converted string is sub sequencetially validate with the validate method. In some of the property sub types, this method is overridden to ensure above rule.

Overrides:

toString in class PropertyType<Locale>

Parameters:

propertyName - the name of the property used for logging purposes.

t - the type T.

Returns:

The string representation of the type.

Throws:

PropertyException - if conversion failed in validation.

See Also:

PropertyType.validate(String, String)

validateConstraints

public void validateConstraints(String propertyName)
                         throws PropertyException

Description copied from class: PropertyType

A PropertyType can have some constraints here is where they are validated.
The constraints of a PropertyType is always assumed to be valid, but what if they are not.
Example: What if you have define the MIN value to be larger than the MAX value. The result will be that no value will ever be validated successfully.
This is the method where we validate the constraints of a PropertyType before any value is actually validated.
Any many cases this will not be nessecary.
This method is call in Property.validate();

Overrides:

validateConstraints in class PropertyType<Locale>

Parameters:

propertyName - the name of the property used for logging purposes, to identify the unique property which PropertyType has constraint issues.

Throws:

PropertyException - if the constraints have invalid/conflicting values.

See Also:

Property.validate()

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<Locale>

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

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

Description copied from class: PropertyType

Converts the string representation of to a typed value.
Including validation of any restrictions the PropertyType might have.
See the individual property type class description for details on how it convert to a typed value.

IMPORTANT: This only validates the value not the constraints of the PropertyType, which is at this point assumed to be valid.

Specified by:

validateValue in class PropertyType<Locale>

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.

getAvailableCountries

public static final String[] getAvailableCountries()

Get a list of all countries from "Locale.getAvailableLocales()" which is not empty.

Returns:

a sorted list of countries, lowercased

See Also:

Locale.getAvailableLocales()