org.onosproject.net.flow

Class DefaultTrafficTreatment.Builder

java.lang.Object

org.onosproject.net.flow.DefaultTrafficTreatment.Builder

All Implemented Interfaces:

TrafficTreatment.Builder

Enclosing class:

DefaultTrafficTreatment

public static final class DefaultTrafficTreatment.Builder
extends Object
implements TrafficTreatment.Builder

Builds a list of treatments following the following order. Modifications -> Group -> Output (including drop)

Method Summary

Modifier and Type	Method and Description
DefaultTrafficTreatment.Builder	add(Instruction instruction) Adds an instruction to the builder.
TrafficTreatment	build() Builds an immutable traffic treatment descriptor.
void	drop() Adds a drop instruction and does not return a builder.
DefaultTrafficTreatment.Builder	popMpls() Pops MPLS ether type.
DefaultTrafficTreatment.Builder	pushMpls() Push MPLS ether type.
DefaultTrafficTreatment.Builder	setEthDst(org.onlab.packet.MacAddress addr) Sets the dst l2 address.
DefaultTrafficTreatment.Builder	setEthSrc(org.onlab.packet.MacAddress addr) Sets the src l2 address.
DefaultTrafficTreatment.Builder	setIpDst(org.onlab.packet.IpAddress addr) Sets the dst l3 address.
DefaultTrafficTreatment.Builder	setIpSrc(org.onlab.packet.IpAddress addr) Sets the src l3 address.
DefaultTrafficTreatment.Builder	setLambda(short lambda) Sets the optical channel ID or lambda.
DefaultTrafficTreatment.Builder	setMpls(Integer mplsLabel) Sets the mpls label.
DefaultTrafficTreatment.Builder	setOutput(PortNumber number) Set the output port.
DefaultTrafficTreatment.Builder	setVlanId(org.onlab.packet.VlanId id) Sets the vlan id.
DefaultTrafficTreatment.Builder	setVlanPcp(Byte pcp) Sets the vlan priority.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

add

public DefaultTrafficTreatment.Builder add(Instruction instruction)

Description copied from interface: TrafficTreatment.Builder

Adds an instruction to the builder.

Specified by:

add in interface TrafficTreatment.Builder

Parameters:

instruction - an instruction

Returns:

a treatment builder

drop

public void drop()

Description copied from interface: TrafficTreatment.Builder

Adds a drop instruction and does not return a builder.

Specified by:

drop in interface TrafficTreatment.Builder

setOutput

public DefaultTrafficTreatment.Builder setOutput(PortNumber number)

Description copied from interface: TrafficTreatment.Builder

Set the output port.

Specified by:

setOutput in interface TrafficTreatment.Builder

Parameters:

number - the out port

Returns:

a treatment builder

setEthSrc

public DefaultTrafficTreatment.Builder setEthSrc(org.onlab.packet.MacAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the src l2 address.

Specified by:

setEthSrc in interface TrafficTreatment.Builder

Parameters:

addr - a macaddress

Returns:

a treatment builder

setEthDst

public DefaultTrafficTreatment.Builder setEthDst(org.onlab.packet.MacAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the dst l2 address.

Specified by:

setEthDst in interface TrafficTreatment.Builder

Parameters:

addr - a macaddress

Returns:

a treatment builder

setVlanId

public DefaultTrafficTreatment.Builder setVlanId(org.onlab.packet.VlanId id)

Description copied from interface: TrafficTreatment.Builder

Sets the vlan id.

Specified by:

setVlanId in interface TrafficTreatment.Builder

Parameters:

id - a vlanid

Returns:

a treatment builder

setVlanPcp

public DefaultTrafficTreatment.Builder setVlanPcp(Byte pcp)

Description copied from interface: TrafficTreatment.Builder

Sets the vlan priority.

Specified by:

setVlanPcp in interface TrafficTreatment.Builder

Parameters:

pcp - a vlan priority

Returns:

a treatment builder

setIpSrc

public DefaultTrafficTreatment.Builder setIpSrc(org.onlab.packet.IpAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the src l3 address.

Specified by:

setIpSrc in interface TrafficTreatment.Builder

Parameters:

addr - an ip

Returns:

a treatment builder

setIpDst

public DefaultTrafficTreatment.Builder setIpDst(org.onlab.packet.IpAddress addr)

Description copied from interface: TrafficTreatment.Builder

Sets the dst l3 address.

Specified by:

setIpDst in interface TrafficTreatment.Builder

Parameters:

addr - an ip

Returns:

a treatment builder

pushMpls

public DefaultTrafficTreatment.Builder pushMpls()

Description copied from interface: TrafficTreatment.Builder

Push MPLS ether type.

Specified by:

pushMpls in interface TrafficTreatment.Builder

Returns:

a treatment builder.

popMpls

public DefaultTrafficTreatment.Builder popMpls()

Description copied from interface: TrafficTreatment.Builder

Pops MPLS ether type.

Specified by:

popMpls in interface TrafficTreatment.Builder

Returns:

a treatment builder.

setMpls

public DefaultTrafficTreatment.Builder setMpls(Integer mplsLabel)

Description copied from interface: TrafficTreatment.Builder

Sets the mpls label.

Specified by:

setMpls in interface TrafficTreatment.Builder

Parameters:

mplsLabel - MPLS label.

Returns:

a treatment builder.

setLambda

public DefaultTrafficTreatment.Builder setLambda(short lambda)

Description copied from interface: TrafficTreatment.Builder

Sets the optical channel ID or lambda.

Specified by:

setLambda in interface TrafficTreatment.Builder

Parameters:

lambda - optical channel ID

Returns:

a treatment builder

build

public TrafficTreatment build()

Description copied from interface: TrafficTreatment.Builder

Builds an immutable traffic treatment descriptor.

Specified by:

build in interface TrafficTreatment.Builder

Returns:

traffic treatment