org.onosproject.net.config

Enum Config.FieldPresence

java.lang.Object

java.lang.Enum<Config.FieldPresence>

org.onosproject.net.config.Config.FieldPresence

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Config.FieldPresence>

Enclosing class:

Config<S>

public static enum Config.FieldPresence
extends java.lang.Enum<Config.FieldPresence>

Indicator of whether a configuration JSON field is required.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANDATORY Signifies that config field is mandatory.
OPTIONAL Signifies that config field is an optional one.

Method Summary

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

OPTIONAL

public static final Config.FieldPresence OPTIONAL

Signifies that config field is an optional one.

MANDATORY

public static final Config.FieldPresence MANDATORY

Signifies that config field is mandatory.

Method Detail

values

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

Returns:

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

valueOf

public static Config.FieldPresence 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