Package org.onosproject.net.flow

Class DefaultTrafficTreatment

java.lang.Object

org.onosproject.net.flow.DefaultTrafficTreatment

All Implemented Interfaces:

TrafficTreatment

public final class DefaultTrafficTreatment
extends Object
implements TrafficTreatment

Default traffic treatment implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultTrafficTreatment.Builder	Builds a list of treatments following the following order.

Method Summary

Modifier and Type	Method	Description
List<Instruction>	allInstructions()	Returns the list of all instructions in the treatment, both immediate and deferred.
static TrafficTreatment.Builder	builder()	Returns a new traffic treatment builder.
static TrafficTreatment.Builder	builder(TrafficTreatment treatment)	Returns a new traffic treatment builder primed to produce entities patterned after the supplied treatment.
boolean	clearedDeferred()	Whether the deferred treatment instructions will be cleared by the device.
List<Instruction>	deferred()	Returns the list of treatment instructions that will be applied further down the pipeline.
static TrafficTreatment	emptyTreatment()	Returns an empty traffic treatment.
boolean	equals(Object obj)
int	hashCode()
List<Instruction>	immediate()	Returns the list of treatment instructions that will be applied immediately.
Instructions.MeterInstruction	metered()	Returns the meter instruction if there is one.
Set<Instructions.MeterInstruction>	meters()	Returns the meter instructions if there is any.
Instructions.StatTriggerInstruction	statTrigger()	Returns the stat trigger instruction if there is one.
Instructions.TableTypeTransition	tableTransition()	Returns the next table in the pipeline.
String	toString()
Instructions.MetadataInstruction	writeMetadata()	Returns the metadata instruction if there is one.

Methods inherited from class java.lang.Object

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

Method Detail

deferred

public List<Instruction> deferred()

Description copied from interface: TrafficTreatment

Returns the list of treatment instructions that will be applied further down the pipeline.

Specified by:

deferred in interface TrafficTreatment

Returns:

list of treatment instructions

immediate

public List<Instruction> immediate()

Description copied from interface: TrafficTreatment

Returns the list of treatment instructions that will be applied immediately.

Specified by:

immediate in interface TrafficTreatment

Returns:

list of treatment instructions

allInstructions

public List<Instruction> allInstructions()

Description copied from interface: TrafficTreatment

Returns the list of all instructions in the treatment, both immediate and deferred.

Specified by:

allInstructions in interface TrafficTreatment

Returns:

list of treatment instructions

tableTransition

public Instructions.TableTypeTransition tableTransition()

Description copied from interface: TrafficTreatment

Returns the next table in the pipeline.

Specified by:

tableTransition in interface TrafficTreatment

Returns:

a table transition; may be null.

clearedDeferred

public boolean clearedDeferred()

Description copied from interface: TrafficTreatment

Whether the deferred treatment instructions will be cleared by the device.

Specified by:

clearedDeferred in interface TrafficTreatment

Returns:

a boolean

writeMetadata

public Instructions.MetadataInstruction writeMetadata()

Description copied from interface: TrafficTreatment

Returns the metadata instruction if there is one.

Specified by:

writeMetadata in interface TrafficTreatment

Returns:

a metadata instruction that may be null

statTrigger

public Instructions.StatTriggerInstruction statTrigger()

Description copied from interface: TrafficTreatment

Returns the stat trigger instruction if there is one.

Specified by:

statTrigger in interface TrafficTreatment

Returns:

a stat trigger instruction; may be null.

metered

public Instructions.MeterInstruction metered()

Description copied from interface: TrafficTreatment

Returns the meter instruction if there is one.

Specified by:

metered in interface TrafficTreatment

Returns:

a meter instruction that may be a null.

meters

public Set<Instructions.MeterInstruction> meters()

Description copied from interface: TrafficTreatment

Returns the meter instructions if there is any.

Specified by:

meters in interface TrafficTreatment

Returns:

meter instructions that may be an empty set.

builder

public static TrafficTreatment.Builder builder()

Returns a new traffic treatment builder.

Returns:

traffic treatment builder

emptyTreatment

public static TrafficTreatment emptyTreatment()

Returns an empty traffic treatment.

Returns:

empty traffic treatment

builder

public static TrafficTreatment.Builder builder(TrafficTreatment treatment)

Returns a new traffic treatment builder primed to produce entities patterned after the supplied treatment.

Parameters:

treatment - base treatment

Returns:

traffic treatment builder

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