OFVlanVidMatch (OpenFlowJ-Loxi 3.5.558 API)

java.lang.Object
- org.projectfloodlight.openflow.types.OFVlanVidMatch

All Implemented Interfaces:

Comparable<OFVlanVidMatch>, OFValueType<OFVlanVidMatch>, PrimitiveSinkable
```
public class OFVlanVidMatch
extends Object
implements OFValueType<OFVlanVidMatch>
```
Represents an OpenFlow Vlan VID for use in Matches, as specified by the OpenFlow 1.3 spec. Note: this is not just the 12-bit vlan tag. OpenFlow defines the additional mask bits 0x1000 to represent the presence of a vlan tag. This additional bit will be stripped when writing a OF1.0 value tag.

Author:

Andreas Wundsam <andreas.wundsam@bigswitch.com>

Field Summary

Fields
Modifier and Type	Field and Description
`static OFVlanVidMatch`	`FULL_MASK`
`static OFVlanVidMatch`	`NO_MASK` for use with masking operations
`static OFVlanVidMatch`	`NONE` this value means 'not set' in OF1.0 (e.g., in a match).
`static OFVlanVidMatch`	`PRESENT` presence of a VLAN tag is indicated by the presence of bit 0x1000
`static OFVlanVidMatch`	`UNTAGGED` an untagged packet is specified as 0000 in OF 1.0, but 0xFFFF in OF1.0.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OFVlanVidMatch`	`applyMask(OFVlanVidMatch mask)`
`int`	`compareTo(OFVlanVidMatch o)`
`boolean`	`equals(Object obj)`
`byte[]`	`getBytes()`
`int`	`getLength()`
`short`	`getRawVid()`
`short`	`getVlan()`
`VlanVid`	`getVlanVid()`
`int`	`hashCode()`
`boolean`	`isPresentBitSet()`
`static OFVlanVidMatch`	`ofRawVid(short vid)`
`static OFVlanVidMatch`	`ofVlan(int vlan)`
`static OFVlanVidMatch`	`ofVlanOF10(short of10vlan)`
`static OFVlanVidMatch`	`ofVlanVid(VlanVid 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 OFVlanVidMatch`	`read2Bytes(io.netty.buffer.ByteBuf c)`
`static OFVlanVidMatch`	`read2BytesOF10(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
  - PRESENT
```
public static final OFVlanVidMatch PRESENT
```
    presence of a VLAN tag is indicated by the presence of bit 0x1000
  - NONE
```
public static final OFVlanVidMatch NONE
```
    this value means 'not set' in OF1.0 (e.g., in a match). not used elsewhere
  - NO_MASK
```
public static final OFVlanVidMatch NO_MASK
```
    for use with masking operations
  - FULL_MASK
```
public static final OFVlanVidMatch FULL_MASK
```
  - UNTAGGED
```
public static final OFVlanVidMatch UNTAGGED
```
    an untagged packet is specified as 0000 in OF 1.0, but 0xFFFF in OF1.0. Special case that.
- Method Detail
  - ofRawVid
```
public static OFVlanVidMatch ofRawVid(short vid)
```
  - ofVlanVid
```
public static OFVlanVidMatch ofVlanVid(VlanVid vid)
```
  - ofVlan
```
public static OFVlanVidMatch ofVlan(int vlan)
```
  - ofVlanOF10
```
public static OFVlanVidMatch ofVlanOF10(short of10vlan)
```
  - isPresentBitSet
```
public boolean isPresentBitSet()
```
    Returns:
    
    whether or not this VlanId has the present (0x1000) bit set
  - getVlan
```
public short getVlan()
```
    Returns:
    
    the actual VLAN tag this vid identifies
  - getVlanVid
```
@Nullable
public VlanVid getVlanVid()
```
    Returns:
    
    the actual vlan tag this vid identifies as a VlanVid object, if this VlanVidMatch has the present bit set (i.e., identifies a tagged VLAN). Else, returns null.
  - 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
  - getRawVid
```
public short getRawVid()
```
  - getLength
```
public int getLength()
```
    Specified by:
    
    getLength in interface OFValueType<OFVlanVidMatch>
  - 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 OFVlanVidMatch read2Bytes(io.netty.buffer.ByteBuf c)
                                 throws OFParseError
```
    Throws:
    
    OFParseError
  - read2BytesOF10
```
public static OFVlanVidMatch read2BytesOF10(io.netty.buffer.ByteBuf c)
                                     throws OFParseError
```
    Throws:
    
    OFParseError
  - applyMask
```
public OFVlanVidMatch applyMask(OFVlanVidMatch mask)
```
    Specified by:
    
    applyMask in interface OFValueType<OFVlanVidMatch>
  - compareTo
```
public int compareTo(OFVlanVidMatch o)
```
    Specified by:
    
    compareTo in interface Comparable<OFVlanVidMatch>
  - 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.

Class OFVlanVidMatch

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRESENT

NONE

NO_MASK

FULL_MASK

UNTAGGED

Method Detail

ofRawVid

ofVlanVid

ofVlan

ofVlanOF10

isPresentBitSet

getVlan

getVlanVid

equals

hashCode

toString

getRawVid

getLength

getBytes

write2Bytes

write2BytesOF10

read2Bytes

read2BytesOF10

applyMask

compareTo

putTo