public class JavadocOptions
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Field and Description |
---|---|
private java.util.List<BootclasspathArtifact> |
bootclasspathArtifacts
Field bootclasspathArtifacts.
|
private boolean |
docfilesSubdirsUsed
Enables deep copying of the '**/doc-files'
directories and the specific 'resources' directory.
|
private java.util.List<DocletArtifact> |
docletArtifacts
Field docletArtifacts.
|
private java.lang.String |
excludedDocfilesSubdirs
List of exclusion patterns separated by ':' for deep copying
of the '**/doc-files' directories.
|
private java.util.List<java.lang.String> |
excludePackageNames
Field excludePackageNames.
|
private java.util.List<Group> |
groups
Field groups.
|
private java.lang.String |
javadocResourcesDirectory
Path relative to project basedir where javadoc
resources were located.
|
private java.util.List<java.lang.String> |
links
Field links.
|
private java.lang.String |
modelEncoding
Field modelEncoding.
|
private java.util.List<OfflineLink> |
offlineLinks
Field offlineLinks.
|
private java.util.List<ResourcesArtifact> |
resourcesArtifacts
Field resourcesArtifacts.
|
private java.util.List<TagletArtifact> |
tagletArtifacts
Field tagletArtifacts.
|
private java.util.List<Taglet> |
taglets
Field taglets.
|
private java.util.List<Tag> |
tags
Field tags.
|
Constructor and Description |
---|
JavadocOptions() |
Modifier and Type | Method and Description |
---|---|
void |
addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
Method addBootclasspathArtifact.
|
void |
addDocletArtifact(DocletArtifact docletArtifact)
Method addDocletArtifact.
|
void |
addExcludePackageName(java.lang.String string)
Method addExcludePackageName.
|
void |
addGroup(Group group)
Method addGroup.
|
void |
addLink(java.lang.String string)
Method addLink.
|
void |
addOfflineLink(OfflineLink offlineLink)
Method addOfflineLink.
|
void |
addResourcesArtifact(ResourcesArtifact resourcesArtifact)
Method addResourcesArtifact.
|
void |
addTag(Tag tag)
Method addTag.
|
void |
addTaglet(Taglet taglet)
Method addTaglet.
|
void |
addTagletArtifact(TagletArtifact tagletArtifact)
Method addTagletArtifact.
|
java.util.List<BootclasspathArtifact> |
getBootclasspathArtifacts()
Method getBootclasspathArtifacts.
|
java.util.List<DocletArtifact> |
getDocletArtifacts()
Method getDocletArtifacts.
|
java.lang.String |
getExcludedDocfilesSubdirs()
Get list of exclusion patterns separated by ':' for deep
copying of the '**/doc-files' directories.
|
java.util.List<java.lang.String> |
getExcludePackageNames()
Method getExcludePackageNames.
|
java.util.List<Group> |
getGroups()
Method getGroups.
|
java.lang.String |
getJavadocResourcesDirectory()
Get path relative to project basedir where javadoc resources
were located.
|
java.util.List<java.lang.String> |
getLinks()
Method getLinks.
|
java.lang.String |
getModelEncoding()
Get the modelEncoding field.
|
java.util.List<OfflineLink> |
getOfflineLinks()
Method getOfflineLinks.
|
java.util.List<ResourcesArtifact> |
getResourcesArtifacts()
Method getResourcesArtifacts.
|
java.util.List<TagletArtifact> |
getTagletArtifacts()
Method getTagletArtifacts.
|
java.util.List<Taglet> |
getTaglets()
Method getTaglets.
|
java.util.List<Tag> |
getTags()
Method getTags.
|
boolean |
isDocfilesSubdirsUsed()
Get enables deep copying of the '**/doc-files'
directories and the specific 'resources' directory.
|
void |
removeBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
Method removeBootclasspathArtifact.
|
void |
removeDocletArtifact(DocletArtifact docletArtifact)
Method removeDocletArtifact.
|
void |
removeExcludePackageName(java.lang.String string)
Method removeExcludePackageName.
|
void |
removeGroup(Group group)
Method removeGroup.
|
void |
removeLink(java.lang.String string)
Method removeLink.
|
void |
removeOfflineLink(OfflineLink offlineLink)
Method removeOfflineLink.
|
void |
removeResourcesArtifact(ResourcesArtifact resourcesArtifact)
Method removeResourcesArtifact.
|
void |
removeTag(Tag tag)
Method removeTag.
|
void |
removeTaglet(Taglet taglet)
Method removeTaglet.
|
void |
removeTagletArtifact(TagletArtifact tagletArtifact)
Method removeTagletArtifact.
|
void |
setBootclasspathArtifacts(java.util.List<BootclasspathArtifact> bootclasspathArtifacts)
Set a list of BootclasspathArtifact parameters.
|
void |
setDocfilesSubdirsUsed(boolean docfilesSubdirsUsed)
Set enables deep copying of the '**/doc-files'
directories and the specific 'resources' directory.
|
void |
setDocletArtifacts(java.util.List<DocletArtifact> docletArtifacts)
Set a list of DocletArtifact parameters.
|
void |
setExcludedDocfilesSubdirs(java.lang.String excludedDocfilesSubdirs)
Set list of exclusion patterns separated by ':' for deep
copying of the '**/doc-files' directories.
|
void |
setExcludePackageNames(java.util.List<java.lang.String> excludePackageNames)
Set list of subpackage patterns to exclude from javadoc
generation.
|
void |
setGroups(java.util.List<Group> groups)
Set a list of Group parameters.
|
void |
setJavadocResourcesDirectory(java.lang.String javadocResourcesDirectory)
Set path relative to project basedir where javadoc resources
were located.
|
void |
setLinks(java.util.List<java.lang.String> links)
Set list of URLs to javadocs for external classes.
|
void |
setModelEncoding(java.lang.String modelEncoding)
Set the modelEncoding field.
|
void |
setOfflineLinks(java.util.List<OfflineLink> offlineLinks)
Set a list of OfflineLink parameters.
|
void |
setResourcesArtifacts(java.util.List<ResourcesArtifact> resourcesArtifacts)
Set a list of ResourcesArtifact parameters.
|
void |
setTagletArtifacts(java.util.List<TagletArtifact> tagletArtifacts)
Set a list of TagletArtifact parameters.
|
void |
setTaglets(java.util.List<Taglet> taglets)
Set a list of Taglet parameters.
|
void |
setTags(java.util.List<Tag> tags)
Set a list of Tag parameters.
|
private java.util.List<Group> groups
private java.util.List<Tag> tags
private java.util.List<DocletArtifact> docletArtifacts
private java.util.List<Taglet> taglets
private java.util.List<OfflineLink> offlineLinks
private java.util.List<TagletArtifact> tagletArtifacts
private java.util.List<ResourcesArtifact> resourcesArtifacts
private java.util.List<BootclasspathArtifact> bootclasspathArtifacts
private java.util.List<java.lang.String> links
private java.util.List<java.lang.String> excludePackageNames
private boolean docfilesSubdirsUsed
private java.lang.String excludedDocfilesSubdirs
private java.lang.String javadocResourcesDirectory
private java.lang.String modelEncoding
public void addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
bootclasspathArtifact
- public void addDocletArtifact(DocletArtifact docletArtifact)
docletArtifact
- public void addExcludePackageName(java.lang.String string)
string
- public void addGroup(Group group)
group
- public void addLink(java.lang.String string)
string
- public void addOfflineLink(OfflineLink offlineLink)
offlineLink
- public void addResourcesArtifact(ResourcesArtifact resourcesArtifact)
resourcesArtifact
- public void addTag(Tag tag)
tag
- public void addTaglet(Taglet taglet)
taglet
- public void addTagletArtifact(TagletArtifact tagletArtifact)
tagletArtifact
- public java.util.List<BootclasspathArtifact> getBootclasspathArtifacts()
public java.util.List<DocletArtifact> getDocletArtifacts()
public java.util.List<java.lang.String> getExcludePackageNames()
public java.lang.String getExcludedDocfilesSubdirs()
public java.util.List<Group> getGroups()
public java.lang.String getJavadocResourcesDirectory()
public java.util.List<java.lang.String> getLinks()
public java.lang.String getModelEncoding()
public java.util.List<OfflineLink> getOfflineLinks()
public java.util.List<ResourcesArtifact> getResourcesArtifacts()
public java.util.List<TagletArtifact> getTagletArtifacts()
public java.util.List<Taglet> getTaglets()
public java.util.List<Tag> getTags()
public boolean isDocfilesSubdirsUsed()
public void removeBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
bootclasspathArtifact
- public void removeDocletArtifact(DocletArtifact docletArtifact)
docletArtifact
- public void removeExcludePackageName(java.lang.String string)
string
- public void removeGroup(Group group)
group
- public void removeLink(java.lang.String string)
string
- public void removeOfflineLink(OfflineLink offlineLink)
offlineLink
- public void removeResourcesArtifact(ResourcesArtifact resourcesArtifact)
resourcesArtifact
- public void removeTag(Tag tag)
tag
- public void removeTaglet(Taglet taglet)
taglet
- public void removeTagletArtifact(TagletArtifact tagletArtifact)
tagletArtifact
- public void setBootclasspathArtifacts(java.util.List<BootclasspathArtifact> bootclasspathArtifacts)
bootclasspathArtifacts
- public void setDocfilesSubdirsUsed(boolean docfilesSubdirsUsed)
docfilesSubdirsUsed
- public void setDocletArtifacts(java.util.List<DocletArtifact> docletArtifacts)
docletArtifacts
- public void setExcludePackageNames(java.util.List<java.lang.String> excludePackageNames)
excludePackageNames
- public void setExcludedDocfilesSubdirs(java.lang.String excludedDocfilesSubdirs)
excludedDocfilesSubdirs
- public void setGroups(java.util.List<Group> groups)
groups
- public void setJavadocResourcesDirectory(java.lang.String javadocResourcesDirectory)
javadocResourcesDirectory
- public void setLinks(java.util.List<java.lang.String> links)
links
- public void setModelEncoding(java.lang.String modelEncoding)
modelEncoding
- public void setOfflineLinks(java.util.List<OfflineLink> offlineLinks)
offlineLinks
- public void setResourcesArtifacts(java.util.List<ResourcesArtifact> resourcesArtifacts)
resourcesArtifacts
- public void setTagletArtifacts(java.util.List<TagletArtifact> tagletArtifacts)
tagletArtifacts
- public void setTaglets(java.util.List<Taglet> taglets)
taglets
- public void setTags(java.util.List<Tag> tags)
tags
-