IpNetwork (vtn 0.6.4-SNAPSHOT API)

java.lang.Object
- org.opendaylight.vtn.manager.util.IpNetwork

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Ip4Network
```
public abstract class IpNetwork
extends Object
implements Serializable
```
IpNetwork describes an IP network. IP network is specified by an IP address and prefix length.

Since:

Lithium

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static char CIDR_SEPARATOR
A character that separates prefix length from IP address in CIDR notation.

Fields
Modifier and Type	Field and Description
`static char`	`CIDR_SEPARATOR` A character that separates prefix length from IP address in CIDR notation.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`abstract boolean`	`contains(IpNetwork inw)` Determine whether this network contains the given IP host.
`static IpNetwork`	`create(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address addr)` Create an `IpNetwork` instance which represents the IP network specified by the given `Address` instance.
`static IpNetwork`	`create(InetAddress iaddr)` Create an `IpNetwork` instance which represents the given IP address.
`static IpNetwork`	`create(InetAddress iaddr, int prefix)` Create an `IpNetwork` instance which represents the IP network specified by a pair of IP address and CIDR prefix.
`static IpNetwork`	`create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)` Create an `IpNetwork` instance which represents the IP address specified by the given `IpAddress` instance.
`static IpNetwork`	`create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix ipp)` Create an `IpNetwork` instance which represents the IP network specified by the given `IpPrefix` instance.
`static IpNetwork`	`create(String cidr)` Create an `IpNetwork` instance which represents the IP network specified by CIDR notation.
`abstract byte[]`	`getBytes()` Return a byte array which represents the raw network address.
`abstract String`	`getCidrText()` Return a string representation of this network in CIDR notation.
`String`	`getCidrValue()` Deprecated. Only for JAXB. Use `getCidrText()` instead.
`abstract String`	`getHostAddress()` Return a string representation of this network address without CIDR prefix.
`InetAddress`	`getInetAddress()` Return an `InetAddress` instance which represents the IP network address.
`static InetAddress`	`getInetAddress(byte[] bytes)` Create an `InetAddress` instance which represents the IP address specified by the given byte array.
`static InetAddress`	`getInetAddress(String text)` Create an `InetAddress` instance which represents the IP address specified by the given string.
`abstract 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.
`abstract 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.
`abstract int`	`getMaxPrefix()` Return the maximum length of the network prefix.
`abstract org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address`	`getMdAddress()` Return a MD-SAL IP address which represents this network address.
`int`	`getPrefixLength()` Return the length of network prefix.
`String`	`getText()` Return a string representation of IP network.
`boolean`	`isAddress()` Determine whether this instance represents an IP address or not.
`String`	`toString()` Return a string representation of this object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CIDR_SEPARATOR
```
public static final char CIDR_SEPARATOR
```
    A character that separates prefix length from IP address in CIDR notation.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getInetAddress
```
public static final InetAddress getInetAddress(byte[] bytes)
```
    Create an InetAddress instance which represents the IP address specified by the given byte array.
    
    Parameters:
    
    bytes - A byte array which represents the IP address.
    
    Returns:
    
    An InetAddress instance.
    
    Throws:
    
    IllegalArgumentException - The given byte array does not represent an IP network mask.
  - getInetAddress
```
public static final InetAddress getInetAddress(String text)
```
    Create an InetAddress instance which represents the IP address specified by the given string.
    
    Parameters:
    
    text - A string representation of an IP address.
    
    Returns:
    
    An InetAddress instance.
    
    Throws:
    
    NullPointerException - text is null.
    
    IllegalArgumentException - The given string does not represent an IP address.
  - create
```
public static final IpNetwork create(InetAddress iaddr)
```
    Create an IpNetwork instance which represents the given IP address.
    
    Parameters:
    
    iaddr - An InetAddress instance.
    
    Returns:
    
    An IpNetwork instance which represents the given IP address. Note that null is returned if iaddr is null.
    
    Throws:
    
    IllegalArgumentException - The given IP address is invalid.
  - create
```
public static final IpNetwork create(InetAddress iaddr,
                                     int prefix)
```
    Create an IpNetwork instance which represents the IP network specified by a pair of IP address and CIDR prefix.
    
    Parameters:
    
    iaddr - An InetAddress instance.
    
    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.
    
    Returns:
    
    An IpNetwork instance which represents the IP network specified by the given IP address and CIDR prefix. Note that null is returned if iaddr is null.
    
    Throws:
    
    IllegalArgumentException - The given IP address or prefix is invalid.
  - create
```
public static final IpNetwork create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix ipp)
```
    Create an IpNetwork instance which represents the IP network specified by the given IpPrefix instance.
    
    Parameters:
    
    ipp - An IpPrefix instance which represents the IP network.
    
    Returns:
    
    An IpNetwork instance which represents the IP network specified by ipp. Note that null is returned if ipp is null or it does not contain valid value.
    
    Throws:
    
    IllegalArgumentException - The given IpPrefix instance is invalid.
  - create
```
public static final IpNetwork create(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress ip)
```
    Create an IpNetwork instance which represents the IP address specified by the given IpAddress instance.
    
    Parameters:
    
    ip - An IpAddress instance which represents the IP address.
    
    Returns:
    
    An IpNetwork instance which represents the given IP address. Note that null is returned if ip is null or it does not contain valid value.
    
    Throws:
    
    IllegalArgumentException - The given IpAddress instance is invalid.
    
    Since:
    
    Beryllium
  - create
```
public static final IpNetwork create(org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address addr)
```
    Create an IpNetwork instance which represents the IP network specified by the given Address instance.
    
    Parameters:
    
    addr - An Address instance which represents the IP address.
    
    Returns:
    
    An IpNetwork instance which represents the IP network specified by addr. Note that null is returned if addr is null or it does not contain valid value.
    
    Throws:
    
    IllegalArgumentException - The given Address instance is invalid.
  - create
```
public static final IpNetwork create(String cidr)
```
    Create an IpNetwork instance which represents the IP network specified by CIDR notation.
    
    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.
    
    Returns:
    
    An IpNetwork instance which represents the IP network specified by cidr. Note that null is returned if cidr is null.
    
    Throws:
    
    IllegalArgumentException - The given network address is invalid.
  - getPrefixLength
```
public final int getPrefixLength()
```
    Return the length of network prefix.
    
    Returns:
    
    The prefix length.
  - getInetAddress
```
public final InetAddress getInetAddress()
```
    Return an InetAddress instance which represents the IP network address.
    
    Returns:
    
    An InetAddress instance.
  - getText
```
public final String getText()
```
    Return a string representation of IP network.
    If this instance represents a specific IP host, an IP address of the host without prefix length is returned. Otherwise a string which represents the IP network in CIDR notation is returned.
    
    Returns:
    
    A string representation of IP network.
  - isAddress
```
public final boolean isAddress()
```
    Determine whether this instance represents an IP address or not.
    
    Returns:
    
    true if this instance represents an IP address. false if this instance represents an IP network specified by a pair of network address and prefix length.
  - getMaxPrefix
```
public abstract int getMaxPrefix()
```
    Return the maximum length of the network prefix.
    
    Returns:
    
    The maximum length of the network prefix.
  - getIpPrefix
```
public abstract 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.
    
    Returns:
    
    An IpPrefix instance.
  - getIpAddress
```
public abstract 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.
    
    Returns:
    
    An IpAddress instance.
    
    Since:
    
    Beryllium
  - getMdAddress
```
public abstract org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.address.Address getMdAddress()
```
    Return a MD-SAL IP address which represents this network address.
    
    Returns:
    
    An Address instance.
  - getCidrText
```
public abstract String getCidrText()
```
    Return a string representation of this network in CIDR notation.
    
    Returns:
    
    A string representation of this network in CIDR notation.
  - getHostAddress
```
public abstract String getHostAddress()
```
    Return a string representation of this network address without CIDR prefix.
    
    Returns:
    
    A string representation of this network address.
  - getBytes
```
public abstract byte[] getBytes()
```
    Return a byte array which represents the raw network address.
    
    Returns:
    
    A byte array which represents the raw network address.
  - contains
```
public abstract boolean contains(IpNetwork inw)
```
    Determine whether this network contains the given IP host.
    
    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.
    
    Throws:
    
    NullPointerException - inw is null.
    
    IllegalArgumentException - This instance cannot test the given network.
  - getCidrValue
```
public final String getCidrValue()
```
    Deprecated. Only for JAXB. Use getCidrText() instead.
    
    Return a string representation of this network address in CIDR notation.
    
    Returns:
    
    A string representation of this network address.
  - toString
```
public final String toString()
```
    Return a string representation of this object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.

Class IpNetwork

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CIDR_SEPARATOR

Method Detail

getInetAddress

getInetAddress

create

create

create

create

create

create

getPrefixLength

getInetAddress

getText

isAddress

getMaxPrefix

getIpPrefix

getIpAddress

getMdAddress

getCidrText

getHostAddress

getBytes

contains

getCidrValue

toString