|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.schmant.support.AbstractArgumentChecker org.schmant.task.template.jdk.javadoc.AbstractStandardDocletDecorator<T>
public abstract class AbstractStandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
Abstract base class for StandardDocletDecorator
implementations.
Constructor Summary | |
---|---|
AbstractStandardDocletDecorator()
|
Method Summary | |
---|---|
T |
addExcludeDocFilesSubdir(String name)
Corresponds to one segment of the Standard doclet's -excludedocfilessubdir parameter. |
T |
addExcludeDocFilesSubdirs(Object o)
Corresponds to setting a segment of the Standard doclet's -excludedocfilessubdir parameter for each object in the collection. |
T |
addGroup(JavadocPackageGroup pg)
Add one package group. |
T |
addGroup(String heading,
String packages)
Add one package group. |
T |
addGroups(Object o)
Add a collection of package groups. |
T |
addLink(String l)
Corresponds to the Standard doclet's -link parameter. |
T |
addLinks(Object o)
Add a collection of links to the Standard doclet. |
T |
addNoQualifierPackage(String name)
Corresponds to one segment of the Standard doclet's -noqualifier
parameter. |
T |
addNoQualifierPackages(Object o)
Corresponds to setting a segment of the Standard doclet's -noqualifier parameter for each object in the collection. |
T |
addOfflineLink(String l)
Corresponds to the Standard doclet's -linkoffline parameter. |
T |
addOfflineLinks(Object o)
Add a collection of links. |
T |
disableComment(boolean b)
Corresponds to the Standard doclet's -nocomment flag. |
T |
disableDeprecated(boolean b)
Corresponds to the Standard doclet's -nodeprecated flag. |
T |
disableDeprecatedList(boolean b)
Corresponds to the Standard doclet's -nodeprecatedlist flag. |
T |
disableHelp(boolean b)
Corresponds to the Standard doclet's -nohelp flag. |
T |
disableIndex(boolean b)
Corresponds to the Standard doclet's -noindex flag. |
T |
disableNavbar(boolean b)
Corresponds to the Standard doclet's -nonavbar flag. |
T |
disableSince(boolean b)
Corresponds to the Standard doclet's -nosince flag. |
T |
disableTimestamp(boolean b)
Corresponds to the Standard doclet's -notimestamp flag. |
T |
disableTree(boolean b)
Corresponds to the Standard doclet's -notree flag. |
protected String |
getBottom()
|
protected String |
getCharset()
|
protected String |
getDocEncoding()
|
protected String |
getDocTitle()
|
protected Collection<String> |
getExcludeDocFilesSubdirs()
|
protected String |
getFooter()
|
protected Collection<JavadocPackageGroup> |
getGroups()
|
protected String |
getHeader()
|
protected Object |
getHelpFile()
|
protected Collection<String> |
getLinks()
|
protected Collection<String> |
getNoQualifierPackages()
|
protected Collection<String> |
getOfflineLinks()
|
protected Object |
getStylesheetFile()
|
protected Object |
getTarget()
|
protected T |
getThis()
|
protected String |
getWindowTitle()
|
protected boolean |
isAuthor()
|
protected boolean |
isCommentDisabled()
|
protected boolean |
isDeprecatedDisabled()
|
protected boolean |
isDeprecatedListDisabled()
|
protected boolean |
isDocFilesSubdirs()
|
protected boolean |
isHelpDisabled()
|
protected boolean |
isIndexDisabled()
|
protected boolean |
isKeywords()
|
protected boolean |
isLinkSource()
|
protected boolean |
isNavbarDisabled()
|
protected boolean |
isSerialWarn()
|
protected boolean |
isSinceDisabled()
|
protected boolean |
isSplitIndex()
|
protected boolean |
isTimestampDisabled()
|
protected boolean |
isTreeDisabled()
|
protected boolean |
isUse()
|
protected boolean |
isVersion()
|
T |
setAuthor(boolean b)
Corresponds to the Standard doclet's -author flag. |
T |
setBottom(String b)
Corresponds to the Standard doclet's -bottom parameter. |
T |
setCharset(String name)
Corresponds to the Standard doclet's -charset parameter. |
T |
setDocEncoding(String name)
Corresponds to the Standard doclet's -docencoding parameter. |
T |
setDocFilesSubdirs(boolean b)
Corresponds to the Standard doclet's -docfilessubdirs flag. |
T |
setDocTitle(String title)
Corresponds to the Standard doclet's -doctitle parameter. |
T |
setFooter(String f)
Corresponds to the Standard doclet's -footer parameter. |
T |
setHeader(String h)
Corresponds to the Standard doclet's -header parameter. |
T |
setHelpFile(Object o)
Corresponds to the Standard doclet's -helpfile parameter. |
T |
setKeywords(boolean b)
Corresponds to the Standard doclet's -keywords flag. |
T |
setLinkSource(boolean b)
Corresponds to the Standard doclet's -linksource flag. |
T |
setSerialWarn(boolean b)
Corresponds to the Standard doclet's -serialwarn flag. |
T |
setSplitIndex(boolean b)
Corresponds to the Standard doclet's -splitindex flag. |
T |
setStylesheetFile(Object o)
Corresponds to the Standard doclet's -stylesheetfile flag. |
T |
setTarget(Object o)
Set the target. |
T |
setUse(boolean b)
Corresponds to the Standard doclet's -use flag. |
T |
setVersion(boolean b)
Corresponds to the Standard doclet's -version flag. |
T |
setWindowTitle(String title)
Corresponds to the Standard doclet's -windowtitle parameter. |
Methods inherited from class org.schmant.support.AbstractArgumentChecker |
---|
check, check, check, check |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.schmant.task.ValidatingDecorator |
---|
validate |
Constructor Detail |
---|
public AbstractStandardDocletDecorator()
Method Detail |
---|
protected final T getThis()
public final T setTarget(Object o)
TargetConfigurable
setTarget
in interface TargetConfigurable<T extends AbstractStandardDocletDecorator<T>>
o
- The target.
this
protected final Object getTarget()
public final T setUse(boolean b)
StandardDocletDecorator
-use
flag.
The default value for this property is false
.
setUse
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Generate usage pages for each documented class and package?
this
.protected final boolean isUse()
public final T setVersion(boolean b)
StandardDocletDecorator
-version
flag.
The default value for this property is false
.
setVersion
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should version information be included?
this
protected final boolean isVersion()
public final T setAuthor(boolean b)
StandardDocletDecorator
-author
flag.
The default value for this property is false
.
setAuthor
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should author information be included?
this
protected final boolean isAuthor()
public final T setSplitIndex(boolean b)
StandardDocletDecorator
-splitindex
flag.
The default value for this property is false
.
setSplitIndex
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the index file be split into multiple files?
this
protected final boolean isSplitIndex()
public final T setWindowTitle(String title)
StandardDocletDecorator
-windowtitle
parameter.
The default value for this property is the value of the docTitle
property. (See StandardDocletDecorator.setDocTitle(String)
.)
setWindowTitle
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
title
- The value of the HTML title
tag in the generated
documentation.
this
StandardDocletDecorator.setDocTitle(String)
protected final String getWindowTitle()
public final T setDocTitle(String title)
StandardDocletDecorator
-doctitle
parameter.
The default value for this property is empty.
setDocTitle
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
title
- The title for the overview summary file in the
documentation.
this
StandardDocletDecorator.setWindowTitle(String)
protected final String getDocTitle()
public final T setHeader(String h)
StandardDocletDecorator
-header
parameter.
The default value for this property is empty.
setHeader
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
h
- The header placed at the top of each generated file.
this
protected final String getHeader()
public final T setFooter(String f)
StandardDocletDecorator
-footer
parameter.
The default value for this property is empty.
setFooter
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
f
- The footer text placed at the bottom of each generated
file.
this
protected final String getFooter()
public final T setBottom(String b)
StandardDocletDecorator
-bottom
parameter.
The default value for this property is empty.
setBottom
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- The text placed at the bottom of each generated file.
this
protected final String getBottom()
public final T addLink(String l)
StandardDocletDecorator
-link
parameter.
The default value for this property is empty.
addLink
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
l
- An URL for external API documentation.
this
public final T addLinks(Object o)
StandardDocletDecorator
-link
parameter for each link in the collection.
addLinks
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- A collection of links.
this
protected final Collection<String> getLinks()
public final T addOfflineLink(String l)
StandardDocletDecorator
-linkoffline
parameter.
The default value for this property is empty.
addOfflineLink
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
l
- An URL for external API documentation.
this
public final T addOfflineLinks(Object o)
StandardDocletDecorator
-offlinelink
parameter for each link in the
collection.
addOfflineLinks
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- A collection of links.
this
protected final Collection<String> getOfflineLinks()
public final T setLinkSource(boolean b)
StandardDocletDecorator
-linksource
flag.
The default value for this property is false
.
setLinkSource
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should a HTML version of each source file be generated?
this
protected final boolean isLinkSource()
public final T addGroup(String heading, String packages)
StandardDocletDecorator
-group
parameter.
addGroup
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
heading
- The group name.packages
- The packages included in the group.
this
public final T addGroup(JavadocPackageGroup pg)
StandardDocletDecorator
-group
parameter.
addGroup
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
pg
- The package group.
this
public final T addGroups(Object o)
StandardDocletDecorator
-group
parameter for each object in the collection.
addGroups
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- The collection
this
protected final Collection<JavadocPackageGroup> getGroups()
public final T disableDeprecated(boolean b)
StandardDocletDecorator
-nodeprecated
flag.
The default value for this property is false
.
disableDeprecated
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the generation of documentation for deprecated items be
disabled?
this
protected final boolean isDeprecatedDisabled()
public final T disableDeprecatedList(boolean b)
StandardDocletDecorator
-nodeprecatedlist
flag.
The default value for this property is false
.
disableDeprecatedList
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the generation of the deprecation list file (deprecated-list.html
) be disabled?
this
protected final boolean isDeprecatedListDisabled()
public final T disableSince(boolean b)
StandardDocletDecorator
-nosince
flag.
The default value for this property is false
.
disableSince
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the @since
tag be ignored?
this
protected final boolean isSinceDisabled()
public final T disableTree(boolean b)
StandardDocletDecorator
-notree
flag.
The default value for this property is false
.
disableTree
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the generation of class/interface hierarchy pages be
disabled?
this
protected final boolean isTreeDisabled()
public final T disableIndex(boolean b)
StandardDocletDecorator
-noindex
flag.
The default value for this property is false
.
disableIndex
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the generation of the documentation index page be
disabled?
this
protected final boolean isIndexDisabled()
public final T disableHelp(boolean b)
StandardDocletDecorator
-nohelp
flag.
The default value for this property is false
.
disableHelp
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the HELP link be disabled?
this
protected final boolean isHelpDisabled()
public final T disableNavbar(boolean b)
StandardDocletDecorator
-nonavbar
flag.
The default value for this property is false
.
disableNavbar
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the generation of the navigation bar be disabled?
this
protected final boolean isNavbarDisabled()
public final T setHelpFile(Object o)
StandardDocletDecorator
-helpfile
parameter.
Set the path to an external help file. The path is interpreted by
InterpretAsFileStrategy
.
The default value for this property is empty.
setHelpFile
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- The path to a help file.
this
protected final Object getHelpFile()
public final T setStylesheetFile(Object o)
StandardDocletDecorator
-stylesheetfile
flag.
Set the path to an external stylesheet (CSS) file. The path is
interpreted by
InterpretAsFileStrategy
.
The default value for this property is empty.
setStylesheetFile
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- The path to an external stylesheet file.
this
protected final Object getStylesheetFile()
public final T setSerialWarn(boolean b)
StandardDocletDecorator
-serialwarn
flag.
The default value for this property is false
.
setSerialWarn
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should the Javadoc compiler warn on missing @serial
tags?
this
protected final boolean isSerialWarn()
public final T setCharset(String name)
StandardDocletDecorator
-charset
parameter.
The default value for this property is empty.
setCharset
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
name
- The MIME name for a charset.
this
StandardDocletDecorator.setDocEncoding(String)
protected final String getCharset()
public final T setDocEncoding(String name)
StandardDocletDecorator
-docencoding
parameter.
The default value for this property is empty.
setDocEncoding
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
name
- The MIME name for a charset.
this
StandardDocletDecorator.setCharset(String)
protected final String getDocEncoding()
public final T setKeywords(boolean b)
StandardDocletDecorator
-keywords
flag.
The default value for this property is false
.
setKeywords
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Should HTML META tag keywords be added for each class?
this
protected final boolean isKeywords()
public final T setDocFilesSubdirs(boolean b)
StandardDocletDecorator
-docfilessubdirs
flag.
The default value for this property is false
.
setDocFilesSubdirs
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Enable deep copying of doclet files?
this
protected final boolean isDocFilesSubdirs()
public final T addExcludeDocFilesSubdir(String name)
StandardDocletDecorator
-excludedocfilessubdir
parameter.
addExcludeDocFilesSubdir
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
name
- A doc file subdir to exclude.
this
public final T addExcludeDocFilesSubdirs(Object o)
StandardDocletDecorator
-excludedocfilessubdir
parameter for each object in the collection.
addExcludeDocFilesSubdirs
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- A collection of doc files subdirs to exclude.
this
protected final Collection<String> getExcludeDocFilesSubdirs()
public final T addNoQualifierPackage(String name)
StandardDocletDecorator
-noqualifier
parameter.
addNoQualifierPackage
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
name
- A name for a package that should not be fully qualified in
the documentation.
this
public final T addNoQualifierPackages(Object o)
StandardDocletDecorator
-noqualifier
parameter for each object in the collection.
addNoQualifierPackages
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
o
- A collection of names.
this
protected final Collection<String> getNoQualifierPackages()
public final T disableTimestamp(boolean b)
StandardDocletDecorator
-notimestamp
flag.
The default value for this property is false
.
disableTimestamp
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Disable the timestamp hidden in each documentation file?
this
protected final boolean isTimestampDisabled()
public final T disableComment(boolean b)
StandardDocletDecorator
-nocomment
flag.
The default value for this property is false
.
disableComment
in interface StandardDocletDecorator<T extends AbstractStandardDocletDecorator<T>>
b
- Disable the entire comment body?
this
protected final boolean isCommentDisabled()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |