Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util.stringconverter

Class InetAddressStringConverter

java.lang.Object

org.tquadrat.foundation.util.stringconverter.InetAddressStringConverter

All Implemented Interfaces:

Serializable, StringConverter<InetAddress>

@ClassVersion(sourceVersion="$Id: InetAddressStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=STABLE,
     since="0.0.6")
public final class InetAddressStringConverter
extends Object
implements StringConverter<InetAddress>

The implementation of StringConverter for InetAddress values.

The method fromString(CharSequence) will use InetAddress.getByName(String) to create a InetAddress instance from the given value; this means, that when a host name is given as an argument – instead of an IP4 or IP6 address String – an IllegalArgumentException is thrown when that host is unknown (cannot be resolved by DNS). But fromString() will not accept null or the empty String for localhost; for these values it will also throw an IllegalArgumentException.

The method toString(InetAddress) uses InetAddress.getHostAddress() to get the IP address as a String.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: InetAddressStringConverter.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.0.6

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.stringconverter.InetAddressStringConverter"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
static final InetAddressStringConverter	INSTANCE	An instance of this class.
static final String	MSG_InvalidAddress	The error message about an invalid address or an unknown host name: "\'%1$s\' is invalid or unknown".

Fields inherited from interface org.tquadrat.foundation.lang.StringConverter

METHOD_NAME_GetSubjectClass, METHOD_NAME_Provider

Constructor Summary

Constructors

Constructor	Description
InetAddressStringConverter()	Creates a new instance of InetAddressStringConverter.

Method Summary

Modifier and Type	Method	Description
final InetAddress	fromString(CharSequence source)
static final InetAddressStringConverter	provider()	This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.
final String	toString(InetAddress source)

Methods inherited from class java.lang.Object

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

Field Details

MSG_InvalidAddress

public static final String MSG_InvalidAddress

The error message about an invalid address or an unknown host name: "\'%1$s\' is invalid or unknown".

See Also:

• Constant Field Values

INSTANCE

public static final InetAddressStringConverter INSTANCE

An instance of this class.

Constructor Details

InetAddressStringConverter

public InetAddressStringConverter()

Creates a new instance of InetAddressStringConverter.

Method Details

fromString

public final InetAddress fromString(CharSequence source)
                             throws IllegalArgumentException

Specified by:

fromString in interface StringConverter<InetAddress>

Throws:

IllegalArgumentException

provider

public static final InetAddressStringConverter provider()

This method is used by the ServiceLoader to obtain the instance for this StringConverter implementation.

Returns:

The instance for this StringConverter implementation.

toString

public final String toString(InetAddress source)

Specified by:

toString in interface StringConverter<InetAddress>