org.onosproject.net.pi.runtime

Class PiHeaderFieldId

java.lang.Object

org.onlab.util.Identifier<String>

org.onosproject.net.pi.runtime.PiHeaderFieldId

public final class PiHeaderFieldId
extends Identifier<String>

Identifier of a packet's header field.

Field Summary

Fields inherited from class org.onlab.util.Identifier

identifier

Method Summary

Modifier and Type	Method and Description
String	fieldName() Returns the name of the field.
String	headerName() Returns the name of the header.
int	index() Returns the index of this header.
static PiHeaderFieldId	of(String headerName, String fieldName) Returns an header field identifier for the given header name and field name.
static PiHeaderFieldId	of(String headerName, String fieldName, int index) Returns an header field identifier for the given header name, field name and index.

Methods inherited from class org.onlab.util.Identifier

equals, hashCode, id, toString

Methods inherited from class java.lang.Object

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

Method Detail

of

public static PiHeaderFieldId of(String headerName,
                                 String fieldName,
                                 int index)

Returns an header field identifier for the given header name, field name and index.

Index represents the position of this header in the packet w.r.t. to other headers of the same type. Index 0 points to the first instance of the header, 1 the second one, etc. Helpful when dealing with stacked headers, e.g. to match on the second MPLS label.

Parameters:

headerName - header name

fieldName - field name

index - index

Returns:

header field identifier

of

public static PiHeaderFieldId of(String headerName,
                                 String fieldName)

Returns an header field identifier for the given header name and field name. Index is set to default value 0.

Parameters:

headerName - header name

fieldName - field name

Returns:

header field identifier

headerName

public String headerName()

Returns the name of the header.

Returns:

a string value

fieldName

public String fieldName()

Returns the name of the field.

Returns:

a string value

index

public int index()

Returns the index of this header.

Returns:

an integer value.