Package org.onosproject.net.flowobjective

Interface FilteringObjective.Builder

All Superinterfaces:

Objective.Builder

All Known Implementing Classes:

DefaultFilteringObjective.Builder

Enclosing interface:

FilteringObjective

public static interface FilteringObjective.Builder
extends Objective.Builder

Builder of Filtering objective entities.

Method Summary

Modifier and Type	Method	Description
FilteringObjective	add()	Builds the filtering objective that will be added.
FilteringObjective	add(ObjectiveContext context)	Builds the filtering objective that will be added.
FilteringObjective.Builder	addCondition(Criterion criterion)	Add a filtering condition.
FilteringObjective.Builder	deny()	Deny this filtering condition set.
FilteringObjective.Builder	fromApp(ApplicationId appId)	Assigns an application id.
FilteringObjective.Builder	makePermanent()	Makes the filtering objective permanent.
FilteringObjective.Builder	permit()	Permit this filtering condition set.
FilteringObjective	remove()	Builds the filtering objective that will be removed.
FilteringObjective	remove(ObjectiveContext context)	Builds the filtering objective that will be removed.
FilteringObjective.Builder	withAnnotations(Annotations annotations)	Adds annotations to the filtering objective.
FilteringObjective.Builder	withKey(Criterion key)	Specify the key for the filter.
FilteringObjective.Builder	withMeta(TrafficTreatment treatment)	Set meta information about this filtering condition set.
FilteringObjective.Builder	withPriority(int priority)	Sets the priority for this objective.

Methods inherited from interface org.onosproject.net.flowobjective.Objective.Builder

makeTemporary

Method Detail

withKey

FilteringObjective.Builder withKey(Criterion key)

Specify the key for the filter.

Parameters:

key - a criterion

Returns:

a filter objective builder

addCondition

FilteringObjective.Builder addCondition(Criterion criterion)

Add a filtering condition.

Parameters:

criterion - new criterion

Returns:

a filtering builder

permit

FilteringObjective.Builder permit()

Permit this filtering condition set.

Returns:

a filtering builder

deny

FilteringObjective.Builder deny()

Deny this filtering condition set.

Returns:

a filtering builder

withMeta

FilteringObjective.Builder withMeta(TrafficTreatment treatment)

Set meta information about this filtering condition set.

Parameters:

treatment - traffic treatment to use

Returns:

a filtering builder

fromApp

FilteringObjective.Builder fromApp(ApplicationId appId)

Assigns an application id.

Specified by:

fromApp in interface Objective.Builder

Parameters:

appId - an application id

Returns:

a filtering builder

withPriority

FilteringObjective.Builder withPriority(int priority)

Sets the priority for this objective.

Specified by:

withPriority in interface Objective.Builder

Parameters:

priority - an integer

Returns:

an objective builder

makePermanent

FilteringObjective.Builder makePermanent()

Makes the filtering objective permanent.

Specified by:

makePermanent in interface Objective.Builder

Returns:

an objective builder

withAnnotations

FilteringObjective.Builder withAnnotations(Annotations annotations)

Adds annotations to the filtering objective.

Specified by:

withAnnotations in interface Objective.Builder

Parameters:

annotations - the annotations for the filtering objective

Returns:

a filtering objective builder

add

FilteringObjective add()

Builds the filtering objective that will be added.

Specified by:

add in interface Objective.Builder

Returns:

a filtering objective

remove

FilteringObjective remove()

Builds the filtering objective that will be removed.

Specified by:

remove in interface Objective.Builder

Returns:

a filtering objective.

add

FilteringObjective add(ObjectiveContext context)

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

Specified by:

add in interface Objective.Builder

Parameters:

context - an objective context

Returns:

a filtering objective

remove

FilteringObjective remove(ObjectiveContext context)

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

Specified by:

remove in interface Objective.Builder

Parameters:

context - an objective context

Returns:

a filtering objective