alma.acs.util

Class CmdLineRegisteredOption

java.lang.Object

alma.acs.util.CmdLineOption

alma.acs.util.CmdLineRegisteredOption

public class CmdLineRegisteredOption
extends CmdLineOption

Used both for declaration of possible cmd line options, as well as to hold actual values

Author:

hsommer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected int	m_minValuesCount

Fields inherited from class alma.acs.util.CmdLineOption

altName, name

Constructor Summary

Constructors

Constructor and Description
CmdLineRegisteredOption(java.lang.String name, int minValuesCount)
CmdLineRegisteredOption(java.lang.String name, java.lang.String altName, int minValuesCount)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns super.equals(obj) because the minimum number required arguments should not be part of the CmdLineRegisteredOption identity (only the name gets used).
int	getMinValueCount()
int	hashCode() hashCode should only depend on option name, thus calling super.hashCode().

Methods inherited from class alma.acs.util.CmdLineOption

getAlternativeName, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_minValuesCount

protected int m_minValuesCount

description

protected java.lang.String description

Constructor Detail

CmdLineRegisteredOption

public CmdLineRegisteredOption(java.lang.String name,
                               int minValuesCount)

CmdLineRegisteredOption

public CmdLineRegisteredOption(java.lang.String name,
                               java.lang.String altName,
                               int minValuesCount)

Method Detail

getMinValueCount

public int getMinValueCount()

Returns:

The minimal number of required arguments, as passed in the constructor.

equals

public boolean equals(java.lang.Object obj)

Returns super.equals(obj) because the minimum number required arguments should not be part of the CmdLineRegisteredOption identity (only the name gets used). We override this method anyway, to document this fact.

Overrides:

equals in class CmdLineOption

See Also:

Object.equals(Object)

hashCode

public int hashCode()

hashCode should only depend on option name, thus calling super.hashCode(). We override this method to document this fact.

Overrides:

hashCode in class CmdLineOption

See Also:

Object.hashCode()