org.onosproject.net.pi.runtime.data

Class PiHeaderUnion

java.lang.Object

org.onosproject.net.pi.runtime.data.PiHeaderUnion

All Implemented Interfaces:

PiData

@Beta
public final class PiHeaderUnion
extends Object
implements PiData

PiHeaderUnion entity in a protocol-independent pipeline.

Nested Class Summary

Nested classes/interfaces inherited from interface org.onosproject.net.pi.model.PiData

PiData.Type

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	hashCode()
PiHeader	header() Return the header.
String	headerName() Return the header name.
boolean	isValid() Returns true if this header is valid, false otherwise.
static PiHeaderUnion	of(String validHeaderName, PiHeader header) Returns a new valid protocol-independent header union.
static PiHeaderUnion	ofInvalid() Returns a new invalid protocol-independent header union.
String	toString()
PiData.Type	type() Returns the type of this protocol-independent data.

Methods inherited from class java.lang.Object

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

Method Detail

ofInvalid

public static PiHeaderUnion ofInvalid()

Returns a new invalid protocol-independent header union.

Returns:

header union

of

public static PiHeaderUnion of(String validHeaderName,
                               PiHeader header)

Returns a new valid protocol-independent header union.

Parameters:

validHeaderName - header name

header - the header

Returns:

header union

isValid

public boolean isValid()

Returns true if this header is valid, false otherwise.

Returns:

a boolean value

headerName

public String headerName()

Return the header name.

Returns:

header name, return null if the header union invalid

header

public PiHeader header()

Return the header.

Returns:

header, return null if the header union invalid

type

public PiData.Type type()

Description copied from interface: PiData

Returns the type of this protocol-independent data.

Specified by:

type in interface PiData

Returns:

the type of this instance

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object