org.onosproject.net.meter

Enum MeterFailReason

java.lang.Object

java.lang.Enum<MeterFailReason>

org.onosproject.net.meter.MeterFailReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MeterFailReason>

public enum MeterFailReason
extends java.lang.Enum<MeterFailReason>

Enum used to represent a meter failure condition.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_BAND Bad band.
BAD_BAND_VALUE Bad value value.
BAD_BURST Bad burst size value.
BAD_RATE Bad rate value.
EXISTING_METER A meter with the same identifier already exists.
INVALID_METER Invalid meter definition.
OUT_OF_BANDS The device does not support any more bands for this meter.
OUT_OF_METERS The device does not support any more meters.
TIMEOUT The operation for this meter installation timed out.
UNKNOWN The meter that was attempted to be modified is unknown.
UNKNOWN_COMMAND Unknown command.
UNKNOWN_DEVICE The target device is unknown.
UNKNOWN_FLAGS Unknown flags.

Method Summary

Modifier and Type	Method and Description
static MeterFailReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MeterFailReason[]	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

EXISTING_METER

public static final MeterFailReason EXISTING_METER

A meter with the same identifier already exists. Essentially a duplicate meter exists.

OUT_OF_METERS

public static final MeterFailReason OUT_OF_METERS

The device does not support any more meters.

OUT_OF_BANDS

public static final MeterFailReason OUT_OF_BANDS

The device does not support any more bands for this meter.

UNKNOWN

public static final MeterFailReason UNKNOWN

The meter that was attempted to be modified is unknown.

TIMEOUT

public static final MeterFailReason TIMEOUT

The operation for this meter installation timed out.

INVALID_METER

public static final MeterFailReason INVALID_METER

Invalid meter definition.

UNKNOWN_DEVICE

public static final MeterFailReason UNKNOWN_DEVICE

The target device is unknown.

UNKNOWN_COMMAND

public static final MeterFailReason UNKNOWN_COMMAND

Unknown command.

UNKNOWN_FLAGS

public static final MeterFailReason UNKNOWN_FLAGS

Unknown flags.

BAD_RATE

public static final MeterFailReason BAD_RATE

Bad rate value.

BAD_BURST

public static final MeterFailReason BAD_BURST

Bad burst size value.

BAD_BAND

public static final MeterFailReason BAD_BAND

Bad band.

BAD_BAND_VALUE

public static final MeterFailReason BAD_BAND_VALUE

Bad value value.

Method Detail

values

public static MeterFailReason[] 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 (MeterFailReason c : MeterFailReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static MeterFailReason valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null