Package org.opendaylight.openflowjava.nx.codec.match

Class NxmHeader

java.lang.Object
org.opendaylight.openflowjava.nx.codec.match.NxmHeader
public final class NxmHeader extends Object
Nxm header.
Author:
msunal

  • Constructor Summary

    Constructors
    Constructor
    Description
    NxmHeader(int nxmField, boolean hasMask, int length, long experimenterId)
    Build a experimenter header from it's constituent fields.
    NxmHeader(int oxmClass, int nxmField, boolean hasMask, int length)
    Build a non experimenter header from it's constituent fields.
    NxmHeader(long header)
    Builds a NxmHeader from a long representation.
    NxmHeader(org.opendaylight.yangtools.yang.common.Uint64 header)
    Builds a NxmHeader from a BigInteger representation, that is, one for which BigInteger.longValue() produces a valid long representation.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    long
    getExperimenterId()
     
    int
    getLength()
     
    int
    getNxmField()
     
    int
    getOxmClass()
     
    int
    hashCode()
     
    boolean
    isExperimenter()
     
    static boolean
    isExperimenter(org.opendaylight.yangtools.yang.common.Uint64 uint)
     
    boolean
    isHasMask()
     
    long
    toLong()
    Returns the long representation of the header.
    String
    toString()
     
    org.opendaylight.yangtools.yang.common.Uint64
    toUint64()
    Returns the Uint64 representation of the header.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • NxmHeader

      public NxmHeader(org.opendaylight.yangtools.yang.common.Uint64 header)
      Builds a NxmHeader from a BigInteger representation, that is, one for which BigInteger.longValue() produces a valid long representation.
      Parameters:
      header - the header as BigInteger.
      See Also:

    • NxmHeader

      public NxmHeader(long header)
      Builds a NxmHeader from a long representation. For non experimenter, the 4 byte header are the least significant of the long, being the other 4 most significant bytes 0. For experimenter, the full 8 byte constitute the header, being the 4 least significant the experimenter id.
      Parameters:
      header - the header as a long.

    • NxmHeader

      public NxmHeader(int oxmClass, int nxmField, boolean hasMask, int length)
      Build a non experimenter header from it's constituent fields.
      Parameters:
      oxmClass - the OXM class.
      nxmField - the NXM field.
      hasMask - the hasMask field.
      length - the length field.

    • NxmHeader

      public NxmHeader(int nxmField, boolean hasMask, int length, long experimenterId)
      Build a experimenter header from it's constituent fields. The OXM class will be set to 0xFFFF.
      Parameters:
      nxmField - the NXM field.
      hasMask - the hasMask field.
      length - the length field.
      experimenterId - the esperimenter id field.

  • Method Details

    • toUint64

      public org.opendaylight.yangtools.yang.common.Uint64 toUint64()
      Returns the Uint64 representation of the header.
      Returns:
      the header.
      See Also:

    • toLong

      public long toLong()
      Returns the long representation of the header.
      Returns:
      the header.
      See Also:

    • getOxmClass

      public int getOxmClass()

    • getNxmField

      public int getNxmField()

    • isHasMask

      public boolean isHasMask()

    • getLength

      public int getLength()

    • getExperimenterId

      public long getExperimenterId()

    • isExperimenter

      public boolean isExperimenter()

    • isExperimenter

      public static boolean isExperimenter(org.opendaylight.yangtools.yang.common.Uint64 uint)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object