org.opendaylight.mdsal.model.ietf.util

Class AbstractIetfInetUtil<A4,A4NZ extends A4,P4,A6,A6NZ extends A6,P6,A,ANZ,P>

java.lang.Object

org.opendaylight.mdsal.model.ietf.util.AbstractIetfInetUtil<A4,A4NZ,P4,A6,A6NZ,P6,A,ANZ,P>

Direct Known Subclasses:

IetfInetUtil

@Beta
public abstract class AbstractIetfInetUtil<A4,A4NZ extends A4,P4,A6,A6NZ extends A6,P6,A,ANZ,P>
extends Object

A set of utility methods to efficiently instantiate various ietf-inet-types DTOs.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractIetfInetUtil(Class<A4> addr4Class, Class<A4NZ> addr4nzClass, Class<P4> prefix4Class, Class<A6> addr6Class, Class<A6NZ> addr6nzClass, Class<P6> prefix6Class)

Method Summary

Modifier and Type	Method and Description
@NonNull Inet4Address	inet4AddressFor(A4 addr)
@NonNull Inet4Address	inet4AddressForNoZone(A4NZ addr)
@NonNull Inet6Address	inet6AddressFor(A6 addr)
@NonNull Inet6Address	inet6AddressForNoZone(A6NZ addr)
@NonNull InetAddress	inetAddressFor(A addr)
@NonNull InetAddress	inetAddressForNoZone(ANZ addr)
A	ipAddressFor(byte[] bytes) Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.
A	ipAddressFor(@NonNull InetAddress addr)
ANZ	ipAddressNoZoneFor(byte[] bytes) Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.
ANZ	ipAddressNoZoneFor(@NonNull InetAddress addr)
P	ipPrefixFor(byte[] bytes, int mask) Create an IpPrefix by combining the address with a mask.
P	ipPrefixFor(@NonNull InetAddress addr, int mask)
protected abstract A	ipv4Address(A4 addr)
byte[]	ipv4AddressBytes(A4 addr)
A4	ipv4AddressFor(byte[] bytes) Create an Ipv4Address by interpreting input bytes as an IPv4 address.
A4	ipv4AddressFor(@NonNull InetAddress addr) Create an Ipv4Address by interpreting an Inet4Address.
A4	ipv4AddressFrom(P4 prefix)
protected abstract ANZ	ipv4AddressNoZone(A4NZ addr)
byte[]	ipv4AddressNoZoneBytes(A4NZ addr)
A4NZ	ipv4AddressNoZoneFor(byte[] bytes) Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.
A4NZ	ipv4AddressNoZoneFor(@NonNull InetAddress addr) Create an Ipv4AddressNoZone by interpreting an Inet4Address.
A4NZ	ipv4AddressNoZoneFrom(P4 prefix)
protected abstract @NonNull String	ipv4AddressString(A4 addr)
protected abstract P	ipv4Prefix(P4 addr)
P4	ipv4PrefixFor(A4 addr)
P4	ipv4PrefixFor(A4 addr, int mask)
P4	ipv4PrefixFor(byte[] bytes) Create a /32 Ipv4Prefix by interpreting input bytes as an IPv4 address.
P4	ipv4PrefixFor(byte[] address, int mask) Create a Ipv4Prefix by combining the address with a mask.
P4	ipv4PrefixFor(@NonNull InetAddress addr) Create a /32 Ipv4Prefix for an Inet4Address
P4	ipv4PrefixFor(@NonNull InetAddress addr, int mask) Create a Ipv4Prefix by combining the address with a mask.
P4	ipv4PrefixForNoZone(A4NZ addr)
P4	ipv4PrefixForNoZone(A4NZ addr, int mask)
P4	ipv4PrefixForShort(byte[] address, int mask)
P4	ipv4PrefixForShort(byte[] array, int startOffset, int mask)
protected abstract @NonNull String	ipv4PrefixString(P4 prefix)
byte[]	ipv4PrefixToBytes(P4 prefix)
protected abstract A	ipv6Address(A6 addr)
byte[]	ipv6AddressBytes(A6 addr)
A6	ipv6AddressFor(byte[] bytes) Create an Ipv6Address by interpreting input bytes as an IPv6 address.
A6	ipv6AddressFor(@NonNull InetAddress addr) Create an Ipv6Address by interpreting an Inet6Address.
A6	ipv6AddressFrom(P6 prefix)
protected abstract ANZ	ipv6AddressNoZone(A6NZ addr)
byte[]	ipv6AddressNoZoneBytes(A6NZ addr)
A6NZ	ipv6AddressNoZoneFor(byte[] bytes) Create an Ipv6AddressNoZone by interpreting input bytes as an IPv6 address.
A6NZ	ipv6AddressNoZoneFor(@NonNull InetAddress addr) Create an Ipv6AddressNoZone by interpreting an Inet6Address.
A6NZ	ipv6AddressNoZoneFrom(P6 prefix)
protected abstract @NonNull String	ipv6AddressString(A6 addr)
protected abstract P	ipv6Prefix(P6 addr)
P6	ipv6PrefixFor(A6 addr)
P6	ipv6PrefixFor(A6 addr, int mask)
P6	ipv6PrefixFor(byte[] bytes) Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.
P6	ipv6PrefixFor(byte[] address, int mask) Create a Ipv6Prefix by combining the address with a mask.
P6	ipv6PrefixFor(@NonNull InetAddress addr) Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.
P6	ipv6PrefixFor(@NonNull InetAddress addr, int mask) Create a Ipv6Prefix by combining the address with a mask.
P6	ipv6PrefixForNoZone(A6NZ addr)
P6	ipv6PrefixForNoZone(A6NZ addr, int mask)
P6	ipv6PrefixForShort(byte[] address, int mask)
P6	ipv6PrefixForShort(byte[] array, int startOffset, int mask)
protected abstract @NonNull String	ipv6PrefixString(P6 prefix)
byte[]	ipv6PrefixToBytes(P6 prefix)
protected abstract A4	maybeIpv4Address(A addr)
protected abstract A4NZ	maybeIpv4AddressNoZone(ANZ addr)
protected abstract A6	maybeIpv6Address(A addr)
protected abstract A6NZ	maybeIpv6AddressNoZone(ANZ addr)
@NonNull Map.Entry<A4,Integer>	splitIpv4Prefix(P4 prefix)
@NonNull Map.Entry<A4NZ,Integer>	splitIpv4PrefixNoZone(P4 prefix)
@NonNull Map.Entry<A6,Integer>	splitIpv6Prefix(P6 prefix)
@NonNull Map.Entry<A6NZ,Integer>	splitIpv6PrefixNoZone(P6 prefix)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIetfInetUtil

protected AbstractIetfInetUtil(Class<A4> addr4Class,
                               Class<A4NZ> addr4nzClass,
                               Class<P4> prefix4Class,
                               Class<A6> addr6Class,
                               Class<A6NZ> addr6nzClass,
                               Class<P6> prefix6Class)

Method Detail

ipv4Address

protected abstract A ipv4Address(A4 addr)

ipv4AddressNoZone

protected abstract ANZ ipv4AddressNoZone(A4NZ addr)

ipv6Address

protected abstract A ipv6Address(A6 addr)

ipv6AddressNoZone

protected abstract ANZ ipv6AddressNoZone(A6NZ addr)

maybeIpv4Address

protected abstract A4 maybeIpv4Address(A addr)

maybeIpv4AddressNoZone

protected abstract A4NZ maybeIpv4AddressNoZone(ANZ addr)

maybeIpv6Address

protected abstract A6 maybeIpv6Address(A addr)

maybeIpv6AddressNoZone

protected abstract A6NZ maybeIpv6AddressNoZone(ANZ addr)

ipv4Prefix

protected abstract P ipv4Prefix(P4 addr)

ipv6Prefix

protected abstract P ipv6Prefix(P6 addr)

ipv4AddressString

protected abstract @NonNull String ipv4AddressString(A4 addr)

ipv6AddressString

protected abstract @NonNull String ipv6AddressString(A6 addr)

ipv4PrefixString

protected abstract @NonNull String ipv4PrefixString(P4 prefix)

ipv6PrefixString

protected abstract @NonNull String ipv6PrefixString(P6 prefix)

ipAddressFor

public final A ipAddressFor(byte[] bytes)

Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.

Parameters:

bytes - 4-byte (IPv4) or 6-byte (IPv6) array

Returns:

An IpAddress object

Throws:

IllegalArgumentException - if bytes has length different from 4 or 6

NullPointerException - if bytes is null

ipAddressFor

public final A ipAddressFor(@NonNull InetAddress addr)

ipAddressNoZoneFor

public final ANZ ipAddressNoZoneFor(byte[] bytes)

Create an IpAddress by interpreting input bytes as an IPv4 or IPv6 address, based on array length.

Parameters:

bytes - 4-byte (IPv4) or 6-byte (IPv6) array

Returns:

A no-zone IpAddress object

Throws:

IllegalArgumentException - if bytes has length different from 4 or 6

NullPointerException - if bytes is null

ipAddressNoZoneFor

public final ANZ ipAddressNoZoneFor(@NonNull InetAddress addr)

ipPrefixFor

public final P ipPrefixFor(byte[] bytes,
                           int mask)

Create an IpPrefix by combining the address with a mask. The address bytes are interpreted as an address and the specified mask is concatenated to it. The address bytes are not masked.

Parameters:

bytes - Input address as a 4-byte (IPv4) or 16-byte (IPv6) array

mask - Prefix mask

Returns:

An IpPrefix object

Throws:

IllegalArgumentException - if bytes has length different from 4 or 16 or if mask is not in range 0-32 or 0-128 respectively

NullPointerException - if bytes is null

ipPrefixFor

public final P ipPrefixFor(@NonNull InetAddress addr,
                           int mask)

inetAddressFor

public final @NonNull InetAddress inetAddressFor(A addr)

inetAddressForNoZone

public final @NonNull InetAddress inetAddressForNoZone(ANZ addr)

inet4AddressFor

public final @NonNull Inet4Address inet4AddressFor(A4 addr)

inet4AddressForNoZone

public final @NonNull Inet4Address inet4AddressForNoZone(A4NZ addr)

inet6AddressFor

public final @NonNull Inet6Address inet6AddressFor(A6 addr)

inet6AddressForNoZone

public final @NonNull Inet6Address inet6AddressForNoZone(A6NZ addr)

ipv4AddressFor

public final A4 ipv4AddressFor(byte[] bytes)

Create an Ipv4Address by interpreting input bytes as an IPv4 address.

Parameters:

bytes - 4-byte array

Returns:

An Ipv4Address object

Throws:

IllegalArgumentException - if bytes has length different from 4

NullPointerException - if bytes is null

ipv4AddressFor

public final A4 ipv4AddressFor(@NonNull InetAddress addr)

Create an Ipv4Address by interpreting an Inet4Address.

Parameters:

addr - An Inet4Address

Returns:

An Ipv4Address object

Throws:

IllegalArgumentException - if addr is not an Inet4Address

NullPointerException - if addr is null

ipv4AddressNoZoneFor

public final A4NZ ipv4AddressNoZoneFor(byte[] bytes)

Create an Ipv4AddressNoZone by interpreting input bytes as an IPv4 address.

Parameters:

bytes - 4-byte array

Returns:

An Ipv4AddressNoZone object

Throws:

IllegalArgumentException - if bytes has length different from 4

NullPointerException - if bytes is null

ipv4AddressNoZoneFor

public final A4NZ ipv4AddressNoZoneFor(@NonNull InetAddress addr)

Create an Ipv4AddressNoZone by interpreting an Inet4Address.

Parameters:

addr - An Inet4Address

Returns:

An Ipv4AddressNoZone object

Throws:

IllegalArgumentException - if addr is not an Inet4Address

NullPointerException - if addr is null

ipv4AddressFrom

public final A4 ipv4AddressFrom(P4 prefix)

ipv4AddressNoZoneFrom

public final A4NZ ipv4AddressNoZoneFrom(P4 prefix)

ipv4AddressBytes

public final byte[] ipv4AddressBytes(A4 addr)

ipv4AddressNoZoneBytes

public final byte[] ipv4AddressNoZoneBytes(A4NZ addr)

ipv4PrefixFor

public final P4 ipv4PrefixFor(byte[] bytes)

Create a /32 Ipv4Prefix by interpreting input bytes as an IPv4 address.

Parameters:

bytes - four-byte array

Returns:

An Ipv4Prefix object

Throws:

IllegalArgumentException - if bytes has length different from 4

NullPointerException - if bytes is null

ipv4PrefixFor

public final P4 ipv4PrefixFor(byte[] address,
                              int mask)

Create a Ipv4Prefix by combining the address with a mask. The address bytes are interpreted as an address and the specified mask is concatenated to it. The address bytes are not masked, hence input address = { 1, 2, 3, 4 } and mask=24 will result in 1.2.3.4/24.

Parameters:

address - Input address as a 4-byte array

mask - Prefix mask

Returns:

An Ipv4Prefix object

Throws:

IllegalArgumentException - if bytes has length different from 4 or if mask is not in range 0-32

NullPointerException - if bytes is null

ipv4PrefixForShort

public final P4 ipv4PrefixForShort(byte[] address,
                                   int mask)

ipv4PrefixForShort

public final P4 ipv4PrefixForShort(byte[] array,
                                   int startOffset,
                                   int mask)

ipv4PrefixFor

public final P4 ipv4PrefixFor(@NonNull InetAddress addr)

Create a /32 Ipv4Prefix for an Inet4Address

Parameters:

addr - An Inet4Address

Returns:

An Ipv4Prefix object

Throws:

IllegalArgumentException - if addr is not an Inet4Address

NullPointerException - if addr is null

ipv4PrefixFor

public final P4 ipv4PrefixFor(@NonNull InetAddress addr,
                              int mask)

Create a Ipv4Prefix by combining the address with a mask. The address bytes are not masked.

Parameters:

addr - An Inet4Address

mask - Prefix mask

Returns:

An Ipv4Prefix object

Throws:

IllegalArgumentException - if addr is not an Inet4Address or if mask is not in range 0-32

NullPointerException - if addr is null

ipv4PrefixFor

public final P4 ipv4PrefixFor(A4 addr)

ipv4PrefixFor

public final P4 ipv4PrefixFor(A4 addr,
                              int mask)

ipv4PrefixForNoZone

public final P4 ipv4PrefixForNoZone(A4NZ addr)

ipv4PrefixForNoZone

public final P4 ipv4PrefixForNoZone(A4NZ addr,
                                    int mask)

splitIpv4Prefix

public final @NonNull Map.Entry<A4,Integer> splitIpv4Prefix(P4 prefix)

splitIpv4PrefixNoZone

public final @NonNull Map.Entry<A4NZ,Integer> splitIpv4PrefixNoZone(P4 prefix)

ipv4PrefixToBytes

public final byte[] ipv4PrefixToBytes(P4 prefix)

ipv6AddressFor

public final A6 ipv6AddressFor(byte[] bytes)

Create an Ipv6Address by interpreting input bytes as an IPv6 address.

Parameters:

bytes - 16-byte array

Returns:

An Ipv6Address object

Throws:

IllegalArgumentException - if bytes has length different from 16

NullPointerException - if bytes is null

ipv6AddressFor

public final A6 ipv6AddressFor(@NonNull InetAddress addr)

Create an Ipv6Address by interpreting an Inet6Address.

Parameters:

addr - An Inet6Address

Returns:

An Ipv6Address object

Throws:

IllegalArgumentException - if addr is not an Inet6Address

NullPointerException - if addr is null

ipv6AddressNoZoneFor

public final A6NZ ipv6AddressNoZoneFor(byte[] bytes)

Create an Ipv6AddressNoZone by interpreting input bytes as an IPv6 address.

Parameters:

bytes - 16-byte array

Returns:

An Ipv6Address object

Throws:

IllegalArgumentException - if bytes has length different from 16

NullPointerException - if bytes is null

ipv6AddressNoZoneFor

public final A6NZ ipv6AddressNoZoneFor(@NonNull InetAddress addr)

Create an Ipv6AddressNoZone by interpreting an Inet6Address.

Parameters:

addr - An Inet6Address

Returns:

An Ipv6AddressNoZone object

Throws:

IllegalArgumentException - if addr is not an Inet6Address

NullPointerException - if addr is null

ipv6AddressFrom

public final A6 ipv6AddressFrom(P6 prefix)

ipv6AddressNoZoneFrom

public final A6NZ ipv6AddressNoZoneFrom(P6 prefix)

ipv6AddressBytes

public final byte[] ipv6AddressBytes(A6 addr)

ipv6AddressNoZoneBytes

public final byte[] ipv6AddressNoZoneBytes(A6NZ addr)

ipv6PrefixFor

public final P6 ipv6PrefixFor(byte[] bytes)

Create a /128 Ipv6Prefix by interpreting input bytes as an IPv6 address.

Parameters:

bytes - four-byte array

Returns:

An Ipv6Prefix object

Throws:

IllegalArgumentException - if bytes has length different from 16

NullPointerException - if bytes is null

ipv6PrefixFor

public final P6 ipv6PrefixFor(byte[] address,
                              int mask)

Create a Ipv6Prefix by combining the address with a mask. The address bytes are interpreted as an address and the specified mask is concatenated to it. The address bytes are not masked.

Parameters:

address - Input address as a 16-byte array

mask - Prefix mask

Returns:

An Ipv6Prefix object

Throws:

IllegalArgumentException - if bytes has length different from 16 or if mask is not in range 0-128

NullPointerException - if bytes is null

ipv6PrefixForShort

public final P6 ipv6PrefixForShort(byte[] address,
                                   int mask)

ipv6PrefixForShort

public final P6 ipv6PrefixForShort(byte[] array,
                                   int startOffset,
                                   int mask)

ipv6PrefixFor

public final P6 ipv6PrefixFor(@NonNull InetAddress addr)

Create a /128 Ipv6Prefix by interpreting input bytes as an IPv4 address.

Parameters:

addr - an Inet6Address

Returns:

An Ipv6Prefix object

Throws:

IllegalArgumentException - if addr is not an Inet6Address or if mask is not in range 0-128

NullPointerException - if addr is null

ipv6PrefixFor

public final P6 ipv6PrefixFor(@NonNull InetAddress addr,
                              int mask)

Create a Ipv6Prefix by combining the address with a mask. The address bytes are interpreted as an address and the specified mask is concatenated to it. The address bytes are not masked.

Parameters:

addr - Input address

mask - Prefix mask

Returns:

An Ipv6Prefix object

Throws:

IllegalArgumentException - if addr is not an Inet6Address or if mask is not in range 0-128

NullPointerException - if addr is null

ipv6PrefixFor

public final P6 ipv6PrefixFor(A6 addr)

ipv6PrefixFor

public final P6 ipv6PrefixFor(A6 addr,
                              int mask)

ipv6PrefixForNoZone

public final P6 ipv6PrefixForNoZone(A6NZ addr)

ipv6PrefixForNoZone

public final P6 ipv6PrefixForNoZone(A6NZ addr,
                                    int mask)

splitIpv6Prefix

public final @NonNull Map.Entry<A6,Integer> splitIpv6Prefix(P6 prefix)

splitIpv6PrefixNoZone

public final @NonNull Map.Entry<A6NZ,Integer> splitIpv6PrefixNoZone(P6 prefix)

ipv6PrefixToBytes

public final byte[] ipv6PrefixToBytes(P6 prefix)