Module org.tentackle.wurblet

Package org.tentackle.wurblet

Class ModelComment

java.lang.Object

org.wurbelizer.wurblet.AbstractWurblet

org.wurbelizer.wurblet.AbstractJavaWurblet

org.tentackle.wurblet.ModelWurblet

org.tentackle.wurblet.ModelComment

All Implemented Interfaces:

org.wurbelizer.wurblet.Wurblet

public class ModelComment
extends ModelWurblet

(@wurblet) Generate a comment to document the relations and usage of the entity.

usage:
@wurblet <tag> ModelComment

For more options, see ModelWurblet.

Field Summary

Fields inherited from class org.wurbelizer.wurblet.AbstractWurblet

configuration, container, out, phase, source

Constructor Summary

Constructors

Constructor	Description
ModelComment()

Method Summary

Modifier and Type	Method	Description
void	run()

Methods inherited from class org.tentackle.wurblet.ModelWurblet

appendCommaSeparated, assertSupportedByBackends, createAccessorCode, createComponentInfo, createDeclaredArgsForSelectOrDeleteMethod, createListRelationDeleteMethodName, createRelationSelectMethodName, deriveClassNameForEntity, determinePackageName, getAnnotationOptions, getArgs, getBackends, getColumnName, getColumnNameConstant, getEffectiveDataType, getEmbeddedTableAttributes, getEntity, getMethodName, getModelDefaults, getModelDirName, getModelName, getNonPrimitiveJavaType, getOption, getOptionArgs, getPdoClassName, getWurbletArgs, isAttributeDerived, isGenerified, isIdAttribute, isIdOrSerialAttribute, isInterface, isMuteOptionSet, isOperation, isPartOfInheritanceHierarchy, isPdo, isRemote, isSerialAttribute, orderByInheritanceLevelAndClassId, prependCommaSeparated, setRemote

Methods inherited from class org.wurbelizer.wurblet.AbstractJavaWurblet

getClassName, getPackageName, getSuperClassName, isAbstract, isClass, isFinal, isPrivate, isProtected, isPublic, isRecord, toString

Methods inherited from class org.wurbelizer.wurblet.AbstractWurblet

cleanup, getConfiguration, getContainer, getGuardName, getPhase, process, setConfiguration, setContainer, setPhase

Methods inherited from class java.lang.Object

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

Constructor Details

ModelComment

public ModelComment()

Method Details

run

public void run()
         throws org.wurbelizer.wurbel.WurbelException

Description copied from class: ModelWurblet

Overridden to load the map file.

Specified by:

run in interface org.wurbelizer.wurblet.Wurblet

Overrides:

run in class ModelWurblet

Throws:

org.wurbelizer.wurbel.WurbelException - if running the wurblet failed