|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.enhydra.tool.codegen.GeneratorOption
GeneratorOption define a generator specific option for CodeGen. Generation options include information such as the directory where to generate an application and name to use for the generated application.
Constructor Summary | |
GeneratorOption(java.lang.String n,
boolean v,
java.lang.String desc,
boolean persist)
Create a option for the current generator. |
|
GeneratorOption(java.lang.String name,
java.lang.String value,
java.lang.String displayName,
java.lang.String description,
boolean required,
boolean persistent)
Create a option for the current generator. |
Method Summary | |
void |
clearValue()
|
java.lang.String |
getDescription()
Get a string describing the option. |
java.lang.String |
getDisplayName()
Get name to display in Swing components. |
java.lang.String |
getName()
Get the option name. |
java.lang.String |
getValue()
Get the option value. |
boolean |
isBoolean()
Determine if the option is a boolean switch. |
boolean |
isEmpty()
|
boolean |
isPersistent()
Check if the option value persistent between CodeGen sessions. |
boolean |
isRequired()
Flag indicating if the values needs to be set prior to generation. |
boolean |
isValue()
Get the value as a boolean. |
void |
setValue(boolean value)
Set the value as a boolean. |
void |
setValue(java.lang.String value)
Set the option value. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public GeneratorOption(java.lang.String name, java.lang.String value, java.lang.String displayName, java.lang.String description, boolean required, boolean persistent) throws GeneratorException
name
- When passing command line arguments, the name must be prefixed
with a dash.value
- When the name refers to a boolean flag, any value other than 'true'
should be treated as 'false'.description
- The description is what displays when help for the option is
printed out from the command line. The description may also be
used in a wizard panel.required
- True if a value for this option must be specified for the
generation to be successful.
GeneratorException
- Thrown if name is a null or an empty string. Note that no exception
is thrown during construction if required is true and the value is
null or empty.public GeneratorOption(java.lang.String n, boolean v, java.lang.String desc, boolean persist) throws GeneratorException
GeneratorException
- Thrown if name is a null or an empty string. Note that no exception
is thrown during construction if required is true and the value is
null or empty.Method Detail |
public java.lang.String getName()
public java.lang.String getValue()
public void setValue(java.lang.String value) throws GeneratorException
value
- String value for the option.
GeneratorException
- Thrown if value is null or empty and required is true.public void setValue(boolean value)
value
- Boolean value.public java.lang.String getDescription()
public boolean isRequired()
public boolean isPersistent()
public java.lang.String getDisplayName()
public boolean isValue()
public boolean isBoolean()
public void clearValue()
public boolean isEmpty()
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |