NextObjective (ONOS Java API (2.3.0))

All Superinterfaces:

Objective

All Known Implementing Classes:

DefaultNextObjective
```
@Beta
public interface NextObjective
extends Objective
```
Represents a nexthop which will be translated by a driver into the appropriate group or actions needed to implement the egress function. A next objective is made up of a collection of traffic treatments associated with a type. These types are: - Hashed - Broadcast - Failover - Simple These types will indicate to the driver what the intended behavior is. For example, a broadcast next objective with a collection of output treatments will indicate to a driver that all output actions are expected to be executed simultaneously. The driver is then free to implement this as a group or a simple action list.

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static interface`	`NextObjective.Builder`	A next step builder.
`static class`	`NextObjective.Type`	Represents the type of next phase to build.

Nested classes/interfaces inherited from interface org.onosproject.net.flowobjective.Objective
Objective.Operation

Field Summary
- Fields inherited from interface org.onosproject.net.flowobjective.Objective
  DEFAULT_PERMANENT, DEFAULT_PRIORITY, DEFAULT_TIMEOUT, MAX_PRIORITY, MIN_PRIORITY

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`NextObjective.Builder`	`copy()`	Returns a new builder set to create a copy of this objective.
`TrafficSelector`	`meta()`	Auxiliary optional information provided to the device driver.
`java.util.Collection<TrafficTreatment>`	`next()`	Deprecated. in 1.14.2, replaced by `nextTreatments()`
`java.util.Collection<NextTreatment>`	`nextTreatments()`	The collection of next treatments that need to be applied to a set of traffic.
`NextObjective.Type`	`type()`	The type of operation that will be applied to the traffic using the collection of treatments.

Methods inherited from interface org.onosproject.net.flowobjective.Objective
appId, context, id, op, permanent, priority, timeout

- Method Detail
  - next
```
@Deprecated
java.util.Collection<TrafficTreatment> next()
```
    Deprecated.
    in 1.14.2, replaced by nextTreatments()
    
    The collection of treatments that need to be applied to a set of traffic.
    
    Returns:
    
    a collection of traffic treatments
  - nextTreatments
```
java.util.Collection<NextTreatment> nextTreatments()
```
    The collection of next treatments that need to be applied to a set of traffic.
    
    Returns:
    
    a collection of next treatments
  - type
```
NextObjective.Type type()
```
    The type of operation that will be applied to the traffic using the collection of treatments.
    
    Returns:
    
    a type
  - meta
```
TrafficSelector meta()
```
    Auxiliary optional information provided to the device driver. Typically conveys information about selectors (matches) that are intended to use this Next Objective.
    
    Returns:
    
    a selector intended to pass meta information to the device driver. Value may be null if no meta information is provided.
  - copy
```
NextObjective.Builder copy()
```
    Returns a new builder set to create a copy of this objective.
    
    Specified by:
    
    copy in interface Objective
    
    Returns:
    
    new builder