Package xyz.euclia.jaqpotj.models

Enum Parameter.Scope

java.lang.Object

java.lang.Enum<Parameter.Scope>

xyz.euclia.jaqpotj.models.Parameter.Scope

All Implemented Interfaces:

Serializable, Comparable<Parameter.Scope>, java.lang.constant.Constable

Enclosing class:

Parameter

public static enum Parameter.Scope
extends Enum<Parameter.Scope>

The scope of a parameter can either be Mandatory or Optional.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY	A parameter is mandatory when the user has to provide it's value and no default values can be assigned to it.
OPTIONAL	If a parameter is tagged as 'Optional' then the client does not need to provide its value explicitly but instead a default value will be used.

Method Summary

Modifier and Type	Method	Description
static Parameter.Scope	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Parameter.Scope[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OPTIONAL

public static final Parameter.Scope OPTIONAL

If a parameter is tagged as 'Optional' then the client does not need to provide its value explicitly but instead a default value will be used.

MANDATORY

public static final Parameter.Scope MANDATORY

A parameter is mandatory when the user has to provide it's value and no default values can be assigned to it.

Method Details

values

public static Parameter.Scope[] values()

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

Returns:

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

valueOf

public static Parameter.Scope valueOf(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:

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

NullPointerException - if the argument is null