org.projectfloodlight.openflow.types

Class IPAddress<F extends IPAddress<F>>

java.lang.Object

org.projectfloodlight.openflow.types.IPAddress<F>

All Implemented Interfaces:

Comparable<F>, OFValueType<F>, PrimitiveSinkable

Direct Known Subclasses:

IPv4Address, IPv6Address

public abstract class IPAddress<F extends IPAddress<F>>
extends Object
implements OFValueType<F>

Constructor Summary

Constructors

Constructor and Description
IPAddress()

Method Summary

Methods

Modifier and Type	Method and Description
abstract F	and(F other) Perform a low level AND operation on the bits of two IPAddress objects
abstract int	asCidrMaskLength() If this IPAddress represents a valid CIDR style netmask (see isCidrMask()) returns the length of the prefix (the number of "1" bits).
abstract boolean	equals(Object other)
static IPAddress<?>	fromInetAddress(InetAddress address) Deprecated. replaced by of(InetAddress)
abstract byte[]	getBytes() Returns the raw IP address of this IPAddress object.
abstract IPVersion	getIpVersion() Returns the Internet Protocol (IP) version of this object
abstract int	hashCode()
abstract boolean	isBroadcast() Checks if the IPAddress is the global broadcast address 255.255.255.255 in case of IPv4
abstract 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
abstract boolean	isLinkLocal() Returns true if the IPAddress is a link local address.
abstract boolean	isLoopback() Returns true if the IPAddress is a loopback address.
abstract boolean	isMulticast() Checks if the IPAddress is the multicast address
abstract boolean	isUnspecified() Returns true if the IPAddress is unspecified.
abstract F	not() Returns a new IPAddress object with the bits inverted
static IPAddress<?>	of(InetAddress address) Factory function for InetAddress values.
static IPAddress<?>	of(String ip) parse an IPv4Address or IPv6Address from their conventional string representation.
abstract F	or(F other) Perform a low level OR operation on the bits of two IPAddress objects
abstract InetAddress	toInetAddress() Returns an InetAddress object representing this IP address.
abstract String	toString()
abstract IPAddressWithMask<F>	withMask(F mask) Returns an IPAddressWithMask<F> object that represents this IP address masked by the given IP address mask.
abstract IPAddressWithMask<F>	withMaskOfLength(int cidrMaskLength) Returns an IPAddressWithMask<F> object that represents this IP address masked by the CIDR subnet mask of the given prefix length.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.projectfloodlight.openflow.types.OFValueType

applyMask, getLength

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.projectfloodlight.openflow.types.PrimitiveSinkable

putTo

Constructor Detail

IPAddress

public IPAddress()

Method Detail

getIpVersion

public abstract IPVersion getIpVersion()

Returns the Internet Protocol (IP) version of this object

Returns:

the Internet Protocol (IP) version of this object

isCidrMask

public abstract 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

Returns:

true if this represents a valid CIDR style netmask, false otherwise

asCidrMaskLength

public abstract int asCidrMaskLength()

If this IPAddress represents a valid CIDR style netmask (see isCidrMask()) returns the length of the prefix (the number of "1" bits).

Returns:

length of CIDR mask if this represents a valid CIDR mask

Throws:

IllegalStateException - if isCidrMask() == false

isUnspecified

public abstract boolean isUnspecified()

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 ::

Returns:

true if the IPAddress is unspecified, false otherwise

isLoopback

public abstract boolean isLoopback()

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

Returns:

true if the IPAddress is a loopback address, false otherwise

isLinkLocal

public abstract boolean isLinkLocal()

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

Returns:

true if the IPAddress is a link local address, false otherwise

isBroadcast

public abstract boolean isBroadcast()

Checks if the IPAddress is the global broadcast address 255.255.255.255 in case of IPv4

Returns:

boolean true or false

isMulticast

public abstract boolean isMulticast()

Checks if the IPAddress is the multicast address

Returns:

boolean true or false

and

public abstract F and(F other)

Perform a low level AND operation on the bits of two IPAddress objects

Parameters:

other - IPAddress

Returns:

new IPAddress object after the AND oper

or

public abstract F or(F other)

Perform a low level OR operation on the bits of two IPAddress objects

Parameters:

other - IPAddress

Returns:

new IPAddress object after the AND oper

not

public abstract F not()

Returns a new IPAddress object with the bits inverted

Returns:

IPAddress

withMask

@Nonnull
public abstract IPAddressWithMask<F> withMask(@Nonnull
                                    F mask)

Returns an IPAddressWithMask<F> object that represents this IP address masked by the given IP address mask.

Parameters:

mask - the F object that represents the mask

Returns:

an IPAddressWithMask<F> object that represents this IP address masked by the given mask

Throws:

NullPointerException - if the given mask was null

withMaskOfLength

@Nonnull
public abstract IPAddressWithMask<F> withMaskOfLength(int cidrMaskLength)

Returns an IPAddressWithMask<F> object that represents this IP address masked by 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 <= (F.getLength() * 8)

Returns:

an IPAddressWithMask<F> 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:

IPv4Address.ofCidrMaskLength(int), IPv6Address.ofCidrMaskLength(int)

getBytes

public abstract byte[] getBytes()

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()

Returns:

the raw IP address of this object

See Also:

InetAddress.getAddress()

toInetAddress

@Nonnull
public abstract InetAddress toInetAddress()

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

Returns:

an InetAddress object representing this IP address

toString

public abstract String toString()

Overrides:

toString in class Object

equals

public abstract boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

of

@Nonnull
public static IPAddress<?> of(@Nonnull
                      String ip)

parse an IPv4Address or IPv6Address from their conventional string representation. For details on supported representations, refer to IPv4Address.of(String) and IPv6Address.of(String)

Parameters:

ip - a string representation of an IP address

Returns:

the parsed IP address

Throws:

NullPointerException - if ip is null

IllegalArgumentException - if string is not a valid IP address

of

@Nonnull
public static IPAddress<?> of(@Nonnull
                      InetAddress address)

Factory function for InetAddress values.

Parameters:

address - the InetAddress you wish to parse into an IPAddress object.

Returns:

the IPAddress object.

Throws:

NullPointerException - if address is null

fromInetAddress

@Deprecated
@Nonnull
public static IPAddress<?> fromInetAddress(@Nonnull
                                              InetAddress address)

Deprecated. replaced by of(InetAddress)

Factory function for InetAddress values.

Parameters:

address - the InetAddress you wish to parse into an IPAddress object.

Returns:

the IPAddress object.

Throws:

NullPointerException - if address is null