org.onosproject.mapping

Class DefaultMappingTreatment.Builder

java.lang.Object

org.onosproject.mapping.DefaultMappingTreatment.Builder

All Implemented Interfaces:

MappingTreatment.Builder

Enclosing class:

DefaultMappingTreatment

public static final class DefaultMappingTreatment.Builder
extends Object
implements MappingTreatment.Builder

Builds a mapping treatment.

Method Summary

Modifier and Type	Method and Description
DefaultMappingTreatment.Builder	add(MappingInstruction instruction) Specifies a collection of mapping instructions.
MappingTreatment	build() Builds an immutable mapping treatment.
DefaultMappingTreatment.Builder	extension(org.onosproject.net.flow.instructions.ExtensionTreatment extension, org.onosproject.net.DeviceId deviceId) uses an extension treatment.
DefaultMappingTreatment.Builder	setMulticastPriority(int priority) Adds a multicast priority instruction.
DefaultMappingTreatment.Builder	setMulticastWeight(int weight) Adds a multicast weight instruction.
DefaultMappingTreatment.Builder	setUnicastPriority(int priority) Adds an unicast priority instruction.
DefaultMappingTreatment.Builder	setUnicastWeight(int weight) Adds an unicast weight instruction.
DefaultMappingTreatment.Builder	withAddress(MappingAddress address) Specifies a mapping address.

Methods inherited from class java.lang.Object

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

Method Detail

withAddress

public DefaultMappingTreatment.Builder withAddress(MappingAddress address)

Description copied from interface: MappingTreatment.Builder

Specifies a mapping address.

Specified by:

withAddress in interface MappingTreatment.Builder

Parameters:

address - mapping address

Returns:

a mapping treatment builder

add

public DefaultMappingTreatment.Builder add(MappingInstruction instruction)

Description copied from interface: MappingTreatment.Builder

Specifies a collection of mapping instructions.

Specified by:

add in interface MappingTreatment.Builder

Parameters:

instruction - a mapping instruction

Returns:

a mapping treatment builder

setUnicastWeight

public DefaultMappingTreatment.Builder setUnicastWeight(int weight)

Description copied from interface: MappingTreatment.Builder

Adds an unicast weight instruction.

Specified by:

setUnicastWeight in interface MappingTreatment.Builder

Parameters:

weight - unicast weight value

Returns:

a mapping treatment builder

setUnicastPriority

public DefaultMappingTreatment.Builder setUnicastPriority(int priority)

Description copied from interface: MappingTreatment.Builder

Adds an unicast priority instruction.

Specified by:

setUnicastPriority in interface MappingTreatment.Builder

Parameters:

priority - unicast priority value

Returns:

a mapping treatment builder

setMulticastWeight

public DefaultMappingTreatment.Builder setMulticastWeight(int weight)

Description copied from interface: MappingTreatment.Builder

Adds a multicast weight instruction.

Specified by:

setMulticastWeight in interface MappingTreatment.Builder

Parameters:

weight - multicast weight value

Returns:

a mapping treatment builder

setMulticastPriority

public DefaultMappingTreatment.Builder setMulticastPriority(int priority)

Description copied from interface: MappingTreatment.Builder

Adds a multicast priority instruction.

Specified by:

setMulticastPriority in interface MappingTreatment.Builder

Parameters:

priority - multicast priority value

Returns:

a mapping treatment builder

extension

public DefaultMappingTreatment.Builder extension(org.onosproject.net.flow.instructions.ExtensionTreatment extension,
                                                 org.onosproject.net.DeviceId deviceId)

Description copied from interface: MappingTreatment.Builder

uses an extension treatment.

Specified by:

extension in interface MappingTreatment.Builder

Parameters:

extension - extension treatment

deviceId - device identifier

Returns:

a treatment builder

build

public MappingTreatment build()

Description copied from interface: MappingTreatment.Builder

Builds an immutable mapping treatment.

Specified by:

build in interface MappingTreatment.Builder

Returns:

a mapping treatment