org.projectfloodlight.openflow.types

Class IPv4AddressWithMask

java.lang.Object

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

org.projectfloodlight.openflow.types.IPAddressWithMask<IPv4Address>

org.projectfloodlight.openflow.types.IPv4AddressWithMask

All Implemented Interfaces:

Comparable<Masked<IPv4Address>>, OFValueType<Masked<IPv4Address>>, PrimitiveSinkable

public class IPv4AddressWithMask
extends IPAddressWithMask<IPv4Address>

Field Summary

Fields

Modifier and Type	Field and Description
static IPv4AddressWithMask	NONE

Fields inherited from class org.projectfloodlight.openflow.types.Masked

mask, value

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(IPAddress<?> ip)
IPVersion	getIpVersion()
static IPv4AddressWithMask	of(int rawValue, int rawMask) Deprecated. replaced by IPv4Address.of(int) and IPv4Address.withMask(IPv4Address), e.g. IPv4Address.of(int).withMask(IPv4Address.of(int))
static IPv4AddressWithMask	of(IPv4Address value, IPv4Address mask) Returns an IPv4AddressWithMask object that represents the given IP address masked by the given IP address mask.
static IPv4AddressWithMask	of(String string) Returns an IPv4AddressWithMask object that corresponds to the given string in CIDR notation or other acceptable notations.

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

getSubnetBroadcastAddress, isSubnetBroadcastAddress, toString

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

applyMask, compareTo, equals, getLength, getMask, getValue, hashCode, matches, putTo

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final IPv4AddressWithMask NONE

Method Detail

getIpVersion

public IPVersion getIpVersion()

Specified by:

getIpVersion in class IPAddressWithMask<IPv4Address>

of

@Nonnull
@Deprecated
public static IPv4AddressWithMask of(int rawValue,
                                        int rawMask)

Deprecated. replaced by IPv4Address.of(int) and IPv4Address.withMask(IPv4Address), e.g. IPv4Address.of(int).withMask(IPv4Address.of(int))

Returns an IPv4AddressWithMask object that represents the given raw IP address masked by the given raw IP address mask.

Parameters:

rawValue - the raw IP address to be masked

rawMask - the raw IP address mask

Returns:

an IPv4AddressWithMask object that represents the given raw IP address masked by the given raw IP address mask

of

@Nonnull
public static IPv4AddressWithMask of(@Nonnull
                             IPv4Address value,
                             @Nonnull
                             IPv4Address mask)

Returns an IPv4AddressWithMask object that represents the given IP address masked by the given IP address mask. Both arguments are given as IPv4Address objects.

Parameters:

value - the IP address to be masked

mask - the IP address mask

Returns:

an IPv4AddressWithMask object that represents the given IP address masked by the given IP address mask

Throws:

NullPointerException - if any of the given IPv4Address objects were null

of

@Nonnull
public static IPv4AddressWithMask of(@Nonnull
                             String string)

Returns an IPv4AddressWithMask object that corresponds to the given string in CIDR notation or other acceptable notations.

The following notations are accepted.

Notation	Example	Notes
IPv4 address only	1.2.3.4	The subnet mask of prefix length 32 (i.e. 255.255.255.255) is assumed.
IPv4 address/mask	1.2.3.4/255.255.255.0
CIDR notation	1.2.3.4/24

Parameters:

string - the string in acceptable notations

Returns:

an IPv4AddressWithMask object that corresponds to the given string in acceptable notations

Throws:

NullPointerException - if the given string was null

IllegalArgumentException - if the given string was malformed

contains

public boolean contains(IPAddress<?> ip)

Specified by:

contains in class IPAddressWithMask<IPv4Address>