Package com.gengoai.application

Class NamedOption.NamedOptionBuilder

java.lang.Object

com.gengoai.application.NamedOption.NamedOptionBuilder

Enclosing class:

NamedOption

public static class NamedOption.NamedOptionBuilder
extends Object

Builder class to create a named options

Method Summary

Modifier and Type	Method	Description
NamedOption.NamedOptionBuilder	alias(String alias)	Adds an alias for this option
NamedOption	build()	Builds the named option
NamedOption.NamedOptionBuilder	defaultValue(Object defaultValue)	Sets the default value for the option
NamedOption.NamedOptionBuilder	description(String description)	Sets the description of the option
NamedOption.NamedOptionBuilder	name(String name)	Sets the name of the option
NamedOption.NamedOptionBuilder	required(boolean required)	Sets whether or not the option is required
String	toString()
NamedOption.NamedOptionBuilder	type(Class<?> type)	Sets the type of the option

Methods inherited from class java.lang.Object

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

Method Detail

alias

public NamedOption.NamedOptionBuilder alias(String alias)

Adds an alias for this option

Parameters:

alias - the alias to add

Returns:

the named option builder

build

public NamedOption build()

Builds the named option

Returns:

the named option

defaultValue

public NamedOption.NamedOptionBuilder defaultValue(Object defaultValue)

Sets the default value for the option

Parameters:

defaultValue - the default value

Returns:

the named option builder

description

public NamedOption.NamedOptionBuilder description(String description)

Sets the description of the option

Parameters:

description - the description

Returns:

the named option builder

name

public NamedOption.NamedOptionBuilder name(String name)

Sets the name of the option

Parameters:

name - the name

Returns:

the named option builder

required

public NamedOption.NamedOptionBuilder required(boolean required)

Sets whether or not the option is required

Parameters:

required - True - the option is required to be set

Returns:

the named option builder

toString

public String toString()

Overrides:

toString in class Object

type

public NamedOption.NamedOptionBuilder type(Class<?> type)

Sets the type of the option

Parameters:

type - the type

Returns:

the named option builder