com.tools20022.metamodel

Class MMDoclet

java.lang.Object

com.tools20022.metamodel.MMDoclet

All Implemented Interfaces:

GeneratedMetamodelBean, MMModelEntity

public class MMDoclet
extends Object
implements MMModelEntity

A Doclet provides a way of adding categorised documentation to an model entity.

Field Summary

Fields

Modifier and Type	Field and Description
static Metamodel.MetamodelAttribute<MMDoclet,Optional<String>>	contentAttribute The content for the documentation.
static Metamodel.MetamodelAttribute<MMDoclet,Optional<String>>	typeAttribute The type of doclet.

Fields inherited from interface com.tools20022.metamodel.MMModelEntity

nextVersionsAttribute, objectIdentifierAttribute, previousVersionAttribute

Constructor Summary

Constructors

Constructor and Description
MMDoclet()

Method Summary

Modifier and Type	Method and Description
MMRepositoryConcept	getContainer()
Optional<String>	getContent() The content for the documentation.
Metamodel.MetamodelType<? extends MMDoclet>	getMetamodel()
List<MMModelEntity>	getNextVersions() List of next versions of a ModelEntity that stem from this ModelEntity.
Optional<String>	getObjectIdentifier() Uniquely identifies the RepositoryConcept
Optional<MMModelEntity>	getPreviousVersion() Previous version of a ModelEntity that this ModelEntity stems from.
Optional<String>	getType() The type of doclet.
static Metamodel.MetamodelType<? extends MMDoclet>	metaType()

Methods inherited from class java.lang.Object

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

Field Detail

typeAttribute

public static final Metamodel.MetamodelAttribute<MMDoclet,Optional<String>> typeAttribute

The type of doclet. The definition of the doclet type is left open so that new doclet types can be easily added without the need for a change to the meta-model.

contentAttribute

public static final Metamodel.MetamodelAttribute<MMDoclet,Optional<String>> contentAttribute

The content for the documentation.

Constructor Detail

MMDoclet

public MMDoclet()

Method Detail

getContainer

public MMRepositoryConcept getContainer()

Specified by:

getContainer in interface GeneratedMetamodelBean

getMetamodel

public Metamodel.MetamodelType<? extends MMDoclet> getMetamodel()

Specified by:

getMetamodel in interface GeneratedMetamodelBean

metaType

public static Metamodel.MetamodelType<? extends MMDoclet> metaType()

Specified by:

metaType in interface MMModelEntity

getType

public Optional<String> getType()

The type of doclet. The definition of the doclet type is left open so that new doclet types can be easily added without the need for a change to the meta-model.

getContent

public Optional<String> getContent()

The content for the documentation.

getNextVersions

public List<MMModelEntity> getNextVersions()

Description copied from interface: MMModelEntity

List of next versions of a ModelEntity that stem from this ModelEntity. Allows version control management.

Specified by:

getNextVersions in interface MMModelEntity

See Also:

MMModelEntity.getPreviousVersion()

getPreviousVersion

public Optional<MMModelEntity> getPreviousVersion()

Description copied from interface: MMModelEntity

Previous version of a ModelEntity that this ModelEntity stems from. Allows version control management.

Specified by:

getPreviousVersion in interface MMModelEntity

See Also:

MMModelEntity.getNextVersions()

getObjectIdentifier

public Optional<String> getObjectIdentifier()

Description copied from interface: MMModelEntity

Uniquely identifies the RepositoryConcept

Specified by:

getObjectIdentifier in interface MMModelEntity