com.lf.commons.lang

Class OptionDef

java.lang.Object

com.lf.commons.lang.OptionDef

public class OptionDef
extends java.lang.Object

Simple data holding class for parsing options.

Program options can be modeled using this class for proper option parsing and file argument detection. Program options can be simple flags (no further values) or require a certain number of further arguments to be specified.

Since:

1.6

Version:

$Revision: 1.11 $, $Date: 2016/01/01 15:43:02 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	count Either a count value >= 0 or COUNT_1_OR_MORE ...
static java.lang.String	COUNT_1_OR_MORE Indicates one or more option values are required.
java.lang.String	name The name of the represented option without leading score like "locale".

Constructor Summary

Constructors

Constructor and Description
OptionDef() Constructor method for i18n purposes only.
OptionDef(java.lang.String name, java.lang.String count) Init functionality.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(OptionDef tocheck) Checks wether a given OptionDef instance is equal to this.
java.lang.String	getCount() Getter method.
java.lang.String	getName() Getter method.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

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

Field Detail

COUNT_1_OR_MORE

public static final java.lang.String COUNT_1_OR_MORE

Indicates one or more option values are required.

See Also:

Constant Field Values

name

public java.lang.String name

The name of the represented option without leading score like "locale".

count

public java.lang.String count

Either a count value >= 0 or COUNT_1_OR_MORE ...

Constructor Detail

OptionDef

public OptionDef()
          throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

OptionDef

public OptionDef(java.lang.String name,
         java.lang.String count)

Init functionality.

Parameters:

name - The name of the represented option without leading score like "locale"

count - Either a count value >= 0 or COUNT_1_OR_MORE ...

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalArgumentException - If values is invalid

Since:

1.6

Method Detail

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Overrides:

toString in class java.lang.Object

Returns:

The name of the represented option without leading score like "locale"

Since:

1.6

equals

public boolean equals(OptionDef tocheck)

Checks wether a given OptionDef instance is equal to this.

Parameters:

tocheck - Instance to be checked

Returns:

The OptionDef instance to check for equality

Since:

1.6

getName

public java.lang.String getName()

Getter method.

Returns:

The name of the represented option without leading score like "locale"

Since:

1.6

getCount

public java.lang.String getCount()

Getter method.

Returns:

Either a count value >= 0 or COUNT_1_OR_MORE ...

Since:

1.6