org.onosproject.net.flow

Class CompletedBatchOperation

java.lang.Object

org.onosproject.net.flow.CompletedBatchOperation

All Implemented Interfaces:

BatchOperationResult<FlowRule>

public class CompletedBatchOperation
extends Object
implements BatchOperationResult<FlowRule>

Representation of a completed flow rule batch operation.

Constructor Summary

Constructors

Constructor and Description
CompletedBatchOperation(boolean success, Set<? extends FlowRule> failures, DeviceId deviceId) Creates a new batch completion result.
CompletedBatchOperation(boolean success, Set<? extends FlowRule> failures, Set<Long> failedIds, DeviceId deviceId) Creates a new batch completion result.

Method Summary

Modifier and Type	Method and Description
DeviceId	deviceId()
Set<Long>	failedIds()
Set<FlowRule>	failedItems() Obtains a set of items which failed.
boolean	isSuccess() Returns whether the operation was successful.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletedBatchOperation

public CompletedBatchOperation(boolean success,
                               Set<? extends FlowRule> failures,
                               Set<Long> failedIds,
                               DeviceId deviceId)

Creates a new batch completion result.

Parameters:

success - indicates whether the completion is successful

failures - set of any failures encountered

failedIds - (optional) set of failed operation ids

deviceId - the device this operation completed for

CompletedBatchOperation

public CompletedBatchOperation(boolean success,
                               Set<? extends FlowRule> failures,
                               DeviceId deviceId)

Creates a new batch completion result.

Parameters:

success - indicates whether the completion is successful.

failures - set of any failures encountered

deviceId - the device this operation completed for

Method Detail

isSuccess

public boolean isSuccess()

Description copied from interface: BatchOperationResult

Returns whether the operation was successful.

Specified by:

isSuccess in interface BatchOperationResult<FlowRule>

Returns:

true if successful, false otherwise

failedItems

public Set<FlowRule> failedItems()

Description copied from interface: BatchOperationResult

Obtains a set of items which failed.

Specified by:

failedItems in interface BatchOperationResult<FlowRule>

Returns:

a set of failures

failedIds

public Set<Long> failedIds()

deviceId

public DeviceId deviceId()

toString

public String toString()

Overrides:

toString in class Object