org.codehaus.mojo.servicedocgen

Class ServiceDocGenTemplate

java.lang.Object

org.codehaus.mojo.servicedocgen.ServiceDocGenTemplate

public class ServiceDocGenTemplate
extends Object

ServiceDocGenTemplate is a template bean representing the templates passed into ServiceDocGenReport

Author:

jguenther

Constructor Summary

Constructors

Constructor and Description
ServiceDocGenTemplate()
ServiceDocGenTemplate(String templateName)

Method Summary

Modifier and Type	Method and Description
String	getOutputName()
String	getOutputNameWithFallback()
String	getTemplateName()
void	setOutputName(String outputName)
void	setTemplateName(String templateName)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceDocGenTemplate

public ServiceDocGenTemplate()

ServiceDocGenTemplate

public ServiceDocGenTemplate(String templateName)

Method Detail

getTemplateName

public String getTemplateName()

Returns:

the filename of the velocity template used for generation.

setTemplateName

public void setTemplateName(String templateName)

Parameters:

templateName - is the new value of getTemplateName().

getOutputName

public String getOutputName()

Returns:

the filename of the file to generate from the template.

setOutputName

public void setOutputName(String outputName)

Parameters:

outputName - is the new value of getOutputName().

getOutputNameWithFallback

public String getOutputNameWithFallback()

Returns:

the filename of the file to generate from the template. If output name is not set, it will fallback to the template name excluding the ".vm" extension.

See Also:

getOutputName()