org.projectfloodlight.openflow.types

Class Masked<T extends OFValueType<T>>

java.lang.Object

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

All Implemented Interfaces:

Comparable<Masked<T>>, OFValueType<Masked<T>>, PrimitiveSinkable

Direct Known Subclasses:

IPAddressWithMask, OFPortBitMap, OFPortBitMap512, OFVlanVidMatchWithMask

public class Masked<T extends OFValueType<T>>
extends Object
implements OFValueType<Masked<T>>

Field Summary

Fields

Modifier and Type	Field and Description
protected T	mask bitmask of the value.
protected T	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Masked(T value, T mask)

Method Summary

Modifier and Type	Method and Description
Masked<T>	applyMask(Masked<T> mask)
int	compareTo(Masked<T> o)
boolean	equals(Object obj)
int	getLength()
T	getMask()
T	getValue()
int	hashCode()
boolean	matches(T candidate) Determine whether candidate value is matched by this masked value (i.e., does candiate lie in the 'network/range' specified by this masked value).
static <T extends OFValueType<T>> Masked<T>	of(T value, T mask)
void	putTo(com.google.common.hash.PrimitiveSink sink) Dump the state of this object into a PrimitiveSink (e.g., a Hasher) for the purpose of computing a strong hash.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

protected final T extends OFValueType<T> value

mask

protected final T extends OFValueType<T> mask

bitmask of the value. Note: a set (1) bit in this mask means 'match on this value'. This the natural mask represenation as in IPv[46] netmasks. It is the inverse of the OpenFlow 1.0 'wildcard' meaning.

Constructor Detail

Masked

protected Masked(T value,
                 T mask)

Method Detail

getValue

public T getValue()

getMask

public T getMask()

of

public static <T extends OFValueType<T>> Masked<T> of(T value,
                                                      T mask)

getLength

public int getLength()

Specified by:

getLength in interface OFValueType<Masked<T extends OFValueType<T>>>

toString

public String toString()

Overrides:

toString in class Object

matches

public boolean matches(T candidate)

Determine whether candidate value is matched by this masked value (i.e., does candiate lie in the 'network/range' specified by this masked value).

Parameters:

candidate - the candidate value to test

Returns:

true iff the candidate lies in the area specified by this masked value.

applyMask

public Masked<T> applyMask(Masked<T> mask)

Specified by:

applyMask in interface OFValueType<Masked<T extends OFValueType<T>>>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Masked<T> o)

Specified by:

compareTo in interface Comparable<Masked<T extends OFValueType<T>>>

putTo

public void putTo(com.google.common.hash.PrimitiveSink sink)

Description copied from interface: PrimitiveSinkable

Dump the state of this object into a PrimitiveSink (e.g., a Hasher) for the purpose of computing a strong hash. Equality contract: Equal objects must dump the equal data into the sink, non-equal objects must dump different data into the sink. Please see the interface documentation of PrimitiveSink for more details and caveats/traps.

Specified by:

putTo in interface PrimitiveSinkable

Parameters:

sink - the sink to dump the object state into.