xdoclet.ejb
Class ValueObjectSubTask

java.lang.Object
  |
  +--xdoclet.DocletSupport
        |
        +--xdoclet.SubTask
              |
              +--xdoclet.TemplateSubTask
                    |
                    +--xdoclet.ejb.AbstractEjbCodeGeneratorSubTask
                          |
                          +--xdoclet.ejb.ValueObjectSubTask

All Implemented Interfaces:

java.io.Serializable

public class ValueObjectSubTask

extends AbstractEjbCodeGeneratorSubTask

Version:

$Revision: 1.4 $

Author:

Vincent Harcq (vincent.harcq@hubmethods.com)

See Also:

Serialized Form

Inner classes inherited from class xdoclet.TemplateSubTask

TemplateSubTask.ExtentTypes

Field Summary

protected com.sun.javadoc.Tag	currentDataObjectTag Form tag being processed right now
static java.lang.String	DEFAULT_DATAOBJECT_CLASS_PATTERN
protected static java.lang.String	DEFAULT_TEMPLATE_FILE
static java.lang.String	SUBTASK_NAME
protected java.lang.String	valueObjectClassPattern A configuration parameter for specifying the data object class name pattern.

Fields inherited from class xdoclet.DocletSupport

currentTag

Constructor Summary

ValueObjectSubTask()

Method Summary

protected void	engineStarted()
protected void	generateForClass(com.sun.javadoc.ClassDoc clazz) Processed template for clazz and generates output file for clazz.
static java.lang.String	getCurrentValueObjectClass()
static java.lang.String	getCurrentValueObjectMatch()
static java.lang.String	getCurrentValueObjectName()
protected java.lang.String	getGeneratedFileName(com.sun.javadoc.ClassDoc clazz) Returns class name for the generated file.
java.lang.String	getSubTaskName()
java.lang.String	getValueObjectClassPattern() Returns the configuration parameter for specifying the data object class name pattern.
protected boolean	matchesGenerationRules(com.sun.javadoc.ClassDoc clazz) Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise.
void	setPattern(java.lang.String new_pattern)
void	validateOptions() Called to validate configuration parameters.

Methods inherited from class xdoclet.TemplateSubTask

addPackageSubstitution, beanFile, copyAttributesFrom, engineFinished, execute, getDestinationFile, getEngine, getExtent, getHavingClassTag, getOfType, getPackageSubstitutions, getParser, getSubTaskClassName, getTemplateURL, init, isGuessGenerationNeeded, isPackageSubstitutionInheritanceSupported, isPrefixWithPackageStructure, javaFile, setDestinationFile, setEngine, setExtent, setExtentValue, setGuessGenerationNeeded, setHavingClassTag, setOfType, setPackageSubstitutionInheritanceSupported, setPackageSubstitutions, setParser, setPrefixWithPackageStructure, setSubTaskClassName, setTemplateFile, setTemplateURL, startEngine, startProcess

Methods inherited from class xdoclet.SubTask

addConfigParam, getConfigParams, getContext, getDestDir, getMergeDir, setDestDir, setMergeDir, setSubTaskName

Methods inherited from class xdoclet.DocletSupport

getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, isDocletGenerated, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag

Methods inherited from class java.lang.Object

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

Field Detail

SUBTASK_NAME

public static final java.lang.String SUBTASK_NAME

DEFAULT_DATAOBJECT_CLASS_PATTERN

public static final java.lang.String DEFAULT_DATAOBJECT_CLASS_PATTERN

DEFAULT_TEMPLATE_FILE

protected static java.lang.String DEFAULT_TEMPLATE_FILE

valueObjectClassPattern

protected java.lang.String valueObjectClassPattern

A configuration parameter for specifying the data object class name pattern. By default the value is used for deciding the entity data object class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name.

See Also:

getValueObjectClassPattern()

currentDataObjectTag

protected com.sun.javadoc.Tag currentDataObjectTag

Form tag being processed right now

Constructor Detail

ValueObjectSubTask

public ValueObjectSubTask()

Method Detail

getCurrentValueObjectClass

public static java.lang.String getCurrentValueObjectClass()

getCurrentValueObjectName

public static java.lang.String getCurrentValueObjectName()

getCurrentValueObjectMatch

public static java.lang.String getCurrentValueObjectMatch()

getSubTaskName

public java.lang.String getSubTaskName()

Overrides:

getSubTaskName in class TemplateSubTask

getValueObjectClassPattern

public java.lang.String getValueObjectClassPattern()

Returns the configuration parameter for specifying the data object class name pattern. By default the value is used for deciding the entity data object class name. {0} in the value mean current class's symbolic name which for an EJBean is the EJB name. If nothing explicitly specified by user then "{0}Data" is used by default.

Returns:

The DataObjectClassPattern value

See Also:

valueObjectClassPattern

setPattern

public void setPattern(java.lang.String new_pattern)

validateOptions

public void validateOptions()
                     throws XDocletException

Called to validate configuration parameters.

Overrides:

validateOptions in class TemplateSubTask

Throws:

XDocletException - Description of Exception

getGeneratedFileName

protected java.lang.String getGeneratedFileName(com.sun.javadoc.ClassDoc clazz)
                                         throws XDocletException

Description copied from class: TemplateSubTask

Returns class name for the generated file. {0} substituted by class name.

Overrides:

getGeneratedFileName in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

The GeneratedClassName value

Throws:

XDocletException - Description of Exception

matchesGenerationRules

protected boolean matchesGenerationRules(com.sun.javadoc.ClassDoc clazz)
                                  throws XDocletException

Description copied from class: TemplateSubTask

Returns true if output not already generated for clazz, and is of the specified type and has the specified class tag; false otherwise. If returned false, no output file is generated for clazz.

Overrides:

matchesGenerationRules in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

generateForClass

protected void generateForClass(com.sun.javadoc.ClassDoc clazz)
                         throws XDocletException

Description copied from class: TemplateSubTask

Processed template for clazz and generates output file for clazz.

Overrides:

generateForClass in class TemplateSubTask

Following copied from class: xdoclet.TemplateSubTask

Parameters:

clazz - Description of Parameter

Throws:

XDocletException - Description of Exception

engineStarted

protected void engineStarted()
                      throws XDocletException

Overrides:

engineStarted in class TemplateSubTask