Enhydra 5.1 API

org.enhydra.tool.codegen.internal
Class WebAppGenerator

java.lang.Object
  |
  +--org.enhydra.tool.codegen.TemplateDrivenGenerator
        |
        +--org.enhydra.tool.codegen.ProjectGenerator
              |
              +--org.enhydra.tool.codegen.internal.AppGenerator
                    |
                    +--org.enhydra.tool.codegen.internal.WebAppGenerator
All Implemented Interfaces:
Constants, java.util.EventListener, Generator, TemplateListener

public class WebAppGenerator
extends AppGenerator

A generator for Servlet 2.2 style Web Applications.


Field Summary
static java.lang.String COMMAND_NAME
          Name to use specify at the command line.
static java.lang.String displayName
          Descriptive name for generator.
static java.lang.String wizardTitle
           
 
Fields inherited from class org.enhydra.tool.codegen.TemplateDrivenGenerator
res
 
Fields inherited from interface org.enhydra.tool.codegen.Constants
CLIENT_SUFFIX, CONTENT_HTML, CONTENT_WML, DIR_AT_PACKAGE_DIR_AT, DIR_INPUT, DIR_LIB, DIR_MEDIA, DIR_OUTPUT, DIR_PRESENTATION, DIR_RESOURCES, DIR_SRC, DIR_TEMPLATE, DIR_TOOL, FILE_BUILD_XML, FILE_ENHYDRA_JAR, FILE_MAKEFILE, FILE_README_HTML, FILE_RUN_BAT_IN, FILE_RUN_IN, SYS_JAVA_VENDOR, SYS_JAVA_VERSION, SYS_USER_HOME, TAB4, TYPE_BAT, TYPE_CONF, TYPE_HTML, TYPE_IN, TYPE_JAVA, TYPE_MK, TYPE_TEMPLATE, TYPE_WML, TYPE_XML, XMLC_DEFAULT, XMLC_SUFFIX
 
Constructor Summary
WebAppGenerator()
          Create an instance of the Web Application generator.
 
Method Summary
 Replacement[] createReplacementsForDirectory(PathHandle path)
          Overrides AppGenerator
 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[] getOutputExcludes()
          Implements AppGenerator
 java.lang.String getWizardTitle()
          Name to display in command line messages and in the wizard.
 
Methods inherited from class org.enhydra.tool.codegen.internal.AppGenerator
expandAddinPackageMap, getAddinPackageMap, getClient, getDefaultAddinSteps, getDefaultShellSteps, getInputIncludes, getWizardPanels, initReplacementSet, setAddinPackageMap
 
Methods inherited from class org.enhydra.tool.codegen.ProjectGenerator
createCopyFilter, createTemplateFilter, generate, getAddinSteps, getDestination, getJavaPath, getProjectSourcePath, getShellSteps, onTemplate, setAddinSteps, setJavaPath, setProperties, setShellSteps, storeProperties
 
Methods inherited from class org.enhydra.tool.codegen.TemplateDrivenGenerator
getOptionSet, getProperties, getReplacementSet, getTemplateRoot, isEcho, isOverwrite, isSwing, setEcho, setOptionSet, setOverwrite, setReplacementSet, setSwing, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COMMAND_NAME

public static final java.lang.String COMMAND_NAME
Name to use specify at the command line.

See Also:
Constant Field Values

displayName

public static final java.lang.String displayName
Descriptive name for generator.


wizardTitle

public static final java.lang.String wizardTitle
Constructor Detail

WebAppGenerator

public WebAppGenerator()
Create an instance of the Web Application generator.

Method Detail

getOutputExcludes

public java.lang.String[] getOutputExcludes()
Implements AppGenerator

Overrides:
getOutputExcludes in class ProjectGenerator

createReplacementsForDirectory

public Replacement[] createReplacementsForDirectory(PathHandle path)
                                             throws GeneratorException
Overrides AppGenerator

Overrides:
createReplacementsForDirectory in class ProjectGenerator
Throws:
GeneratorException

getCommandName

public java.lang.String getCommandName()
Get short name used in command line. May also be used to locate template directory.

Returns:
Command line identifier.

getDisplayName

public java.lang.String getDisplayName()
Name to display in command line messages and in the wizard.

Returns:
Display name for generator.

getWizardTitle

public java.lang.String getWizardTitle()
Description copied from interface: Generator
Name to display in command line messages and in the wizard.

Returns:
Display name for generator.

getDescription

public java.lang.String getDescription()
Get text that breifly explains the application that the generator creates.

Returns:
Descriptive text to display in a wizard or in a command line help response.

Enhydra 5.1 API