org.projectfloodlight.openflow.types

Class VlanVid

java.lang.Object

org.projectfloodlight.openflow.types.VlanVid

All Implemented Interfaces:

Comparable<VlanVid>, OFValueType<VlanVid>, PrimitiveSinkable

public class VlanVid
extends Object
implements OFValueType<VlanVid>

Represents an 802.1Q Vlan VID (12 bits).

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Field Summary

Fields

Modifier and Type	Field and Description
static VlanVid	FULL_MASK
static VlanVid	NO_MASK for use with masking operations
static VlanVid	ZERO this value means 'not set' in OF1.0 (e.g., in a match).

Method Summary

Modifier and Type	Method and Description
VlanVid	applyMask(VlanVid mask)
int	compareTo(VlanVid o)
boolean	equals(Object obj)
byte[]	getBytes()
int	getLength()
short	getVlan()
int	hashCode()
static VlanVid	ofVlan(int vid)
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.
static VlanVid	read2Bytes(io.netty.buffer.ByteBuf c)
String	toString()
void	write2Bytes(io.netty.buffer.ByteBuf c)
void	write2BytesOF10(io.netty.buffer.ByteBuf c)

Methods inherited from class java.lang.Object

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

Field Detail

ZERO

public static final VlanVid ZERO

this value means 'not set' in OF1.0 (e.g., in a match). not used elsewhere

NO_MASK

public static final VlanVid NO_MASK

for use with masking operations

FULL_MASK

public static final VlanVid FULL_MASK

Method Detail

ofVlan

public static VlanVid ofVlan(int vid)

getVlan

public short getVlan()

Returns:

the actual VLAN tag this vid identifies

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getLength

public int getLength()

Specified by:

getLength in interface OFValueType<VlanVid>

getBytes

public byte[] getBytes()

write2Bytes

public void write2Bytes(io.netty.buffer.ByteBuf c)

write2BytesOF10

public void write2BytesOF10(io.netty.buffer.ByteBuf c)

read2Bytes

public static VlanVid read2Bytes(io.netty.buffer.ByteBuf c)
                          throws OFParseError

Throws:

OFParseError

applyMask

public VlanVid applyMask(VlanVid mask)

Specified by:

applyMask in interface OFValueType<VlanVid>

compareTo

public int compareTo(VlanVid o)

Specified by:

compareTo in interface Comparable<VlanVid>

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.