Generator

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> enhydra >> tool >> [ codegen overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.enhydra.tool.codegen.Generator

SOURCE |

Download org.enhydra.tool.codegen.Generator

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.enhydra.tool.codegen
Interface Generator

All Known Implementing Classes:: TemplateDrivenGenerator

public interface Generator

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.lang.String[][] expandKelpPackageMap()
          Get table for mapping directories to packages from with Kelp.

java.io.File[] generate()
          Try the generating the application and return a list

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.

java.lang.String[] getKelpSteps()
          Get steps required to build the project with Kelp.

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.

org.enhydra.tool.codegen.wizard.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 setEcho(boolean b)


void setKelpSteps(java.lang.String[] steps)
          Set the steps required to build the project from within an IDE.

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

setProperties

public void setProperties(java.util.Properties properties)
                   throws GeneratorException

Set CodeGen customization properties. The CodeGen class calls this method after it instantiates a generator class.

getProperties

public java.util.Properties getProperties()

Get properties used to customize CodeGen. This may contain information on the template directory location and persisted generation options.

getCommandName

public java.lang.String getCommandName()

Get short name used in command line. May also be used to locate template directory.

getDisplayName

public java.lang.String getDisplayName()

Name to display in command line messages and in the wizard.

getWizardTitle

public java.lang.String getWizardTitle()

Name to display in command line messages and in the wizard.

getDescription

public java.lang.String getDescription()

Get text that breifly explains the application that the generator creates.

getOptionSet

public OptionSet getOptionSet()

Get an array of generator options that can be set through command line options or through wizard panels.

getWizardPanels

public org.enhydra.tool.codegen.wizard.CodeGenPanel[] getWizardPanels()
                                                               throws GeneratorException

Get swing panels for setting generator options. The panels can be used within a standalone wizard or incorporated into the JBuilder wizard framework.

generate

public java.io.File[] generate()
                        throws GeneratorException

Try the generating the application and return a list

expandKelpPackageMap

public java.lang.String[][] expandKelpPackageMap()
                                          throws GeneratorException

Get table for mapping directories to packages from with Kelp.

getKelpSteps

public java.lang.String[] getKelpSteps()

Get steps required to build the project with Kelp.

setKelpSteps

public void setKelpSteps(java.lang.String[] steps)

Set the steps required to build the project from within an IDE.

getShellSteps

public java.lang.String[] getShellSteps()

Get steps required to build the project from a unix shell.

setShellSteps

public void setShellSteps(java.lang.String[] steps)

Set the steps required to build the project from a unix shell.

setEcho

public void setEcho(boolean b)

isEcho

public boolean isEcho()

setSwing

public void setSwing(boolean b)

isSwing

public boolean isSwing()