org.opendaylight.vtn.manager.util

Class Ip4Network

java.lang.Object

org.opendaylight.vtn.manager.util.IpNetwork

org.opendaylight.vtn.manager.util.Ip4Network

All Implemented Interfaces:

Serializable

public final class Ip4Network
extends IpNetwork

Ip4Network describes an IPv4 network. IPv4 network is specified by an IPv4 address and prefix length.

Since:

Lithium

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE The number of octets in an IPv4 address.

Fields inherited from class org.opendaylight.vtn.manager.util.IpNetwork

CIDR_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Ip4Network(byte[] bytes) Construct a new instance.
Ip4Network(byte[] bytes, int prefix) Construct a new instance.
Ip4Network(InetAddress iaddr) Construct a new instance.
Ip4Network(InetAddress iaddr, int prefix) Construct a new instance.
Ip4Network(int addr) Construct a new instance.
Ip4Network(int addr, int prefix) Construct a new instance.
Ip4Network(String cidr) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	contains(IpNetwork inw) Determine whether this network contains the given IP host.
static Ip4Network	create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address ipv4) Create a new Ip4Network instance from the given MD-SAL ipv4-address.
boolean	equals(Object o) Determine whether the given object is identical to this object.
int	getAddress() Return an integer value which represents the host address.
byte[]	getBytes() Return a byte array which represents the raw network address.
String	getCidrText() Return a string representation of this network in CIDR notation.
String	getHostAddress() Return a string representation of this network address without CIDR prefix.
static InetAddress	getInetAddress(int addr) Create an InetAddress instance which represents the IPv4 address specified by the given integer value.
static InetAddress	getInetMask(int length) Return an InetAddress instance which represents the IPv4 netmask specified by the given prefix length.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress	getIpAddress() Return an IpAddress instance which represents this instance.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix	getIpPrefix() Return an IpPrefix instance which represents this instance.
int	getMaxPrefix() Return the maximum length of the network prefix.
org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.address.Ipv4	getMdAddress() Return a MD-SAL IP address which represents this network address.
int	getNetMask() Return an integer value which represents the network mask.
static int	getNetMask(int length) Return an integer value which represents the IPv4 netmask specified by the given prefix length.
static InetAddress	getNetworkAddress(InetAddress iaddr, int length) Create an IPv4 network address from the given IPv4 address and prefix length.
static int	getPrefixLength(byte[] bytes) Return an IPv4 prefix length represented by the given byte array.
int	hashCode() Return the hash code of this object.
static Ip4Network	toIp4Address(IpNetwork ipn) Ensure that the given IpNetwork instance represents an IPv4 address.

Methods inherited from class org.opendaylight.vtn.manager.util.IpNetwork

create, create, create, create, create, create, getCidrValue, getInetAddress, getInetAddress, getInetAddress, getPrefixLength, getText, isAddress, toString

Methods inherited from class java.lang.Object

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

Field Detail

SIZE

public static final int SIZE

The number of octets in an IPv4 address.

See Also:

Constant Field Values

Constructor Detail

Ip4Network

public Ip4Network(int addr)

Construct a new instance.

This constructor specifies 32 as CIDR prefix length.

Parameters:

addr - An integer value which represents an IPv4 address.

Ip4Network

public Ip4Network(int addr,
                  int prefix)

Construct a new instance.

Parameters:

addr - An integer value which represents an IPv4 address.

prefix - Prefix length that specifies network range. Note that zero means "no mask". So zero is treated as if the maximum prefix length is specified.

Throws:

IllegalArgumentException - The given prefix length is invalid.

Ip4Network

public Ip4Network(byte[] bytes)

Construct a new instance.

This constructor specifies 32 as CIDR prefix length.

Parameters:

bytes - A byte array which represents an IPv4 address.

Throws:

NullPointerException - bytes is null.

IllegalArgumentException - The given byte address does not represent an IPv4 address.

Ip4Network

public Ip4Network(byte[] bytes,
                  int prefix)

Construct a new instance.

Parameters:

bytes - A byte array which represents an IPv4 address.

prefix - Prefix length that specifies network range. Note that zero means "no mask". So zero is treated as if the maximum prefix length is specified.

Throws:

NullPointerException - bytes is null.

IllegalArgumentException - The given prefix length is invalid.

IllegalArgumentException - The given byte address does not represent an IPv4 address.

Ip4Network

public Ip4Network(InetAddress iaddr)

Construct a new instance.

This constructor specifies 32 as CIDR prefix length.

Parameters:

iaddr - An InetAddress instance which represents an IPv4 address.

Throws:

NullPointerException - iaddr is null.

IllegalArgumentException - The given InetAddress instance does not represent an IPv4 address.

Ip4Network

public Ip4Network(InetAddress iaddr,
                  int prefix)

Construct a new instance.

Parameters:

iaddr - An InetAddress instance which represents an IPv4 address.

prefix - Prefix length that specifies network range. Note that zero means "no mask". So zero is treated as if the maximum prefix length is specified.

Throws:

NullPointerException - iaddr is null.

IllegalArgumentException - The given prefix length is invalid.

IllegalArgumentException - The given InetAddress instance does not represent an IPv4 address.

Ip4Network

public Ip4Network(String cidr)

Construct a new instance.

Parameters:

cidr - A string representation of the IP network in CIDR notation. Note that zero prefix means "no mask". So zero prefix is treated as if the maximum prefix length is specified.

Throws:

NullPointerException - cidr is null.

IllegalArgumentException - The given network address is invalid.

Method Detail

getPrefixLength

public static int getPrefixLength(byte[] bytes)

Return an IPv4 prefix length represented by the given byte array.

Note that this method returns 32 if all the bits in the given array are not set.

Parameters:

bytes - A byte array which represents IPv4 network mask.

Returns:

The IPv4 prefix length represented by the given byte array.

Throws:

NullPointerException - bytes is null.

IllegalArgumentException - The given byte array does not represent an IPv4 network mask.

getNetMask

public static int getNetMask(int length)

Return an integer value which represents the IPv4 netmask specified by the given prefix length.

Parameters:

length - The IPv4 prefix length. Note that zero means "no mask". So zero is treated as if the maximum prefix length is specified.

Returns:

An integer value.

Throws:

IllegalArgumentException - The given prefix length is invalid.

getInetMask

public static InetAddress getInetMask(int length)

Return an InetAddress instance which represents the IPv4 netmask specified by the given prefix length.

Parameters:

length - The IPv4 prefix length. Note that zero means "no mask". So zero is treated as if the maximum prefix length is specified.

Returns:

An InetAddress instance.

Throws:

IllegalArgumentException - The given prefix length is invalid.

getNetworkAddress

public static InetAddress getNetworkAddress(InetAddress iaddr,
                                            int length)

Create an IPv4 network address from the given IPv4 address and prefix length.

Parameters:

iaddr - An InetAddress instance.

length - The IPv4 prefix length. Note that zero means "no mask". So zero is treated as if the maximum prefix length is specified.

Returns:

An InetAddress instance which represents the IPv4 network address specified by the given pair of IPv4 address and prefix length.

Throws:

NullPointerException - iaddr is null.

IllegalArgumentException - The given IPv4 address or prefix length is invalid.

getInetAddress

public static InetAddress getInetAddress(int addr)

Create an InetAddress instance which represents the IPv4 address specified by the given integer value.

Parameters:

addr - An integer value which represents the IPv4 address.

Returns:

An InetAddress instance.

toIp4Address

public static Ip4Network toIp4Address(IpNetwork ipn)

Ensure that the given IpNetwork instance represents an IPv4 address.

Parameters:

ipn - An IpNetwork instance.

Returns:

ipn casted as Ip4Network if ipn represents an IPv4 address. Otherwise null.

create

public static Ip4Network create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address ipv4)

Create a new Ip4Network instance from the given MD-SAL ipv4-address.

Parameters:

ipv4 - An Ipv4Address instance.

Returns:

An Ip4Network instance on success. null if ipv4 is null.

Throws:

IllegalArgumentException - The given instance contains an invalid value.

getAddress

public int getAddress()

Return an integer value which represents the host address.

Returns:

An integer value which represents the host address.

getNetMask

public int getNetMask()

Return an integer value which represents the network mask.

Returns:

An integer value which represents the network mask.

getMaxPrefix

public int getMaxPrefix()

Return the maximum length of the network prefix.

Specified by:

getMaxPrefix in class IpNetwork

Returns:

The maximum length of the network prefix.

getIpPrefix

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getIpPrefix()

Return an IpPrefix instance which represents this instance.

Specified by:

getIpPrefix in class IpNetwork

Returns:

An IpPrefix instance.

getIpAddress

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()

Return an IpAddress instance which represents this instance.

This method returns an IP address which represents a string representation of this network address without CIDR prefix.

Specified by:

getIpAddress in class IpNetwork

Returns:

An IpAddress instance.

getMdAddress

public org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.address.Ipv4 getMdAddress()

Return a MD-SAL IP address which represents this network address.

Specified by:

getMdAddress in class IpNetwork

Returns:

An Ipv4 instance.

getCidrText

public String getCidrText()

Return a string representation of this network in CIDR notation.

Specified by:

getCidrText in class IpNetwork

Returns:

A string representation of this network in CIDR notation.

getHostAddress

public String getHostAddress()

Return a string representation of this network address without CIDR prefix.

Specified by:

getHostAddress in class IpNetwork

Returns:

A string representation of this network address.

getBytes

public byte[] getBytes()

Return a byte array which represents the raw network address.

Specified by:

getBytes in class IpNetwork

Returns:

A byte array which represents the raw network address.

contains

public boolean contains(IpNetwork inw)

Determine whether this network contains the given IP host.

Specified by:

contains in class IpNetwork

Parameters:

inw - An IpNetwork instance to be tested. Note that this method assumes that this argument specifies the IP host, not IP network. So the CIDR prefix length configured in this argument is always ignored.

Returns:

true only if the IP network corresponding to this instance contains the IP network specified by inw.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class Object

Returns:

The hash code.