org.dmd.templates.server.generated.dmw

Class ExtensionHookDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.dms.generated.dmw.DSDefinitionDMW

org.dmd.dms.DSDefinition

org.dmd.templates.server.generated.dmw.TdlDefinitionDMW

org.dmd.templates.server.extended.TdlDefinition

org.dmd.templates.server.generated.dmw.ContainedElementDMW

org.dmd.templates.server.extended.ContainedElement

org.dmd.templates.server.generated.dmw.ExtensionHookDMW

All Implemented Interfaces:

DmcDefinitionIF, DmcContainerIF, DmcNamedObjectIF

Direct Known Subclasses:

ExtensionHook

public abstract class ExtensionHookDMW
extends ContainedElement
implements DmcDefinitionIF, DmcNamedObjectIF

The dark-matter Domain Specific Definition (DSD) mechanisms allow for the\n extension of objects using auxliary classes and arbitrary name value pairs (via the nvp attribute).\n These mechanisms are useful because they allow you to augment an existing Domain Specific Language\n (DSL) with your own information that can be used to facilitate generation of other types\n of artifacts.\n

\n However, you might also want that additional information to show up in the documentation\n produced as part of the base DSL. That's where the ExtensionHook mechanism comes into play;\n although you can use this for your own purposes to allow others to extend the\n content of your generated artifacts - there's nothing dark-matter specific about \n the mechanism.\n

\n When defining your Sections, you may indicate that they contain ExtensionHooks. This\n will result in the generation of an ExtensionHook interface for the template definition module.\n Other designers who have extended your DSL then create a class that implements the ExtensionHook\n interface and have it dynamically loaded when the artifact generator is invoked (this is usually\n done via commandline arguments that are passed to the generated TemplateLoader). It's up to the\n designer of the base DSL to provide these mechanisms.\n

\n When formatting the artifact, the base DSL designer will call the method on a Section\n (in the appropriate sequence) to have the TemplateLoader call any registered classes that\n implement the ExtensionHook interface.

Generated from the dmtdl schema at version unknown

This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExtensionHookDMW()
	ExtensionHookDMW(DmcTypeModifierMV mods)
	ExtensionHookDMW(ExtensionHookDMO obj)
protected	ExtensionHookDMW(ExtensionHookDMO obj, ClassDefinition cd)

Method Summary

Modifier and Type	Method and Description
ExtensionHook	cloneIt()
boolean	equals(Object obj) This method should check the type of the obj param and compare the name of this object with the one passed as argument.
ExtensionHookDMO	getDMO()
ExtensionHook	getModificationRecorder()
DefinitionName	getName() The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part.
String	getNameOfModuleWhereThisCameFrom() This method indicates the name of the module from which this definition was loaded.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
String	getTargetObjectClass()
Section	getUsesSection()
int	hashCode()
void	remName() Removes the name attribute value.
void	remTargetObjectClass() Removes the targetObjectClass attribute value.
void	remUsesSection() Removes the usesSection attribute value.
void	setName(DefinitionName value) Sets name to the specified value.
void	setName(Object value) Sets name to the specified value.
void	setTargetObjectClass(Object value) Sets targetObjectClass to the specified value.
void	setTargetObjectClass(String value) Sets targetObjectClass to the specified value.
void	setUsesSection(Object value) Sets the usesSection to the specified value.
void	setUsesSection(Section value) Sets the usesSection to the specified value.

Methods inherited from class org.dmd.templates.server.extended.TdlDefinition

initialize

Methods inherited from class org.dmd.templates.server.generated.dmw.TdlDefinitionDMW

addDescription, addDescription, delDescription, delDescription, descriptionContains, getDefinedInTdlModule, getDescriptionCopy, getDescriptionHasValue, getDescriptionIsEmpty, getDescriptionIterable, getDescriptionSize, getDotName, remDefinedInTdlModule, remDescription, remDotName, setDefinedInTdlModule, setDefinedInTdlModule, setDotName, setDotName

Methods inherited from class org.dmd.dms.DSDefinition

equals, getFullDotName

Methods inherited from class org.dmd.dms.generated.dmw.DSDefinitionDMW

addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getCommentSize, getDefinedIn, getDescription, getDescriptionWithNewlines, getDmoFromModule, getExample, getExampleSize, getFile, getHint, getLineNumber, getNvp, getNvpSize, getObsolete, getOptimize, getOptimizeSize, getQuestion, getQuestionSize, getRelationship, getSearchable, getSkip, getSkipSize, getSortName, getTags, getTagsSize, getVersion, getWhy, setDefinedIn, setDmcObject, setDmoFromModule, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, toJSON, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dmd.dmc.definitions.DmcDefinitionIF

getDefinedIn, getDotName, toOIF

Constructor Detail

ExtensionHookDMW

public ExtensionHookDMW()

ExtensionHookDMW

public ExtensionHookDMW(DmcTypeModifierMV mods)

ExtensionHookDMW

public ExtensionHookDMW(ExtensionHookDMO obj)

ExtensionHookDMW

protected ExtensionHookDMW(ExtensionHookDMO obj,
                           ClassDefinition cd)

Method Detail

getModificationRecorder

public ExtensionHook getModificationRecorder()

Specified by:

getModificationRecorder in class ContainedElementDMW

cloneIt

public ExtensionHook cloneIt()

getDMO

public ExtensionHookDMO getDMO()

Overrides:

getDMO in class ContainedElementDMW

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class ContainedElementDMW

Returns:

The name of this object from the name attribute.

hashCode

public int hashCode()

Overrides:

hashCode in class ContainedElementDMW

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class ContainedElementDMW

Returns:

The name attribute.

equals

public boolean equals(Object obj)

Description copied from interface: DmcNamedObjectIF

This method should check the type of the obj param and compare the name of this object with the one passed as argument.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class ContainedElementDMW

Parameters:

obj - The comparison object.

Returns:

True if the names match.

getName

public DefinitionName getName()

Description copied from class: DSDefinitionDMW

The name attribute is used to store a single string token that represents a unique name\n for an object with the set of definitions of which it is a part. A name starts with a letter followed\n by letters and numbers.

Specified by:

getName in interface DmcDefinitionIF

Overrides:

getName in class ContainedElementDMW

Returns:

the DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMW

Parameters:

value - A value compatible with DmcTypeDefinitionName

Throws:

DmcValueException - if the value is incorrect

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMW

Parameters:

value - DefinitionName

remName

public void remName()

Removes the name attribute value.

Overrides:

remName in class ContainedElementDMW

getTargetObjectClass

public String getTargetObjectClass()

setTargetObjectClass

public void setTargetObjectClass(Object value)
                          throws DmcValueException

Sets targetObjectClass to the specified value.

Parameters:

value - A value compatible with DmcTypeString

Throws:

DmcValueException

setTargetObjectClass

public void setTargetObjectClass(String value)

Sets targetObjectClass to the specified value.

Parameters:

value - String

remTargetObjectClass

public void remTargetObjectClass()

Removes the targetObjectClass attribute value.

getUsesSection

public Section getUsesSection()

Returns:

A Section object.

setUsesSection

public void setUsesSection(Section value)

Sets the usesSection to the specified value.

Parameters:

value - A value compatible with SectionREF

setUsesSection

public void setUsesSection(Object value)
                    throws DmcValueException

Sets the usesSection to the specified value.

Parameters:

value - A value compatible with SectionREF

Throws:

DmcValueException - is the value is incorrect

remUsesSection

public void remUsesSection()

Removes the usesSection attribute value.

getNameOfModuleWhereThisCameFrom

public String getNameOfModuleWhereThisCameFrom()

This method indicates the name of the module from which this definition was loaded.

Overrides:

getNameOfModuleWhereThisCameFrom in class DSDefinition