org.onosproject.net.pi.model

Interface PiHeaderTypeModel

@Beta
public interface PiHeaderTypeModel

Model of a header type in a protocol-independent pipeline.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<PiHeaderFieldTypeModel>	field(java.lang.String fieldName) Returns the field type model defined by the given name, if present.
java.util.List<PiHeaderFieldTypeModel>	fields() Returns a list of field type models for this header type, ordered according to the same order of header fields as defined in the pipeline model.
java.lang.String	name() Returns the name of this header type.

Method Detail

name

java.lang.String name()

Returns the name of this header type.

Returns:

name

field

java.util.Optional<PiHeaderFieldTypeModel> field(java.lang.String fieldName)

Returns the field type model defined by the given name, if present.

Parameters:

fieldName - field name

Returns:

optional field type model

fields

java.util.List<PiHeaderFieldTypeModel> fields()

Returns a list of field type models for this header type, ordered according to the same order of header fields as defined in the pipeline model.

Returns:

list of field type models