org.onosproject.net.flowobjective

Class DefaultNextObjective.Builder

java.lang.Object

org.onosproject.net.flowobjective.DefaultNextObjective.Builder

All Implemented Interfaces:

NextObjective.Builder, Objective.Builder

Enclosing class:

DefaultNextObjective

public static final class DefaultNextObjective.Builder
extends Object
implements NextObjective.Builder

Method Summary

Modifier and Type	Method and Description
NextObjective	add() Builds the next objective that will be added.
NextObjective	add(ObjectiveContext context) Builds the next objective that will be added.
NextObjective	addToExisting() Build the next objective that will be added, with Operation ADD_TO_EXISTING.
NextObjective	addToExisting(ObjectiveContext context) Builds the next objective that will be added, with Operation ADD_TO_EXISTING.
DefaultNextObjective.Builder	addTreatment(NextTreatment nextTreatment) Adds a next treatment to this next step.
DefaultNextObjective.Builder	addTreatment(TrafficTreatment treatment) Adds a treatment to this next step.
DefaultNextObjective.Builder	fromApp(ApplicationId appId) Specifies the application which applied the filter.
DefaultNextObjective.Builder	makePermanent() Noop.
DefaultNextObjective.Builder	makeTemporary(int timeout) Noop.
NextObjective	modify() Build the next objective that will be modified with Operation MODIFY.
NextObjective	modify(ObjectiveContext context) Build the next objective that will be modified, with Operation MODIFY.
NextObjective	remove() Builds the next objective that will be removed.
NextObjective	remove(ObjectiveContext context) Builds the next objective that will be removed.
NextObjective	removeFromExisting() Build the next objective that will be removed, with Operation REMOVE_FROM_EXISTING.
NextObjective	removeFromExisting(ObjectiveContext context) Builds the next objective that will be removed, with Operation REMOVE_FROM_EXISTING.
NextObjective	verify() Builds the next objective that needs to be verified.
NextObjective	verify(ObjectiveContext context) Builds the next objective that needs to be verified.
DefaultNextObjective.Builder	withId(int nextId) Specifies the id for this next objective.
DefaultNextObjective.Builder	withMeta(TrafficSelector meta) Set meta information related to this next objective.
DefaultNextObjective.Builder	withPriority(int priority) Noop.
DefaultNextObjective.Builder	withType(NextObjective.Type type) Sets the type of next step.

Methods inherited from class java.lang.Object

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

Method Detail

withId

public DefaultNextObjective.Builder withId(int nextId)

Description copied from interface: NextObjective.Builder

Specifies the id for this next objective.

Specified by:

withId in interface NextObjective.Builder

Parameters:

nextId - an integer

Returns:

a next objective builder

withType

public DefaultNextObjective.Builder withType(NextObjective.Type type)

Description copied from interface: NextObjective.Builder

Sets the type of next step.

Specified by:

withType in interface NextObjective.Builder

Parameters:

type - a type

Returns:

a next step builder

addTreatment

public DefaultNextObjective.Builder addTreatment(TrafficTreatment treatment)

Description copied from interface: NextObjective.Builder

Adds a treatment to this next step.

Specified by:

addTreatment in interface NextObjective.Builder

Parameters:

treatment - a traffic treatment

Returns:

a next step builder

addTreatment

public DefaultNextObjective.Builder addTreatment(NextTreatment nextTreatment)

Description copied from interface: NextObjective.Builder

Adds a next treatment to this next step.

Specified by:

addTreatment in interface NextObjective.Builder

Parameters:

nextTreatment - a next treatment

Returns:

a next step builder

makeTemporary

public DefaultNextObjective.Builder makeTemporary(int timeout)

Noop. This method has no effect.

Specified by:

makeTemporary in interface Objective.Builder

Parameters:

timeout - a timeout

Returns:

a next objective builder

makePermanent

public DefaultNextObjective.Builder makePermanent()

Noop. This method has no effect.

Specified by:

makePermanent in interface Objective.Builder

Returns:

a next objective builder

fromApp

public DefaultNextObjective.Builder fromApp(ApplicationId appId)

Description copied from interface: NextObjective.Builder

Specifies the application which applied the filter.

Specified by:

fromApp in interface NextObjective.Builder

Specified by:

fromApp in interface Objective.Builder

Parameters:

appId - an application id

Returns:

an objective builder

withPriority

public DefaultNextObjective.Builder withPriority(int priority)

Noop. This method has no effect.

Specified by:

withPriority in interface NextObjective.Builder

Specified by:

withPriority in interface Objective.Builder

Parameters:

priority - an integer

Returns:

a next objective builder

withMeta

public DefaultNextObjective.Builder withMeta(TrafficSelector meta)

Description copied from interface: NextObjective.Builder

Set meta information related to this next objective.

Specified by:

withMeta in interface NextObjective.Builder

Parameters:

meta - match conditions

Returns:

an objective builder

add

public NextObjective add()

Description copied from interface: NextObjective.Builder

Builds the next objective that will be added.

Specified by:

add in interface NextObjective.Builder

Specified by:

add in interface Objective.Builder

Returns:

a next objective

remove

public NextObjective remove()

Description copied from interface: NextObjective.Builder

Builds the next objective that will be removed.

Specified by:

remove in interface NextObjective.Builder

Specified by:

remove in interface Objective.Builder

Returns:

a next objective.

add

public NextObjective add(ObjectiveContext context)

Description copied from interface: NextObjective.Builder

Builds the next objective that will be added. The context will be used to notify the calling application.

Specified by:

add in interface NextObjective.Builder

Specified by:

add in interface Objective.Builder

Parameters:

context - an objective context

Returns:

a next objective

remove

public NextObjective remove(ObjectiveContext context)

Description copied from interface: NextObjective.Builder

Builds the next objective that will be removed. The context will be used to notify the calling application.

Specified by:

remove in interface NextObjective.Builder

Specified by:

remove in interface Objective.Builder

Parameters:

context - an objective context

Returns:

a next objective

addToExisting

public NextObjective addToExisting()

Description copied from interface: NextObjective.Builder

Build the next objective that will be added, with Operation ADD_TO_EXISTING.

Specified by:

addToExisting in interface NextObjective.Builder

Returns:

a next objective

removeFromExisting

public NextObjective removeFromExisting()

Description copied from interface: NextObjective.Builder

Build the next objective that will be removed, with Operation REMOVE_FROM_EXISTING.

Specified by:

removeFromExisting in interface NextObjective.Builder

Returns:

a next objective

addToExisting

public NextObjective addToExisting(ObjectiveContext context)

Description copied from interface: NextObjective.Builder

Builds the next objective that will be added, with Operation ADD_TO_EXISTING. The context will be used to notify the calling application.

Specified by:

addToExisting in interface NextObjective.Builder

Parameters:

context - an objective context

Returns:

a next objective

removeFromExisting

public NextObjective removeFromExisting(ObjectiveContext context)

Description copied from interface: NextObjective.Builder

Builds the next objective that will be removed, with Operation REMOVE_FROM_EXISTING. The context will be used to notify the calling application.

Specified by:

removeFromExisting in interface NextObjective.Builder

Parameters:

context - an objective context

Returns:

a next objective

modify

public NextObjective modify()

Description copied from interface: NextObjective.Builder

Build the next objective that will be modified with Operation MODIFY.

Specified by:

modify in interface NextObjective.Builder

Returns:

a next objective

modify

public NextObjective modify(ObjectiveContext context)

Description copied from interface: NextObjective.Builder

Build the next objective that will be modified, with Operation MODIFY. The context will be used to notify the calling application.

Specified by:

modify in interface NextObjective.Builder

Parameters:

context - an objective context

Returns:

a next objective

verify

public NextObjective verify()

Description copied from interface: NextObjective.Builder

Builds the next objective that needs to be verified.

Specified by:

verify in interface NextObjective.Builder

Returns:

a next objective with Operation VERIFY

verify

public NextObjective verify(ObjectiveContext context)

Description copied from interface: NextObjective.Builder

Builds the next objective that needs to be verified. The context will be used to notify the calling application.

Specified by:

verify in interface NextObjective.Builder

Parameters:

context - an objective context

Returns:

a next objective with Operation VERIFY