Package org.codehaus.gmavenplus.model

Class GroovyDocConfiguration

java.lang.Object

org.codehaus.gmavenplus.model.GroovyDocConfiguration

All Implemented Interfaces:

Serializable

public class GroovyDocConfiguration
extends Object
implements Serializable

Holds configuration for GroovyDoc generation.

Author:

Keegan Witt

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
GroovyDocConfiguration(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories, List<?> classpath, File outputDirectory)

Method Summary

Modifier and Type	Method	Description
List<?>	getClasspath()
String	getClasspathResourceManagerClass()
String[]	getDefaultClassTemplates()
String[]	getDefaultDocTemplates()
String[]	getDefaultPackageTemplates()
Properties	getDocProperties()
String	getDocTitle()
String	getFileOutputToolClass()
String	getFooter()
String	getGroovyDocToolClass()
String	getHeader()
IncludeClasspath	getIncludeClasspath()
String	getLanguageLevel()
String	getLinkArgumentClass()
List<Link>	getLinks()
File	getOutputDirectory()
String	getOutputToolClass()
File	getOverviewFile()
String	getResourceManagerClass()
String	getScope()
org.apache.maven.shared.model.fileset.FileSet[]	getSourceDirectories()
String	getWindowTitle()
boolean	isAttachGroovyDocAnnotation()
boolean	isDisplayAuthor()
void	setAttachGroovyDocAnnotation(boolean attachGroovyDocAnnotation)
void	setClasspathResourceManagerClass(String classpathResourceManagerClass)
void	setDefaultClassTemplates(String[] defaultClassTemplates)
void	setDefaultDocTemplates(String[] defaultDocTemplates)
void	setDefaultPackageTemplates(String[] defaultPackageTemplates)
void	setDisplayAuthor(boolean displayAuthor)
void	setDocProperties(Properties docProperties)
void	setDocTitle(String docTitle)
void	setFileOutputToolClass(String fileOutputToolClass)
void	setFooter(String footer)
void	setGroovyDocToolClass(String groovyDocToolClass)
void	setHeader(String header)
void	setIncludeClasspath(IncludeClasspath includeClasspath)
void	setLanguageLevel(String languageLevel)
void	setLinkArgumentClass(String linkArgumentClass)
void	setLinks(List<Link> links)
void	setOutputToolClass(String outputToolClass)
void	setOverviewFile(File overviewFile)
void	setResourceManagerClass(String resourceManagerClass)
void	setScope(String scope)
void	setWindowTitle(String windowTitle)

Methods inherited from class java.lang.Object

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

Constructor Details

GroovyDocConfiguration

public GroovyDocConfiguration(org.apache.maven.shared.model.fileset.FileSet[] sourceDirectories,
 List<?> classpath,
 File outputDirectory)

Method Details

getSourceDirectories

public org.apache.maven.shared.model.fileset.FileSet[] getSourceDirectories()

getClasspath

public List<?> getClasspath()

getOutputDirectory

public File getOutputDirectory()

getIncludeClasspath

public IncludeClasspath getIncludeClasspath()

setIncludeClasspath

public void setIncludeClasspath(IncludeClasspath includeClasspath)

getLinks

public List<Link> getLinks()

setLinks

public void setLinks(List<Link> links)

getDefaultDocTemplates

public String[] getDefaultDocTemplates()

setDefaultDocTemplates

public void setDefaultDocTemplates(String[] defaultDocTemplates)

getDefaultPackageTemplates

public String[] getDefaultPackageTemplates()

setDefaultPackageTemplates

public void setDefaultPackageTemplates(String[] defaultPackageTemplates)

getDefaultClassTemplates

public String[] getDefaultClassTemplates()

setDefaultClassTemplates

public void setDefaultClassTemplates(String[] defaultClassTemplates)

getDocProperties

public Properties getDocProperties()

setDocProperties

public void setDocProperties(Properties docProperties)

getGroovyDocToolClass

public String getGroovyDocToolClass()

setGroovyDocToolClass

public void setGroovyDocToolClass(String groovyDocToolClass)

getOutputToolClass

public String getOutputToolClass()

setOutputToolClass

public void setOutputToolClass(String outputToolClass)

getFileOutputToolClass

public String getFileOutputToolClass()

setFileOutputToolClass

public void setFileOutputToolClass(String fileOutputToolClass)

getResourceManagerClass

public String getResourceManagerClass()

setResourceManagerClass

public void setResourceManagerClass(String resourceManagerClass)

getClasspathResourceManagerClass

public String getClasspathResourceManagerClass()

setClasspathResourceManagerClass

public void setClasspathResourceManagerClass(String classpathResourceManagerClass)

getLinkArgumentClass

public String getLinkArgumentClass()

setLinkArgumentClass

public void setLinkArgumentClass(String linkArgumentClass)

isAttachGroovyDocAnnotation

public boolean isAttachGroovyDocAnnotation()

setAttachGroovyDocAnnotation

public void setAttachGroovyDocAnnotation(boolean attachGroovyDocAnnotation)

getOverviewFile

public File getOverviewFile()

setOverviewFile

public void setOverviewFile(File overviewFile)

getScope

public String getScope()

setScope

public void setScope(String scope)

getWindowTitle

public String getWindowTitle()

setWindowTitle

public void setWindowTitle(String windowTitle)

getDocTitle

public String getDocTitle()

setDocTitle

public void setDocTitle(String docTitle)

getFooter

public String getFooter()

setFooter

public void setFooter(String footer)

getHeader

public String getHeader()

setHeader

public void setHeader(String header)

isDisplayAuthor

public boolean isDisplayAuthor()

setDisplayAuthor

public void setDisplayAuthor(boolean displayAuthor)

getLanguageLevel

public String getLanguageLevel()

setLanguageLevel

public void setLanguageLevel(String languageLevel)