ListPropertyType (JHPropertiesTyped

java.lang.Object
- dk.heick.properties.PropertyType<List<T>>
- - dk.heick.properties.types.ListPropertyType<T>

Type Parameters:: T - the class type which the PropertyType in the list converts to.

All Implemented Interfaces:: MarkerListPropertyType, MarkerSubPropertyType, Serializable

public class ListPropertyType<T>
extends PropertyType<List<T>>
implements MarkerListPropertyType, MarkerSubPropertyType

Holds a list of another PropertyType.
The default value for the type is a bit special, since this new ArrayList<T>(), where it is usually null.

When validating there are 3 different ways this can turn out.

If the value is null, a PropertyException is thrown.
If the value is an empty string and minLength is 0, than a empty List is returned.
Otherwise the value is split with the divider and the individual tokens is validated by the PropertyType.

Constructor Example			Comments
Property<List<URL>> P_LIST_URLS = new Property<List<URL>>("p.list.urls", new ListPropertyType<URL>(new URLPropertyType("http")));			Creates ListPropertyType to hold a list of URLs which uses the protocol "http" no minimum or maximum number of elements restrictions. No default value.
Property<List<Date>> P_LIST_DATES = new Property<List<Date>>("p.list.urls", new ListPropertyType<URL>(new DateTimePropertyType(),2,6));			Creates ListPropertyType to hold a list of Dates, with minimum 2 elements and maximum 6 elements (both inclusive).
Type of value(s)	Examples	Result	Comments
Valid	http://www.jp.dk;http://www.cnn.com	List of : new URL("http://www.jp.dk") ; new URL("http://www.cnn.com")	Validate successfully.
Valid	«empty string»	Empty list.	Validate successfully.
Invalid	http://www.jp.dk;NOT_AN_URL;http://www.cnn.com	`null`	Validate will throw an exception. The resulting value is `null`.
Invalid	`null`	`null`	Validate will throw an exception. Return default value if set, otherwise `null`.

Since:: 1.1
Author:: Frederik Heick
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_DIVIDER` The default string divider between elements in the list.
`static String`	`TYPE` The type name string constant of ListPropertyType

Constructor Summary

Constructors
Constructor and Description
`ListPropertyType(PropertyType<T> propertyType)` Returns a `ListPropertyType` that can hold a list of `propertyType` using DEFAULT_DIVIDER, with default value of an empty list and no constraints on minimum or maximum elements in the list.
`ListPropertyType(PropertyType<T> propertyType, Integer minLength)` Returns a `ListPropertyType` that can hold a list of `propertyType` using DEFAULT_DIVIDER, with default value of an empty list and no constraints on maximum elements in the list.
`ListPropertyType(PropertyType<T> propertyType, Integer minLength, Integer maxLength)` Returns a `ListPropertyType` that can hold a list of `propertyType` using DEFAULT_DIVIDER, with default value of an empty list and no constraints on maximum elements in the list.
`ListPropertyType(PropertyType<T> propertyType, List<T> defaultValue)` Returns a `ListPropertyType` that can hold a list of `propertyType` using DEFAULT_DIVIDER, and no constraints on minimum or maximum elements in the list.
`ListPropertyType(PropertyType<T> propertyType, List<T> defaultValue, Integer minLength)` Returns a `ListPropertyType` that can hold a list of `propertyType` using DEFAULT_DIVIDER, no constraints on maximum elements in the list.
`ListPropertyType(PropertyType<T> propertyType, List<T> defaultValue, String divider, Integer minLength, Integer maxLength)` Returns a `ListPropertyType` that can hold a list of `propertyType` using provided divider and an constraint on the minimum and maximum elements in their must be in the list, and a default value of an empty list.
`ListPropertyType(PropertyType<T> propertyType, String divider)` Returns a `ListPropertyType` that can hold a list of `propertyType` using provided divider, with no default value of an empty list and no constraints on minimum or maximum elements in the list.
`ListPropertyType(PropertyType<T> propertyType, String divider, Integer minLength)` Returns a `ListPropertyType` that can hold a list of `propertyType` using provided divider and an constraint on the minimum elements in their must be in the list, and a default value of an empty list.
`ListPropertyType(PropertyType<T> propertyType, String divider, Integer minLength, Integer maxLength)` Returns a `ListPropertyType` that can hold a list of `propertyType` using provided divider and an constraint on the minimum elements in their must be in the list, and a default value of an empty list.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDivider()` Gets the string divider, which splits up the elements in the string.
`Integer`	`getMaxNumberOfElements()` The minimum elements their must be in the list.
`Integer`	`getMinNumberOfElements()` The maximum elements allowed in the list
`PropertyType<T>`	`getPropertyType()` The PropertyType which all the elements must validate to.
`List<String>`	`getRestrictions()` Gets a detailed description of the PropertyType with any constraints that might influence the validation.
`boolean`	`isUseMaxNumberOfElements()` Determines if there are maximum element count constraints.
`boolean`	`isUseMinNumberOfElements()` Determine if there are minimum element count constraints.
`void`	`setPropertyType(PropertyType<T> propertyType)`
`String`	`toString(String propertyName, List<T> t)` Converts a typed to the string representation.
`void`	`validateConstraints(String propertyName)` A PropertyType can have some constraints here is where they are validated.
`List<T>`	`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 ListPropertyType
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DIVIDER
```
public static final String DEFAULT_DIVIDER
```
    The default string divider between elements in the list.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType)
```
    Returns a ListPropertyType that can hold a list of propertyType using DEFAULT_DIVIDER, with default value of an empty list and no constraints on minimum or maximum elements in the list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        List<T> defaultValue)
```
    Returns a ListPropertyType that can hold a list of propertyType using DEFAULT_DIVIDER, and no constraints on minimum or maximum elements in the list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    defaultValue - default value returned if property value is undefined.
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        Integer minLength)
```
    Returns a ListPropertyType that can hold a list of propertyType using DEFAULT_DIVIDER, with default value of an empty list and no constraints on maximum elements in the list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    minLength - the minimum elements their must be in the list for it passes validation. (inclusive).
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        List<T> defaultValue,
                        Integer minLength)
```
    Returns a ListPropertyType that can hold a list of propertyType using DEFAULT_DIVIDER, no constraints on maximum elements in the list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    defaultValue - default value returned if property value is undefined.
    
    minLength - the minimum elements their must be in the list for it passes validation. (inclusive).
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        Integer minLength,
                        Integer maxLength)
```
    Returns a ListPropertyType that can hold a list of propertyType using DEFAULT_DIVIDER, with default value of an empty list and no constraints on maximum elements in the list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    minLength - the minimum elements their must be in the list for it passes validation. (inclusive).
    
    maxLength - the maximum elements their is allowed to be in the list for it to pass validation. (inclusive).
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        String divider)
```
    Returns a ListPropertyType that can hold a list of propertyType using provided divider, with no default value of an empty list and no constraints on minimum or maximum elements in the list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    divider - the string use to divide the elements in the list.
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        String divider,
                        Integer minLength)
```
    Returns a ListPropertyType that can hold a list of propertyType using provided divider and an constraint on the minimum elements in their must be in the list, and a default value of an empty list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    divider - the string use to divide the elements in the list.
    
    minLength - the minimum elements their must be in the list for it passes validation. (inclusive).
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        String divider,
                        Integer minLength,
                        Integer maxLength)
```
    Returns a ListPropertyType that can hold a list of propertyType using provided divider and an constraint on the minimum elements in their must be in the list, and a default value of an empty list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    divider - the string use to divide the elements in the list.
    
    minLength - the minimum elements their must be in the list for it passes validation. (inclusive).
    
    maxLength - the maximum elements their is allowed to be in the list for it to pass validation. (inclusive).
  - ListPropertyType
```
public ListPropertyType(PropertyType<T> propertyType,
                        List<T> defaultValue,
                        String divider,
                        Integer minLength,
                        Integer maxLength)
```
    Returns a ListPropertyType that can hold a list of propertyType using provided divider and an constraint on the minimum and maximum elements in their must be in the list, and a default value of an empty list.
    
    Parameters:
    
    propertyType - the type that the list will hold.
    
    defaultValue - default value returned if property value is undefined.
    
    divider - the string use to divide the elements in the list.
    
    minLength - the minimum elements their must be in the list for it to pass validation. (inclusive).
    
    maxLength - the maximum elements their is allowed to be in the list for it to pass validation. (inclusive).
- Method Detail
  - getMaxNumberOfElements
```
public Integer getMaxNumberOfElements()
```
    The minimum elements their must be in the list.
    
    Returns:
    
    minimum elements their must be in the list, if no limit than null is returned.
  - getMinNumberOfElements
```
public Integer getMinNumberOfElements()
```
    The maximum elements allowed in the list
    
    Returns:
    
    The maximum elements allowed in the list, if no limit than null is returned.
  - isUseMinNumberOfElements
```
public boolean isUseMinNumberOfElements()
```
    Determine if there are minimum element count constraints.
    
    Returns:
    
    true if getMinLength() is diffent from null, otherwise false.
  - isUseMaxNumberOfElements
```
public boolean isUseMaxNumberOfElements()
```
    Determines if there are maximum element count constraints.
    
    Returns:
    
    true if getMaxLength() is diffent from null, otherwise false.
  - getDivider
```
public String getDivider()
```
    Gets the string divider, which splits up the elements in the string.
    
    Returns:
    
    the divider string
  - getPropertyType
```
public PropertyType<T> getPropertyType()
```
    The PropertyType which all the elements must validate to.
    
    Returns:
    
    the type.
  - setPropertyType
```
public void setPropertyType(PropertyType<T> propertyType)
```
  - 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<List<T>>
    
    Returns:
    
    the restrictions of the PropertyType as a list of strings.
  - validateValue
```
public List<T> 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<List<T>>
    
    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.
  - 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<List<T>> 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()
  toString public String toString(String propertyName, List<T> 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<List<T>> 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)

Class ListPropertyType<T>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class dk.heick.properties.PropertyType

Methods inherited from class java.lang.Object

Field Detail

TYPE

DEFAULT_DIVIDER

Constructor Detail

ListPropertyType

ListPropertyType

ListPropertyType

ListPropertyType

ListPropertyType

ListPropertyType

ListPropertyType

ListPropertyType

ListPropertyType

Method Detail

getMaxNumberOfElements

getMinNumberOfElements

isUseMinNumberOfElements

isUseMaxNumberOfElements

getDivider

getPropertyType

setPropertyType

getRestrictions

validateValue

validateConstraints

toString