org.stekikun.dolmen.cli

Class Args.Value

java.lang.Object

org.stekikun.dolmen.cli.Args.Value

Enclosing class:

Args

public abstract static class Args.Value
extends Object

Common variant type holding values associated to various types of command-line options.

Values can be produced using the various static factories associated to every type of option: mkFlag(boolean), mkNumeric(int) and mkString(String).

Author:

Stéphane Lescuyer

See Also:

getType()

Field Summary

Fields

Modifier and Type	Field and Description
static Args.Value	NO The value associated to a disabled flag
static Args.Value	YES The value associated to an enabled flag

Constructor Summary

Constructors

Constructor and Description
Value()

Method Summary

Modifier and Type	Method and Description
boolean	asFlag()
int	asNumeric()
String	asString()
static Args.Value	mkFlag(boolean b)
static Args.Value	mkNumeric(int v)
static Args.Value	mkString(String s)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

YES

public static final Args.Value YES

The value associated to an enabled flag

NO

public static final Args.Value NO

The value associated to a disabled flag

Constructor Detail

Value

public Value()

Method Detail

asFlag

public boolean asFlag()

Returns:

this flag value as a boolean

Throws:

IllegalArgumentException - if the value is not of type Args.Type.FLAG

asNumeric

public int asNumeric()

Returns:

this numeric value as an integer

Throws:

IllegalArgumentException - if the value is not of type Args.Type.NUMERIC

asString

public String asString()

Returns:

this value as a string

Throws:

IllegalArgumentException - if the value is not of type Args.Type.STRING

toString

public final String toString()

Overrides:

toString in class Object

mkFlag

public static Args.Value mkFlag(boolean b)

Parameters:

b - whether the flag is present or not

Returns:

a flag value

mkNumeric

public static Args.Value mkNumeric(int v)

Parameters:

v -

Returns:

a numeric value

mkString

public static Args.Value mkString(String s)

Parameters:

s -

Returns:

a string value