dk.heick.properties.types

Class InetAddressPropertyType

java.lang.Object

dk.heick.properties.PropertyType<InetAddress>

dk.heick.properties.types.InetAddressPropertyType

All Implemented Interfaces:

Serializable

public class InetAddressPropertyType
extends PropertyType<InetAddress>

PropertyType that validates to a InetAddress value.
This type convert and validates a string to a java.net.InetAddress.
Any string value which parses the method InetAddress.getByName(value).
If you only want ip address validation use IP4AddressPropertyType

An InetAddress is defined as:

 An IP address is either a 32-bit or 128-bit unsigned number used by IP, 
 a lower-level protocol on which protocols like UDP and TCP are built. 
 The IP address architecture is defined by RFC 790: Assigned Numbers, 
 RFC 1918: Address Allocation for Private Internets, RFC 2365: Administratively Scoped IP Multicast, 
 and RFC 2373: IP Version 6 Addressing Architecture. 
 An instance of an InetAddress consists of an IP address and 
 possibly its corresponding host name 
 (depending on whether it is constructed with a host name or whether it has already done reverse 
 host name resolution).
 

Remember that "InetAddress" do NOT have a protocol, so the value "http://www.jp.dk" is a URL not a InetAddress.


Regarding proxy setup, please read http://docs.oracle.com/javase/7/docs/technotes/guides/net/proxies.html.

Constructor Example			Comments
Property<InetAddress> A_PROPERTY = new Property<InetAddress>("name", new InetAddressPropertyType());			Creates InetAddressPropertyType with no default value.
Property<InetAddress> A_PROPERTY = new Property<InetAddress>("name", new InetAddressPropertyType("127.0.0.1"));			Default value is new InetAddress("127.0.0.1").
Type of value(s)	Examples	Result	Comments
Valid	192.168.0.1	InetAddressPropertyType("192.168.0.1")	Validate successfully.
Valid	localhost	InetAddressPropertyType("localhost")	Validate successfully.
Valid	www.nba.com	InetAddressPropertyType("www.nba.com")	Validate successfully.
Valid	www.nba.com/195.59.44.33	InetAddressPropertyType("www.nba.com/195.59.44.33")	Validate successfully.
Valid	/195.59.44.33	InetAddressPropertyType("/195.59.44.33")	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.0

Author:

Frederik Heick

See Also:

InetAddress, InetAddress.getByName(String), IP4AddressPropertyType, Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
InetAddressPropertyType()
InetAddressPropertyType(InetAddress defaultValue)
InetAddressPropertyType(String defaultValue)

Method Summary

Modifier and Type	Method and Description
List<String>	getRestrictions() Gets a detailed description of the PropertyType with any constraints that might influence the validation.
InetAddress	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, 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 InetAddressPropertyType

See Also:

Constant Field Values

Constructor Detail

InetAddressPropertyType

public InetAddressPropertyType()
                        throws NullPointerException

Throws:

NullPointerException

InetAddressPropertyType

public InetAddressPropertyType(InetAddress defaultValue)
                        throws NullPointerException

Throws:

NullPointerException

InetAddressPropertyType

public InetAddressPropertyType(String defaultValue)
                        throws NullPointerException

Throws:

NullPointerException

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

Returns:

the restrictions of the PropertyType as a list of strings.

validateValue

public InetAddress 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<InetAddress>

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.