Package net.sourceforge.plantuml.cli

Enum Class Arity

java.lang.Object

java.lang.Enum<Arity>

net.sourceforge.plantuml.cli.Arity

All Implemented Interfaces:

Serializable, Comparable<Arity>, Constable

public enum Arity
extends Enum<Arity>

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
BINARY_NEXT_ARGUMENT_VALUE	Option with a single value, e.g.
UNARY_BOOLEAN	Option without any value, e.g.
UNARY_IMMEDIATE_ACTION	Option without any value that break the usual behaviour, e.g.
UNARY_INLINE_KEY_OR_KEY_VALUE	Option with an argument or a key/value, e.g.
UNARY_OPTIONAL_COLON	Option with a key and an optional value, e.g.

Method Summary

Modifier and Type	Method	Description
static Arity	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Arity[]	values()	Returns an array containing the constants of this enum class, 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

UNARY_BOOLEAN

public static final Arity UNARY_BOOLEAN

Option without any value, e.g. -verbose

UNARY_IMMEDIATE_ACTION

public static final Arity UNARY_IMMEDIATE_ACTION

Option without any value that break the usual behaviour, e.g. -help, -testdot

UNARY_OPTIONAL_COLON

public static final Arity UNARY_OPTIONAL_COLON

Option with a key and an optional value, e.g. -ftp or -ftp:8080

UNARY_INLINE_KEY_OR_KEY_VALUE

public static final Arity UNARY_INLINE_KEY_OR_KEY_VALUE

Option with an argument or a key/value, e.g. -DSOME_FLAG or -DKEY=VALUE

BINARY_NEXT_ARGUMENT_VALUE

public static final Arity BINARY_NEXT_ARGUMENT_VALUE

Option with a single value, e.g. -graphvizdot "foo.exe"

Method Details

values

public static Arity[] values()

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

Returns:

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

valueOf

public static Arity valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null