Package io.github.zhh2001.jp4.pipeline

Record Class MatchFieldInfo

java.lang.Object
java.lang.Record
io.github.zhh2001.jp4.pipeline.MatchFieldInfo
Record Components:
id - P4Runtime numeric id (1-based, unique within the owning table)
name - fully-qualified field name as written in the P4 program, e.g. "hdr.ipv4.dstAddr"
matchKind - one of MatchFieldInfo.Kind.EXACT, MatchFieldInfo.Kind.LPM, MatchFieldInfo.Kind.TERNARY, MatchFieldInfo.Kind.RANGE, MatchFieldInfo.Kind.OPTIONAL, or MatchFieldInfo.Kind.UNSPECIFIED
bitWidth - width of the field as declared in the P4 program (e.g. 32 for IPv4, 48 for MAC)
public record MatchFieldInfo(int id, String name, MatchFieldInfo.Kind matchKind, int bitWidth) extends Record
Read-only metadata for one match field of a TableInfo, derived from P4Info.
Since:
0.1.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    MatchFieldInfo.Kind
    Mirrors P4Runtime's MatchField.MatchType enum at the public-API layer so callers don't depend on generated protobuf types.

  • Constructor Summary

    Constructors
    Constructor
    Description
    MatchFieldInfo(int id, String name, MatchFieldInfo.Kind matchKind, int bitWidth)
    Creates an instance of a MatchFieldInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    bitWidth()
    Returns the value of the bitWidth record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    id()
    Returns the value of the id record component.
    MatchFieldInfo.Kind
    matchKind()
    Returns the value of the matchKind record component.
    String
    name()
    Returns the value of the name record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • MatchFieldInfo

      public MatchFieldInfo(int id, String name, MatchFieldInfo.Kind matchKind, int bitWidth)
      Creates an instance of a MatchFieldInfo record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      matchKind - the value for the matchKind record component
      bitWidth - the value for the bitWidth record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public int id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • matchKind

      public MatchFieldInfo.Kind matchKind()
      Returns the value of the matchKind record component.
      Returns:
      the value of the matchKind record component

    • bitWidth

      public int bitWidth()
      Returns the value of the bitWidth record component.
      Returns:
      the value of the bitWidth record component