Module org.newsclub.net.unix

Package org.newsclub.net.unix

Class AFGenericSocketAddress

java.lang.Object

java.net.SocketAddress

java.net.InetSocketAddress

org.newsclub.net.unix.AFSocketAddress

org.newsclub.net.unix.AFGenericSocketAddress

All Implemented Interfaces:

Serializable

public final class AFGenericSocketAddress
extends AFSocketAddress

An AFSocketAddress for unknown socket types.

Author:

Christian Kohlschütter

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.newsclub.net.unix.AFSocketAddress

AFSocketAddress.AFSocketAddressConstructor<T extends AFSocketAddress>

Method Summary

Modifier and Type	Method	Description
static AFAddressFamily<AFGenericSocketAddress>	addressFamily()	Returns the corresponding AFAddressFamily.
File	getFile()	Returns the File corresponding with this address, if possible.
boolean	hasFilename()	Checks if the address can be resolved to a File.
static boolean	isSupportedAddress(InetAddress addr)	Checks if an InetAddress can be unwrapped to an AFGenericSocketAddress.
static boolean	isSupportedAddress(SocketAddress addr)	Checks if a SocketAddress can be unwrapped to an AFGenericSocketAddress.
static AFGenericSocketAddress	of(URI uri)	Returns an AFGenericSocketAddress for the given URI, if possible.
static AFGenericSocketAddress	of(URI uri, int overridePort)	Returns an AFGenericSocketAddress for the given URI, if possible.
byte[]	toBytes()	Returns the native representation of this generic address, which is most likely not portable.
String	toString()
URI	toURI(String scheme, URI template)	Tries to create a URI based on this AFSocketAddress.
static AFGenericSocketAddress	unwrap(String hostname, int port)	Returns an AFGenericSocketAddress given a special InetAddress hostname that encodes the byte sequence of an unknown-type socket address, like those returned by AFSocketAddress.wrapAddress().
static AFGenericSocketAddress	unwrap(InetAddress address, int port)	Returns an AFGenericSocketAddress given a special InetAddress that encodes the byte sequence of an unknown-type socket address, like those returned by AFSocketAddress.wrapAddress().
static AFGenericSocketAddress	unwrap(SocketAddress address)	Returns an AFGenericSocketAddress given a generic SocketAddress.

Methods inherited from class org.newsclub.net.unix.AFSocketAddress

canMap, canMap, covers, getAddressFamily, getBytes, getInetAddress, getInetAddress, getInetAddress, getSocketAddress, isSupportedAddress, isUseDeserializationForInit, mapOrFail, mapOrFail, newBoundServerSocket, newConnectedSocket, newDeserializedAFSocketAddress, newForceBoundServerSocket, parseUnsignedInt, resolveAddress, toSocatAddressString, unwrap, unwrap, wrapAddress, writeNativeAddressTo

Methods inherited from class java.net.InetSocketAddress

createUnresolved, equals, getAddress, getHostName, getHostString, getPort, hashCode, isUnresolved

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

unwrap

public static AFGenericSocketAddress unwrap(InetAddress address,
 int port)
                                     throws SocketException

Returns an AFGenericSocketAddress given a special InetAddress that encodes the byte sequence of an unknown-type socket address, like those returned by AFSocketAddress.wrapAddress().

Parameters:

address - The "special" InetAddress.

port - The port (use 0 for "none").

Returns:

The AFGenericSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

unwrap

public static AFGenericSocketAddress unwrap(String hostname,
 int port)
                                     throws SocketException

Returns an AFGenericSocketAddress given a special InetAddress hostname that encodes the byte sequence of an unknown-type socket address, like those returned by AFSocketAddress.wrapAddress().

Parameters:

hostname - The "special" hostname, as provided by InetAddress.getHostName().

port - The port (use 0 for "none").

Returns:

The AFGenericSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

unwrap

public static AFGenericSocketAddress unwrap(SocketAddress address)
                                     throws SocketException

Returns an AFGenericSocketAddress given a generic SocketAddress.

Parameters:

address - The address to unwrap.

Returns:

The AFGenericSocketAddress instance.

Throws:

SocketException - if the operation fails, for example when an unsupported address is specified.

toString

public String toString()

Overrides:

toString in class InetSocketAddress

toBytes

public byte[] toBytes()

Returns the native representation of this generic address, which is most likely not portable.

The address contains the sa_family identifier as the first byte, and, on some platforms only, the address length, as the second byte.

Returns:

A new byte array containing the system-specific representation of that address.

hasFilename

public boolean hasFilename()

Description copied from class: AFSocketAddress

Checks if the address can be resolved to a File.

Specified by:

hasFilename in class AFSocketAddress

Returns:

true if the address has a filename.

getFile

public File getFile()
             throws FileNotFoundException

Description copied from class: AFSocketAddress

Returns the File corresponding with this address, if possible. A FileNotFoundException is thrown if there is no filename associated with the address, which applies to addresses in the abstract namespace, for example.

Specified by:

getFile in class AFSocketAddress

Returns:

The filename.

Throws:

FileNotFoundException - if the address is not associated with a filename.

isSupportedAddress

public static boolean isSupportedAddress(InetAddress addr)

Checks if an InetAddress can be unwrapped to an AFGenericSocketAddress.

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• AFSocketAddress.wrapAddress()
• unwrap(InetAddress, int)

isSupportedAddress

public static boolean isSupportedAddress(SocketAddress addr)

Checks if a SocketAddress can be unwrapped to an AFGenericSocketAddress.

Parameters:

addr - The instance to check.

Returns:

true if so.

See Also:

• unwrap(InetAddress, int)

addressFamily

public static AFAddressFamily<AFGenericSocketAddress> addressFamily()

Returns the corresponding AFAddressFamily.

Returns:

The address family instance.

of

public static AFGenericSocketAddress of(URI uri)
                                 throws SocketException

Returns an AFGenericSocketAddress for the given URI, if possible.

Parameters:

uri - The URI.

Returns:

The address.

Throws:

SocketException - if the operation fails.

of

public static AFGenericSocketAddress of(URI uri,
 int overridePort)
                                 throws SocketException

Returns an AFGenericSocketAddress for the given URI, if possible.

Parameters:

uri - The URI.

overridePort - The port to forcibly use, or -1 for "don't override".

Returns:

The address.

Throws:

SocketException - if the operation fails.

toURI

public URI toURI(String scheme,
 URI template)
          throws IOException

Description copied from class: AFSocketAddress

Tries to create a URI based on this AFSocketAddress.

Overrides:

toURI in class AFSocketAddress

Parameters:

scheme - The target scheme.

template - An optional template to reuse certain parameters (e.g., the "path" component for an http request), or null.

Returns:

The URI.

Throws:

IOException - on error.