com.github.robtimus.net.ip

Class IPAddressFormat<IP extends IPAddress<?>>

java.lang.Object

java.text.Format

com.github.robtimus.net.ip.IPAddressFormat<IP>

Type Parameters:

IP - The supported type of IP address.

All Implemented Interfaces:

Serializable, Cloneable

public abstract class IPAddressFormat<IP extends IPAddress<?>>
extends Format

A class for formatting and parsing IP addresses. Instances returned from the asFormat method of an IPAddressFormatter are immutable.

Author:

Rob Spoor

Since:

1.2

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.text.Format

Format.Field

Method Summary

Modifier and Type	Method and Description
Object	clone() Deprecated. IPAddressFormat instances are immutable, and should not be cloned.
boolean	equals(Object o)
StringBuffer	format(Object obj, StringBuffer toAppendTo, FieldPosition pos) Formats an IP address and appends the resulting text to the given StringBuffer.
int	hashCode()
IP	parse(CharSequence source) Parses a CharSequence to an IP address.
IP	parse(CharSequence source, ParsePosition position) Attempts to parse a CharSequence to an IP address.
IP	parseObject(String source)
IP	parseObject(String source, ParsePosition position)

Methods inherited from class java.text.Format

format, formatToCharacterIterator

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

format

public StringBuffer format(Object obj,
                           StringBuffer toAppendTo,
                           FieldPosition pos)

Formats an IP address and appends the resulting text to the given StringBuffer. This method supports IPAddresses of the correct type, and byte arrays of the correct size. For instance, an IPAddressFormat for IPv4Address only supports IPv4Address and arrays of 4 bytes, and an IPAddressFormat for IPv6Address only supports IPv6Address and arrays of 16 bytes,

Specified by:

format in class Format

Parameters:

obj - The object to format.

toAppendTo - The StringBuffer to append to.

pos - A FieldPosition identifying a field in the formatted text; ignored.

Returns:

The given StringBuffer.

Throws:

NullPointerException - If the given StringBuffer is null.

IllegalArgumentException - If the given object is not an IPAddress of the correct type or byte array of the correct size.

parseObject

public IP parseObject(String source,
                      ParsePosition position)

Specified by:

parseObject in class Format

parseObject

public IP parseObject(String source)
               throws ParseException

Overrides:

parseObject in class Format

Throws:

ParseException

parse

public IP parse(CharSequence source,
                ParsePosition position)

Attempts to parse a CharSequence to an IP address. Parsing starts at the current index of the given ParsePosition.

If parsing succeeds, the given ParsePosition's index is updated to the index after the last character that was used for parsing. The updated position can be used as a starting point for other parsing.

If parsing fails, the given ParsePosition's index is not modified, but its error index is set to the index of the character that caused parsing to fail.

Parameters:

source - The CharSequence to parse.

position - The ParsePosition to update as described.

Returns:

The parsed IP address if parsing succeeded, or null if parsing fails.

Throws:

NullPointerException - If the given CharSequence or ParsePosition is null.

parse

public IP parse(CharSequence source)
         throws ParseException

Parses a CharSequence to an IP address. This method is like parseObject(String), but unlike that method this method will use the entire CharSequence.

Parameters:

source - The CharSequence to parse.

Returns:

The parsed IP address.

Throws:

NullPointerException - If the given CharSequence is null.

ParseException - If the CharSequence could not be parsed to an IP address.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

clone

@Deprecated
public Object clone()

Deprecated. IPAddressFormat instances are immutable, and should not be cloned.

Overrides:

clone in class Format