|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for defining generators. CodeGen can use any generator that implements this interface, is in the class path and has an entry in the codegen.properties file.
Method Summary | |
java.io.File[] |
generate()
Try the generating the application and return a list |
java.lang.String[] |
getAddinSteps()
Get steps required to build the project with an IDE addin. |
java.lang.String |
getCommandName()
Get short name used in command line. |
java.lang.String |
getDescription()
Get text that breifly explains the application that the generator creates. |
java.lang.String |
getDisplayName()
Name to display in command line messages and in the wizard. |
OptionSet |
getOptionSet()
Get an array of generator options that can be set through command line options or through wizard panels. |
java.util.Properties |
getProperties()
Get properties used to customize CodeGen. |
java.lang.String[] |
getShellSteps()
Get steps required to build the project from a unix shell. |
CodeGenPanel[] |
getWizardPanels()
Get swing panels for setting generator options. |
java.lang.String |
getWizardTitle()
Name to display in command line messages and in the wizard. |
boolean |
isEcho()
|
boolean |
isSwing()
|
void |
setAddinSteps(java.lang.String[] steps)
Set the steps required to build the project from within an IDE. |
void |
setEcho(boolean b)
|
void |
setProperties(java.util.Properties properties)
Set CodeGen customization properties. |
void |
setShellSteps(java.lang.String[] steps)
Set the steps required to build the project from a unix shell. |
void |
setSwing(boolean b)
|
Method Detail |
public void setProperties(java.util.Properties properties) throws GeneratorException
properties
- Properties passed from the CodeGen class.
GeneratorException
public java.util.Properties getProperties()
public java.lang.String getCommandName()
public java.lang.String getDisplayName()
public java.lang.String getWizardTitle()
public java.lang.String getDescription()
public OptionSet getOptionSet()
public CodeGenPanel[] getWizardPanels() throws GeneratorException
GeneratorException
public java.io.File[] generate() throws GeneratorException
GeneratorException
- Thrown if all the files could not be generated without error.public java.lang.String[] getAddinSteps()
public void setAddinSteps(java.lang.String[] steps)
steps
- An array of strings, each string will be inserted into
a readme.html file as numbered step for building the
project within an IDE.public java.lang.String[] getShellSteps()
public void setShellSteps(java.lang.String[] steps)
steps
- An array of strings, each string will be inserted into
a readme.html file as numbered step for building the
project from a unix shell.public void setEcho(boolean b)
public boolean isEcho()
public void setSwing(boolean b)
public boolean isSwing()
|
Enhydra 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |