org.onosproject.net.meter

Class MeterStoreResult

java.lang.Object

org.onosproject.net.meter.MeterStoreResult

public final class MeterStoreResult
extends Object

An entity used to indicate whether the store operation passed.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MeterStoreResult.Type

Method Summary

Modifier and Type	Method and Description
static MeterStoreResult	fail(MeterFailReason reason) A failed store operation.
Optional<MeterFailReason>	reason()
static MeterStoreResult	success() A successful store opertion.
MeterStoreResult.Type	type()

Methods inherited from class java.lang.Object

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

Method Detail

type

public MeterStoreResult.Type type()

reason

public Optional<MeterFailReason> reason()

success

public static MeterStoreResult success()

A successful store opertion.

Returns:

a meter store result

fail

public static MeterStoreResult fail(MeterFailReason reason)

A failed store operation.

Parameters:

reason - a failure reason

Returns:

a meter store result