IPv4Address (OpenFlowJ-Loxi 3.2.0.onos API)

java.lang.Object
- org.projectfloodlight.openflow.types.IPAddress<IPv4Address>
- - org.projectfloodlight.openflow.types.IPv4Address

All Implemented Interfaces:

Comparable<IPv4Address>, Writeable, OFValueType<IPv4Address>, PrimitiveSinkable
```
public class IPv4Address
extends IPAddress<IPv4Address>
implements Writeable
```
Wrapper around an IPv4Address address

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static IPv4Address`	`FULL_MASK`
`static IPv4Address`	`NO_MASK`
`static IPv4Address`	`NONE`
`static org.projectfloodlight.openflow.types.IPv4Address.Reader`	`READER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPv4Address`	`and(IPv4Address other)` Perform a low level AND operation on the bits of two IPAddress objects
`IPv4Address`	`applyMask(IPv4Address mask)`
`int`	`asCidrMaskLength()` If this IPAddress represents a valid CIDR style netmask (see isCidrMask()) returns the length of the prefix (the number of "1" bits).
`int`	`compareTo(IPv4Address o)`
`boolean`	`equals(Object obj)`
`byte[]`	`getBytes()` Returns the raw IP address of this `IPAddress` object.
`int`	`getInt()`
`IPVersion`	`getIpVersion()` Returns the Internet Protocol (IP) version of this object
`int`	`getLength()`
`int`	`hashCode()`
`boolean`	`isBroadcast()` Checks if the IPAddress is the global broadcast address 255.255.255.255 in case of IPv4
`boolean`	`isCidrMask()` Checks if this IPAddress represents a valid CIDR style netmask, i.e., it has a set of leading "1" bits followed by only "0" bits
`boolean`	`isLinkLocal()` Returns `true` if the IPAddress is a link local address.
`boolean`	`isLoopback()` Returns `true` if the IPAddress is a loopback address.
`boolean`	`isMulticast()` IPv4 multicast addresses are defined by the leading address bits of 1110
`boolean`	`isUnspecified()` Returns `true` if the IPAddress is unspecified.
`IPv4Address`	`not()` Returns a new IPAddress object with the bits inverted
`static IPv4Address`	`of(byte[] address)` Returns an `IPv4Address` object that represents the given IP address.
`static IPv4Address`	`of(Inet4Address address)` Returns an `IPv4Address` object that represents the given IP address.
`static IPv4Address`	`of(int raw)` Returns an `IPv4Address` object that represents the given IP address.
`static IPv4Address`	`of(int octet1, int octet2, int octet3, int octet4)` Returns an `IPv4Address` object that represents the given IP address.
`static IPv4Address`	`of(String string)` Returns an `IPv4Address` object that represents the given IP address.
`static IPv4Address`	`ofCidrMaskLength(int cidrMaskLength)` Returns an `IPv4Address` object that represents the CIDR subnet mask of the given prefix length.
`IPv4Address`	`or(IPv4Address other)` Perform a low level OR operation on the bits of two IPAddress objects
`void`	`putTo(com.google.common.hash.PrimitiveSink sink)`
`static IPv4Address`	`read4Bytes(io.netty.buffer.ByteBuf c)`
`Inet4Address`	`toInetAddress()` Returns an `InetAddress` object representing this IP address.
`String`	`toString()`
`IPv4AddressWithMask`	`withMask(IPv4Address mask)` Returns an `IPv4AddressWithMask` object that represents this IP address masked by the given IP address mask.
`IPv4AddressWithMask`	`withMaskOfLength(int cidrMaskLength)` Returns an `IPv4AddressWithMask` object that represents this IP address masked by the CIDR subnet mask of the given prefix length.
`void`	`write4Bytes(io.netty.buffer.ByteBuf c)`
`void`	`writeTo(io.netty.buffer.ByteBuf bb)`

Methods inherited from class org.projectfloodlight.openflow.types.IPAddress
fromInetAddress, of

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

- Field Detail
  - NONE
```
public static final IPv4Address NONE
```
  - NO_MASK
```
public static final IPv4Address NO_MASK
```
  - FULL_MASK
```
public static final IPv4Address FULL_MASK
```
  - READER
```
public static final org.projectfloodlight.openflow.types.IPv4Address.Reader READER
```
- Method Detail
  - getIpVersion
```
public IPVersion getIpVersion()
```
    Description copied from class: IPAddress
    
    Returns the Internet Protocol (IP) version of this object
    
    Specified by:
    
    getIpVersion in class IPAddress<IPv4Address>
    
    Returns:
    
    the Internet Protocol (IP) version of this object
  - isCidrMask
```
public boolean isCidrMask()
```
    Description copied from class: IPAddress
    
    Checks if this IPAddress represents a valid CIDR style netmask, i.e., it has a set of leading "1" bits followed by only "0" bits
    
    Specified by:
    
    isCidrMask in class IPAddress<IPv4Address>
    
    Returns:
    
    true if this represents a valid CIDR style netmask, false otherwise
  - asCidrMaskLength
```
public int asCidrMaskLength()
```
    Description copied from class: IPAddress
    
    If this IPAddress represents a valid CIDR style netmask (see isCidrMask()) returns the length of the prefix (the number of "1" bits).
    
    Specified by:
    
    asCidrMaskLength in class IPAddress<IPv4Address>
    
    Returns:
    
    length of CIDR mask if this represents a valid CIDR mask
  - isUnspecified
```
public boolean isUnspecified()
```
    Description copied from class: IPAddress
    Returns true if the IPAddress is unspecified.
    The unspecified addresses, also known as the wildcard addresses, refer to:
    - the IPv4Address of 0.0.0.0
    - the IPv6Address of ::
    Specified by:
    
    isUnspecified in class IPAddress<IPv4Address>
    
    Returns:
    
    true if the IPAddress is unspecified, false otherwise
  - isLoopback
```
public boolean isLoopback()
```
    Description copied from class: IPAddress
    Returns true if the IPAddress is a loopback address.
    Loopback addresses refer to:
    - any IPv4Address within 127.0.0.0/8
    - the IPv6Address of ::1
    Specified by:
    
    isLoopback in class IPAddress<IPv4Address>
    
    Returns:
    
    true if the IPAddress is a loopback address, false otherwise
  - isLinkLocal
```
public boolean isLinkLocal()
```
    Description copied from class: IPAddress
    Returns true if the IPAddress is a link local address.
    Link local addresses refer to:
    - any IPv4Address within 169.254.0.0/16
    - any IPv6Address within fe80::/10
    Specified by:
    
    isLinkLocal in class IPAddress<IPv4Address>
    
    Returns:
    
    true if the IPAddress is a link local address, false otherwise
  - isBroadcast
```
public boolean isBroadcast()
```
    Description copied from class: IPAddress
    
    Checks if the IPAddress is the global broadcast address 255.255.255.255 in case of IPv4
    
    Specified by:
    
    isBroadcast in class IPAddress<IPv4Address>
    
    Returns:
    
    boolean true or false
  - isMulticast
```
public boolean isMulticast()
```
    IPv4 multicast addresses are defined by the leading address bits of 1110
    
    Specified by:
    
    isMulticast in class IPAddress<IPv4Address>
    
    Returns:
    
    boolean true or false
  - and
```
public IPv4Address and(IPv4Address other)
```
    Description copied from class: IPAddress
    
    Perform a low level AND operation on the bits of two IPAddress objects
    
    Specified by:
    
    and in class IPAddress<IPv4Address>
    
    Parameters:
    
    other - IPAddress
    
    Returns:
    
    new IPAddress object after the AND oper
  - or
```
public IPv4Address or(IPv4Address other)
```
    Description copied from class: IPAddress
    
    Perform a low level OR operation on the bits of two IPAddress objects
    
    Specified by:
    
    or in class IPAddress<IPv4Address>
    
    Parameters:
    
    other - IPAddress
    
    Returns:
    
    new IPAddress object after the AND oper
  - not
```
public IPv4Address not()
```
    Description copied from class: IPAddress
    
    Returns a new IPAddress object with the bits inverted
    
    Specified by:
    
    not in class IPAddress<IPv4Address>
    
    Returns:
    
    IPAddress
  - of
```
@Nonnull
public static IPv4Address of(@Nonnull
                                      byte[] address)
```
    Returns an IPv4Address object that represents the given IP address. The argument is in network byte order: the highest order byte of the address is in address[0].
    The address byte array must be 4 bytes long (32 bits long).
    Similar to InetAddress.getByAddress(byte[]).
    
    Parameters:
    
    address - the raw IP address in network byte order
    
    Returns:
    
    an IPv4Address object that represents the given raw IP address
    
    Throws:
    
    NullPointerException - if the given address was null
    
    IllegalArgumentException - if the given address was of an invalid byte array length
    
    See Also:
    
    InetAddress.getByAddress(byte[])
  - of
```
@Nonnull
public static IPv4Address of(int octet1,
                                      int octet2,
                                      int octet3,
                                      int octet4)
```
    Returns an IPv4Address object that represents the given IP address. The arguments are in network byte order: the highest order byte of the address is in octet1.
    For example, IPv4Address.of(192, 0, 2, 101) yields the IPv4 address of "192.0.2.101".
    Use caution when providing byte-typed values as arguments. "Byte-typed values" here refer to values that are of either the primitive byte type or the corresponding object wrapper class Byte. Byte-typed values greater than 127 are essentially negative values and will be casted to negative int values, thus failing the numeric range checks enforced by this method. Consider using of(byte[]) instead when handling byte-typed values.
    
    Parameters:
    
    octet1 - the highest order byte in network byte order
    
    octet2 - the 2nd-highest order byte in network byte order
    
    octet3 - the 2nd-lowest order byte in network byte order
    
    octet4 - the lowest order byte in network byte order
    
    Returns:
    
    an IPv4Address object that represents the given IP address
    
    Throws:
    
    IllegalArgumentException - if any of the octets were negative or greater than 255
  - of
```
@Nonnull
public static IPv4Address of(int raw)
```
    Returns an IPv4Address object that represents the given IP address.
    
    Parameters:
    
    raw - the raw IP address represented as a 32-bit integer
    
    Returns:
    
    an IPv4Address object that represents the given raw IP address
  - of
```
@Nonnull
public static IPv4Address of(@Nonnull
                                      String string)
                               throws IllegalArgumentException
```
    Returns an IPv4Address object that represents the given IP address. The argument is in the canonical quad-dotted notation. For example, 1.2.3.4.
    
    Parameters:
    
    string - the IP address in the canonical quad-dotted notation
    
    Returns:
    
    an IPv4Address object that represents the given IP address
    
    Throws:
    
    NullPointerException - if the given string was null
    
    IllegalArgumentException - if the given string was not a valid IPv4 address
  - of
```
@Nonnull
public static IPv4Address of(@Nonnull
                                      Inet4Address address)
```
    Returns an IPv4Address object that represents the given IP address. The argument is given as an Inet4Address object.
    
    Parameters:
    
    address - the IP address as an Inet4Address object
    
    Returns:
    
    an IPv4Address object that represents the given IP address
    
    Throws:
    
    NullPointerException - if the given Inet4Address was null
  - ofCidrMaskLength
```
@Nonnull
public static IPv4Address ofCidrMaskLength(int cidrMaskLength)
```
    Returns an IPv4Address object that represents the CIDR subnet mask of the given prefix length.
    
    Parameters:
    
    cidrMaskLength - the prefix length of the CIDR subnet mask (i.e. the number of leading one-bits), where 0 <= cidrMaskLength <= 32
    
    Returns:
    
    an IPv4Address object that represents the CIDR subnet mask of the given prefix length
    
    Throws:
    
    IllegalArgumentException - if the given prefix length was invalid
  - withMask
```
@Nonnull
public IPv4AddressWithMask withMask(@Nonnull
                                             IPv4Address mask)
```
    Returns an IPv4AddressWithMask object that represents this IP address masked by the given IP address mask.
    
    Specified by:
    
    withMask in class IPAddress<IPv4Address>
    
    Parameters:
    
    mask - the IPv4Address object that represents the mask
    
    Returns:
    
    an IPv4AddressWithMask object that represents this IP address masked by the given mask
    
    Throws:
    
    NullPointerException - if the given mask was null
  - withMaskOfLength
```
@Nonnull
public IPv4AddressWithMask withMaskOfLength(int cidrMaskLength)
```
    Returns an IPv4AddressWithMask object that represents this IP address masked by the CIDR subnet mask of the given prefix length.
    
    Specified by:
    
    withMaskOfLength in class IPAddress<IPv4Address>
    
    Parameters:
    
    cidrMaskLength - the prefix length of the CIDR subnet mask (i.e. the number of leading one-bits), where 0 <= cidrMaskLength <= 32
    
    Returns:
    
    an IPv4AddressWithMask object that represents this IP address masked by the CIDR subnet mask of the given prefix length
    
    Throws:
    
    IllegalArgumentException - if the given prefix length was invalid
    
    See Also:
    
    ofCidrMaskLength(int)
  - getInt
```
public int getInt()
```
  - getBytes
```
public byte[] getBytes()
```
    Description copied from class: IPAddress
    
    Returns the raw IP address of this IPAddress object. The result is in network byte order: the highest order byte of the address is in getBytes()[0].
    Similar to InetAddress.getAddress()
    
    Specified by:
    
    getBytes in class IPAddress<IPv4Address>
    
    Returns:
    
    the raw IP address of this object
    
    See Also:
    
    InetAddress.getAddress()
  - getLength
```
public int getLength()
```
    Specified by:
    
    getLength in interface OFValueType<IPv4Address>
  - toInetAddress
```
@Nonnull
public Inet4Address toInetAddress()
```
    Description copied from class: IPAddress
    Returns an InetAddress object representing this IP address.
    The resulting InetAddress object:
    - will not carry a hostname
    - will not carry a non-zero scope ID or scoped interface, in the case of Inet6Address
    Specified by:
    
    toInetAddress in class IPAddress<IPv4Address>
    
    Returns:
    
    an InetAddress object representing this IP address
  - toString
```
public String toString()
```
    Specified by:
    
    toString in class IPAddress<IPv4Address>
  - write4Bytes
```
public void write4Bytes(io.netty.buffer.ByteBuf c)
```
  - read4Bytes
```
public static IPv4Address read4Bytes(io.netty.buffer.ByteBuf c)
```
  - applyMask
```
public IPv4Address applyMask(IPv4Address mask)
```
    Specified by:
    
    applyMask in interface OFValueType<IPv4Address>
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in class IPAddress<IPv4Address>
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in class IPAddress<IPv4Address>
  - compareTo
```
public int compareTo(IPv4Address o)
```
    Specified by:
    
    compareTo in interface Comparable<IPv4Address>
  - putTo
```
public void putTo(com.google.common.hash.PrimitiveSink sink)
```
    Specified by:
    
    putTo in interface PrimitiveSinkable
  - writeTo
```
public void writeTo(io.netty.buffer.ByteBuf bb)
```
    Specified by:
    
    writeTo in interface Writeable

Class IPv4Address

Field Summary

Method Summary

Methods inherited from class org.projectfloodlight.openflow.types.IPAddress

Methods inherited from class java.lang.Object

Field Detail

NONE

NO_MASK

FULL_MASK

READER

Method Detail

getIpVersion

isCidrMask

asCidrMaskLength

isUnspecified

isLoopback

isLinkLocal

isBroadcast

isMulticast

and

or

not

of

of

of

of

of

ofCidrMaskLength

withMask

withMaskOfLength

getInt

getBytes

getLength

toInetAddress

toString

write4Bytes

read4Bytes

applyMask

hashCode

equals

compareTo

putTo

writeTo