Package org.onosproject.net.flowobjective

Interface Objective

All Superinterfaces:

Annotated

All Known Subinterfaces:

FilteringObjective, ForwardingObjective, NextObjective

All Known Implementing Classes:

DefaultFilteringObjective, DefaultForwardingObjective, DefaultNextObjective

@Beta
public interface Objective
extends Annotated

Base representation of a flow-objective description.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Objective.Builder	An objective builder.
static class	Objective.Operation	Type of operation.

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_PERMANENT
static int	DEFAULT_PRIORITY
static int	DEFAULT_TIMEOUT
static int	MAX_PRIORITY
static int	MIN_PRIORITY

Method Summary

Modifier and Type	Method	Description
ApplicationId	appId()	The application which applied this objective.
Optional<ObjectiveContext>	context()	Obtains an optional context.
Objective.Builder	copy()	Returns a new builder set to create a copy of this objective.
int	id()	An identifier for this objective.
Objective.Operation	op()	The type of operation for this objective.
boolean	permanent()	Whether this objective is permanent.
int	priority()	The priority for this objective.
int	timeout()	The timeout for this objective.

Methods inherited from interface org.onosproject.net.Annotated

annotations

Field Detail

DEFAULT_PERMANENT

static final boolean DEFAULT_PERMANENT

See Also:

Constant Field Values

DEFAULT_TIMEOUT

static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

MIN_PRIORITY

static final int MIN_PRIORITY

See Also:

Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

See Also:

Constant Field Values

Method Detail

id

int id()

An identifier for this objective.

Returns:

an integer

priority

int priority()

The priority for this objective.

Returns:

an integer

appId

ApplicationId appId()

The application which applied this objective.

Returns:

an application id

timeout

int timeout()

The timeout for this objective.

Returns:

an integer

permanent

boolean permanent()

Whether this objective is permanent.

Returns:

a boolean

op

Objective.Operation op()

The type of operation for this objective.

Returns:

an operation

context

Optional<ObjectiveContext> context()

Obtains an optional context.

Returns:

optional; which will be empty if there is no context. Otherwise it will return the context.

copy

Objective.Builder copy()

Returns a new builder set to create a copy of this objective.

Returns:

new builder