Package com.github.javacliparser

Class AbstractClassOption

java.lang.Object

com.github.javacliparser.AbstractOption

com.github.javacliparser.AbstractClassOption

All Implemented Interfaces:

Option, java.io.Serializable

Direct Known Subclasses:

ClassOption

public abstract class AbstractClassOption
extends AbstractOption

Abstract class option.

Version:

$Revision$

Author:

Richard Kirkby ([email protected])

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Object	currentValue	The current object
protected java.lang.String	defaultCLIString	The default command line interface text.
static java.lang.String	FILE_PREFIX_STRING	The prefix text to use to indicate file.
static java.lang.String	INMEM_PREFIX_STRING	The prefix text to use to indicate inmem.
protected java.lang.String	nullString	The null text.
protected java.lang.Class<?>	requiredType	The class type

Fields inherited from class com.github.javacliparser.AbstractOption

cliChar, illegalNameCharacters, name, purpose

Constructor Summary

Constructors

Constructor	Description
AbstractClassOption(java.lang.String name, char cliChar, java.lang.String purpose, java.lang.Class<?> requiredType, java.lang.String defaultCLIString)	Creates a new instance of an abstract option given its class name, command line interface text, its purpose, its class type and its default command line interface text.
AbstractClassOption(java.lang.String name, char cliChar, java.lang.String purpose, java.lang.Class<?> requiredType, java.lang.String defaultCLIString, java.lang.String nullString)	Creates a new instance of an abstract option given its class name, command line interface text, its purpose, its class type, default command line interface text, and its null text.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	classToCLIString(java.lang.Class<?> aClass, java.lang.Class<?> requiredType)	Gets the command line interface text of the class.
java.lang.String	getDefaultCLIString()	Gets the Command Line Interface text
java.lang.String	getNullString()	Gets the null string of this option.
java.lang.Class<?>	getRequiredType()	Gets the class type of this option.
java.lang.Object	getValue()	Returns the current object.
abstract java.lang.String	getValueAsCLIString()	Gets the value of a Command Line Interface text as a string
java.lang.Object	materializeObject()	Gets a materialized object of this option.
void	setCurrentObject(java.lang.Object obj)	Sets current object.
abstract void	setValueViaCLIString(java.lang.String s)	Sets value of this option via the Command Line Interface text
static java.lang.String	stripPackagePrefix(java.lang.String className, java.lang.Class<?> expectedType)	Gets the class name without its package name prefix.

Methods inherited from class com.github.javacliparser.AbstractOption

copy, getCLIChar, getName, getPurpose, getStateString, nameIsLegal, resetToDefault

Methods inherited from class java.lang.Object

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

Field Detail

FILE_PREFIX_STRING

public static final java.lang.String FILE_PREFIX_STRING

The prefix text to use to indicate file.

See Also:

Constant Field Values

INMEM_PREFIX_STRING

public static final java.lang.String INMEM_PREFIX_STRING

The prefix text to use to indicate inmem.

See Also:

Constant Field Values

currentValue

protected java.lang.Object currentValue

The current object

requiredType

protected java.lang.Class<?> requiredType

The class type

defaultCLIString

protected java.lang.String defaultCLIString

The default command line interface text.

nullString

protected java.lang.String nullString

The null text.

Constructor Detail

AbstractClassOption

public AbstractClassOption(java.lang.String name,
                           char cliChar,
                           java.lang.String purpose,
                           java.lang.Class<?> requiredType,
                           java.lang.String defaultCLIString)

Creates a new instance of an abstract option given its class name, command line interface text, its purpose, its class type and its default command line interface text.

Parameters:

name - the name of this option

cliChar - the command line interface text

purpose - the text describing the purpose of this option

requiredType - the class type

defaultCLIString - the default command line interface text

AbstractClassOption

public AbstractClassOption(java.lang.String name,
                           char cliChar,
                           java.lang.String purpose,
                           java.lang.Class<?> requiredType,
                           java.lang.String defaultCLIString,
                           java.lang.String nullString)

Creates a new instance of an abstract option given its class name, command line interface text, its purpose, its class type, default command line interface text, and its null text.

Parameters:

name - the name of this option

cliChar - the command line interface text

purpose - the text describing the purpose of this option

requiredType - the class type

defaultCLIString - the default command line interface text

nullString - the null text

Method Detail

setCurrentObject

public void setCurrentObject(java.lang.Object obj)

Sets current object.

Parameters:

obj - the object to set as current.

getValue

public java.lang.Object getValue()

Returns the current object.

Returns:

the current object

getRequiredType

public java.lang.Class<?> getRequiredType()

Gets the class type of this option.

Returns:

the class type of this option

getNullString

public java.lang.String getNullString()

Gets the null string of this option.

Returns:

the null string of this option

materializeObject

public java.lang.Object materializeObject()

Gets a materialized object of this option.

Returns:

the materialized object

getDefaultCLIString

public java.lang.String getDefaultCLIString()

Description copied from interface: Option

Gets the Command Line Interface text

Returns:

the Command Line Interface text

classToCLIString

public static java.lang.String classToCLIString(java.lang.Class<?> aClass,
                                                java.lang.Class<?> requiredType)

Gets the command line interface text of the class.

Parameters:

aClass - the class

requiredType - the class type

Returns:

the command line interface text of the class

getValueAsCLIString

public abstract java.lang.String getValueAsCLIString()

Description copied from interface: Option

Gets the value of a Command Line Interface text as a string

Returns:

the string with the value of the Command Line Interface text

setValueViaCLIString

public abstract void setValueViaCLIString(java.lang.String s)

Description copied from interface: Option

Sets value of this option via the Command Line Interface text

Parameters:

s - the Command Line Interface text

stripPackagePrefix

public static java.lang.String stripPackagePrefix(java.lang.String className,
                                                  java.lang.Class<?> expectedType)

Gets the class name without its package name prefix.

Parameters:

className - the name of the class

expectedType - the type of the class

Returns:

the class name without its package name prefix