Module com.aoapps.net.types

Package com.aoapps.net

Class InetAddressPrefix

java.lang.Object

com.aoapps.net.InetAddressPrefix

All Implemented Interfaces:

DtoFactory<InetAddressPrefix>, Serializable, Comparable<InetAddressPrefix>

public final class InetAddressPrefix
extends Object
implements Comparable<InetAddressPrefix>, Serializable, DtoFactory<InetAddressPrefix>

Combines an InetAddress and an associated prefix.

See RFC 4291, Section 2.3. Text Representation of Address Prefixes.

Author:

AO Industries, Inc.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
InetAddressPrefix	coalesce(InetAddressPrefix other)	Combines this address prefix with the given address prefix if possible.
int	compareTo(InetAddressPrefix other)	Ordered by address, prefix.
boolean	contains(InetAddress other)	Checks if the given address is in this prefix.
boolean	contains(InetAddressPrefix other)	Checks if the given address prefix is in this prefix.
boolean	equals(Object obj)	Equal when has equal address and prefix.
InetAddress	getAddress()
InetAddressPrefix	getDto()
InetAddress	getFrom()	Gets the first address in the network range represented by this address and prefix.
int	getPrefix()
InetAddress	getTo()	Gets the last address in the network range represented by this address and prefix.
int	hashCode()
InetAddressPrefix	normalize()	Normalizes this address prefix, where all bits not in prefix are zeroed.
String	toString()
static ValidationResult	validate(InetAddress address, int prefix)	Checks if the address and prefix are valid.
static InetAddressPrefix	valueOf(InetAddress address, int prefix)	Gets an IPv6 address prefix from an address and prefix.
static InetAddressPrefix	valueOf(String address)	Parses an IP address with optional prefix.

Methods inherited from class java.lang.Object

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

Method Details

validate

public static ValidationResult validate(InetAddress address,
 int prefix)

Checks if the address and prefix are valid.

Parameters:

address - must be non-null

prefix - must be between zero and AddressFamily.getMaxPrefix(), inclusive

valueOf

public static InetAddressPrefix valueOf(InetAddress address,
 int prefix)
                                 throws ValidationException

Gets an IPv6 address prefix from an address and prefix.

Parameters:

address - If address is null, returns null.

Throws:

ValidationException - See validate(com.aoapps.net.InetAddress, int)

valueOf

public static InetAddressPrefix valueOf(String address)
                                 throws ValidationException

Parses an IP address with optional prefix.

Parameters:

address - The address and optional prefix as address[/prefix].

Throws:

ValidationException

See Also:

• for the inverse function

equals

public boolean equals(Object obj)

Equal when has equal address and prefix. This means two prefixes that represent the same address range, but have different addresses, are not considered equal. To check if represent the same range, normalize each address prefix.

Overrides:

equals in class Object

See Also:

• normalize()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

The address and optional prefix as address[/prefix].

See Also:

• for the inverse function

compareTo

public int compareTo(InetAddressPrefix other)

Ordered by address, prefix.

Specified by:

compareTo in interface Comparable<InetAddressPrefix>

See Also:

• InetAddress.compareTo(com.aoapps.net.InetAddress)

getAddress

public InetAddress getAddress()

getPrefix

public int getPrefix()

getDto

public InetAddressPrefix getDto()

Specified by:

getDto in interface DtoFactory<InetAddressPrefix>

getFrom

public InetAddress getFrom()

Gets the first address in the network range represented by this address and prefix.

Returns:

getAddress() when from == address, otherwise new address.

getTo

public InetAddress getTo()

Gets the last address in the network range represented by this address and prefix.

Returns:

getAddress() when to == address, otherwise new address.

normalize

public InetAddressPrefix normalize()

Normalizes this address prefix, where all bits not in prefix are zeroed. This means the address will be the first address in the network range.

See Also:

• getFrom()

contains

public boolean contains(InetAddress other)

Checks if the given address is in this prefix. Must be of the same address family; IPv4 addresses will never match IPv6.

contains

public boolean contains(InetAddressPrefix other)

Checks if the given address prefix is in this prefix. Must be of the same address family; IPv4 addresses will never match IPv6.

coalesce

public InetAddressPrefix coalesce(InetAddressPrefix other)

Combines this address prefix with the given address prefix if possible. Will only combine address prefixes of the same AddressFamily. Returns a normalized network range.

1. If different address prefixes are non-overlapping and non-adjacent along prefix boundaries, returns null.
2. If the combined address prefix equals this, returns this.
3. If the combined address prefix equals other, returns other.
4. Otherwise, returns a new address prefix covering the full range.

Returns:

When the address prefix hae been combined, returns an address prefix spanning both. null when they cannot be combined.