org.onosproject.net.flowobjective

Enum Objective.Operation

java.lang.Object

java.lang.Enum<Objective.Operation>

org.onosproject.net.flowobjective.Objective.Operation

All Implemented Interfaces:

Serializable, Comparable<Objective.Operation>

Enclosing interface:

Objective

public static enum Objective.Operation
extends Enum<Objective.Operation>

Type of operation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD Adds the objective.
ADD_TO_EXISTING Add to an existing Next Objective.
MODIFY Modify an existing Next Objective.
REMOVE Removes the objective.
REMOVE_FROM_EXISTING Remove from an existing Next Objective.
VERIFY Verifies that an existing Next Objective's collection of treatments are correctly represented by the underlying implementation of the objective.

Method Summary

Modifier and Type	Method and Description
static Objective.Operation	valueOf(String name) Returns the enum constant of this type with the specified name.
static Objective.Operation[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADD

public static final Objective.Operation ADD

Adds the objective. Can be used for any flow objective. For forwarding and filtering objectives, existing objectives with identical selector and priority fields (but different treatments or next) will be replaced. For next objectives, if modification is desired, ADD will not do anything - use ADD_TO_EXISTING.

REMOVE

public static final Objective.Operation REMOVE

Removes the objective. Can be used for any flow objective.

ADD_TO_EXISTING

public static final Objective.Operation ADD_TO_EXISTING

Add to an existing Next Objective. Should not be used for any other objective.

REMOVE_FROM_EXISTING

public static final Objective.Operation REMOVE_FROM_EXISTING

Remove from an existing Next Objective. Should not be used for any other objective.

MODIFY

public static final Objective.Operation MODIFY

Modify an existing Next Objective. Can be used to modify group buckets.

VERIFY

public static final Objective.Operation VERIFY

Verifies that an existing Next Objective's collection of treatments are correctly represented by the underlying implementation of the objective. Corrective action is taken if discrepancies are found during verification. For example, if the next objective defines 3 sets of treatments, which are meant to be implemented as 3 buckets in a group, but verification finds less or more buckets, then the appropriate buckets are added or removed to match the objective. Should not be used for any other objective.

Method Detail

values

public static Objective.Operation[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Objective.Operation c : Objective.Operation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Objective.Operation valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null