org.dmd.templates.shared.generated.dmo

Class ExtensionHookDMO

java.lang.Object

org.dmd.dmc.DmcObject

org.dmd.dms.generated.dmo.DSDefinitionDMO

org.dmd.templates.shared.generated.dmo.TdlDefinitionDMO

org.dmd.templates.shared.generated.dmo.ContainedElementDMO

org.dmd.templates.shared.generated.dmo.ExtensionHookDMO

All Implemented Interfaces:

Serializable, DmcNamedObjectIF

public class ExtensionHookDMO
extends ContainedElementDMO
implements DmcNamedObjectIF, Serializable

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 dmogenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dms.util.DmoFormatter.dumpDMO(DmoFormatter.java:134)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	constructionClassName

Fields inherited from class org.dmd.dmc.DmcObject

__objectClass, attributes

Constructor Summary

Constructors

Modifier	Constructor and Description
	ExtensionHookDMO()
	ExtensionHookDMO(DmcTypeModifierMV mods)
protected	ExtensionHookDMO(String oc)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.
ExtensionHookDMO	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.
ExtensionHookDMO	getNew() Auto-generated derived classes override this to return an empty instance of themselves.
DefinitionName	getObjectName()
DmcAttribute<?>	getObjectNameAttribute()
ExtensionHookDMO	getSlice(DmcSliceInfo info) Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes.
String	getTargetObjectClass()
SectionREF	getUsesSection()
SectionREF	getUsesSectionREF()
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 usesSection to the specified value.
void	setUsesSection(SectionDMO value) Sets usesSection to the specified value.

Methods inherited from class org.dmd.templates.shared.generated.dmo.TdlDefinitionDMO

addDescription, addDescription, delDescription, delDescription, descriptionContains, getDefinedInTdlModule, getDefinedInTdlModuleREF, getDescription, getDescriptionSize, getDotName, getNthDescription, remDefinedInTdlModule, remDescription, remDotName, setDefinedInTdlModule, setDefinedInTdlModule, setDotName, setDotName

Methods inherited from class org.dmd.dms.generated.dmo.DSDefinitionDMO

addComment, addExample, addNvp, addOptimize, addQuestion, addSkip, addTags, getComment, getDefinedIn, getDescriptionWithNewlines, getDmoFromModule, getExample, getFile, getHint, getIdToAttrInfo, getLineNumber, getNvp, getObsolete, getOptimize, getQuestion, getRelationship, getSearchable, getSkip, getSortName, getStringToAttrInfo, getTags, getVersion, getWhy, setDefinedIn, setDmoFromModule, setFile, setHint, setLineNumber, setObsolete, setRelationship, setSearchable, setSortName, setVersion, setWhy

Methods inherited from class org.dmd.dmc.DmcObject

add, add, addAux, addAux, addBackref, allowsAttribute, applyModifier, clearReferenceInfo, cloneIt, del, del, delFromEmptyAttribute, deserializeIt, get, get, get, getAdditionalAttributes, getAttributeInfo, getAttributeInfo, getAttributeIterator, getAttributeNames, getAttributes, getAttributeValidators, getBackref, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getContainer, getDataType, getFullClassName, getLastValue, getModifier, getObjectClass, getObjectValidators, getReferringObjects, getReferringObjectsViaAttribute, getStagingObject, hasAux, hasValue, isModrec, isReferenced, isStaging, modrec, nth, nthNullFromEmptyAttribute, numberOfAttributes, populateSlice, referenceCount, rem, rem, removeAux, removeBackref, resolveReferences, resolveReferences, resolveReferences, resolveReferencesExceptClass, resolveReferencesExceptClass, serializeIt, set, set, setContainer, setLastValue, setModifier, shallowCopy, staging, supportsBackrefTracking, toCompactJSON, toCompactJSON, toJSON, toJSON, toJSON, toOIF, toOIF, toOIFNoPadding, toPersistentOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class java.lang.Object

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

Field Detail

constructionClassName

public static final String constructionClassName

See Also:

Constant Field Values

Constructor Detail

ExtensionHookDMO

public ExtensionHookDMO()

ExtensionHookDMO

protected ExtensionHookDMO(String oc)

ExtensionHookDMO

public ExtensionHookDMO(DmcTypeModifierMV mods)

Method Detail

getNew

public ExtensionHookDMO getNew()

Description copied from class: DmcObject

Auto-generated derived classes override this to return an empty instance of themselves. This supports cloning.

Overrides:

getNew in class DSDefinitionDMO

Returns:

An instance of the derived class.

getSlice

public ExtensionHookDMO getSlice(DmcSliceInfo info)

Description copied from class: DmcObject

Auto-generated derived classes override this to return an instance of themselves with just the specified slice of attributes. In the case of named objects, the object name is always part of the slice.

Overrides:

getSlice in class DSDefinitionDMO

Parameters:

info - the slice info

Returns:

An instance of the derived class with the specified slice of attributes.

getModificationRecorder

public ExtensionHookDMO getModificationRecorder()

getObjectName

public DefinitionName getObjectName()

Specified by:

getObjectName in interface DmcNamedObjectIF

Overrides:

getObjectName in class ContainedElementDMO

Returns:

The name of this object from the name attribute.

getObjectNameAttribute

public DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class ContainedElementDMO

Returns:

The name attribute.

equals

public boolean equals(Object obj)

Description copied from class: DmcObject

This method performs an attribute by attribute comparison of this object with the specified object and returns true if they are equal.

Specified by:

equals in interface DmcNamedObjectIF

Overrides:

equals in class ContainedElementDMO

Parameters:

obj - The comparison object.

Returns:

true if we equal the specified object

hashCode

public int hashCode()

Overrides:

hashCode in class ContainedElementDMO

getName

public DefinitionName getName()

Description copied from class: DSDefinitionDMO

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.

Overrides:

getName in class ContainedElementDMO

Returns:

the DefinitionName

setName

public void setName(DefinitionName value)

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMO

Parameters:

value - DefinitionName

setName

public void setName(Object value)
             throws DmcValueException

Sets name to the specified value.

Overrides:

setName in class ContainedElementDMO

Parameters:

value - A value compatible with DmcTypeDefinitionNameSV

Throws:

DmcValueException - if value is not correct

remName

public void remName()

Removes the name attribute value.

Overrides:

remName in class ContainedElementDMO

getUsesSection

public SectionREF getUsesSection()

Returns:

the SectionREF

getUsesSectionREF

public SectionREF getUsesSectionREF()

Returns:

the reference to Section without attempting lazy resolution (if turned on).

setUsesSection

public void setUsesSection(SectionDMO value)

Sets usesSection to the specified value.

Parameters:

value - SectionDMO

setUsesSection

public void setUsesSection(Object value)
                    throws DmcValueException

Sets usesSection to the specified value.

Parameters:

value - A value compatible with DmcTypeSectionREFSV

Throws:

DmcValueException - if value is not correct

remUsesSection

public void remUsesSection()

Removes the usesSection attribute value.

getTargetObjectClass

public String getTargetObjectClass()

setTargetObjectClass

public void setTargetObjectClass(String value)

Sets targetObjectClass to the specified value.

Parameters:

value - String

setTargetObjectClass

public void setTargetObjectClass(Object value)
                          throws DmcValueException

Sets targetObjectClass to the specified value.

Parameters:

value - A value compatible with DmcTypeStringSV

Throws:

DmcValueException - if value is not correct

remTargetObjectClass

public void remTargetObjectClass()

Removes the targetObjectClass attribute value.