org.dmd.dsd.tools.dsdwizard.generated.dmtdl

Class DmtdlFile

java.lang.Object

org.dmd.dsd.tools.dsdwizard.generated.dmtdl.DmtdlFile

All Implemented Interfaces:

SectionIF, ValueContainerIF

public class DmtdlFile
extends Object
implements SectionIF

Constructor Summary

Constructors

Constructor and Description
DmtdlFile()
DmtdlFile(String dslName_, String package_, String comment_) Constructs a new DmtdlFile section.

Method Summary

Modifier and Type	Method and Description
void	format(FormattedArtifactIF artifact) Adds formatted text to the specified artifact.
void	format(FormattedArtifactIF artifact, Template template)
String	getValue(String name)
DmtdlFile	setComment(String comment_)
DmtdlFile	setDslName(String dslName_)
DmtdlFile	setPackage(String package_)

Methods inherited from class java.lang.Object

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

Constructor Detail

DmtdlFile

public DmtdlFile()

DmtdlFile

public DmtdlFile(String dslName_,
                 String package_,
                 String comment_)

Constructs a new DmtdlFile section.

Parameters:

dslName_ - The DSL name

package_ - The package name of the DSL's html doc generator.

comment_ - This is an embedded value that will be replaced by ::comment:: Generated from: org.dmd.templates.server.extended.Section.generateSectionClass(Section.java:143)

Method Detail

setDslName

public DmtdlFile setDslName(String dslName_)

setPackage

public DmtdlFile setPackage(String package_)

setComment

public DmtdlFile setComment(String comment_)

getValue

public String getValue(String name)

Specified by:

getValue in interface ValueContainerIF

Parameters:

name - the name of the value.

Returns:

The value or the empty string if it's not available.

format

public void format(FormattedArtifactIF artifact)
            throws IOException

Description copied from interface: SectionIF

Adds formatted text to the specified artifact. If this Section contains other Sections, their formatted content if recursively added.

Specified by:

format in interface SectionIF

Parameters:

artifact - the artifact being formatted.

Throws:

IOException

format

public void format(FormattedArtifactIF artifact,
                   Template template)
            throws IOException

Throws:

IOException