org.apache.maven.plugin.javadoc.options
Class JavadocOptions

java.lang.Object
  extended by org.apache.maven.plugin.javadoc.options.JavadocOptions
All Implemented Interfaces:
Serializable

public class JavadocOptions
extends Object
implements Serializable

Root class to contain all javadoc configuration options for inclusion in javadoc bundle archives.

Version:
$Revision: 922314 $ $Date: 2014-09-15 20:18:14 +0000 (Mon, 15 Sep 2014) $
See Also:
Serialized Form

Constructor Summary
JavadocOptions()
           
 
Method Summary
 void addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
          Method addBootclasspathArtifact.
 void addDocletArtifact(DocletArtifact docletArtifact)
          Method addDocletArtifact.
 void addExcludePackageName(String string)
          Method addExcludePackageName.
 void addGroup(Group group)
          Method addGroup.
 void addLink(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.
 List<BootclasspathArtifact> getBootclasspathArtifacts()
          Method getBootclasspathArtifacts.
 List<DocletArtifact> getDocletArtifacts()
          Method getDocletArtifacts.
 String getExcludedDocfilesSubdirs()
          Get list of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories.
 List<String> getExcludePackageNames()
          Method getExcludePackageNames.
 List<Group> getGroups()
          Method getGroups.
 String getJavadocResourcesDirectory()
          Get path relative to project basedir where javadoc resources were located.
 List<String> getLinks()
          Method getLinks.
 String getModelEncoding()
          Get the modelEncoding field.
 List<OfflineLink> getOfflineLinks()
          Method getOfflineLinks.
 List<ResourcesArtifact> getResourcesArtifacts()
          Method getResourcesArtifacts.
 List<TagletArtifact> getTagletArtifacts()
          Method getTagletArtifacts.
 List<Taglet> getTaglets()
          Method getTaglets.
 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(String string)
          Method removeExcludePackageName.
 void removeGroup(Group group)
          Method removeGroup.
 void removeLink(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(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(List<DocletArtifact> docletArtifacts)
          Set a list of DocletArtifact parameters.
 void setExcludedDocfilesSubdirs(String excludedDocfilesSubdirs)
          Set list of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories.
 void setExcludePackageNames(List<String> excludePackageNames)
          Set list of subpackage patterns to exclude from javadoc generation.
 void setGroups(List<Group> groups)
          Set a list of Group parameters.
 void setJavadocResourcesDirectory(String javadocResourcesDirectory)
          Set path relative to project basedir where javadoc resources were located.
 void setLinks(List<String> links)
          Set list of URLs to javadocs for external classes.
 void setModelEncoding(String modelEncoding)
          Set the modelEncoding field.
 void setOfflineLinks(List<OfflineLink> offlineLinks)
          Set a list of OfflineLink parameters.
 void setResourcesArtifacts(List<ResourcesArtifact> resourcesArtifacts)
          Set a list of ResourcesArtifact parameters.
 void setTagletArtifacts(List<TagletArtifact> tagletArtifacts)
          Set a list of TagletArtifact parameters.
 void setTaglets(List<Taglet> taglets)
          Set a list of Taglet parameters.
 void setTags(List<Tag> tags)
          Set a list of Tag parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocOptions

public JavadocOptions()
Method Detail

addBootclasspathArtifact

public void addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
Method addBootclasspathArtifact.

Parameters:
bootclasspathArtifact -

addDocletArtifact

public void addDocletArtifact(DocletArtifact docletArtifact)
Method addDocletArtifact.

Parameters:
docletArtifact -

addExcludePackageName

public void addExcludePackageName(String string)
Method addExcludePackageName.

Parameters:
string -

addGroup

public void addGroup(Group group)
Method addGroup.

Parameters:
group -

addLink

public void addLink(String string)
Method addLink.

Parameters:
string -

addOfflineLink

public void addOfflineLink(OfflineLink offlineLink)
Method addOfflineLink.

Parameters:
offlineLink -

addResourcesArtifact

public void addResourcesArtifact(ResourcesArtifact resourcesArtifact)
Method addResourcesArtifact.

Parameters:
resourcesArtifact -

addTag

public void addTag(Tag tag)
Method addTag.

Parameters:
tag -

addTaglet

public void addTaglet(Taglet taglet)
Method addTaglet.

Parameters:
taglet -

addTagletArtifact

public void addTagletArtifact(TagletArtifact tagletArtifact)
Method addTagletArtifact.

Parameters:
tagletArtifact -

getBootclasspathArtifacts

public List<BootclasspathArtifact> getBootclasspathArtifacts()
Method getBootclasspathArtifacts.

Returns:
List

getDocletArtifacts

public List<DocletArtifact> getDocletArtifacts()
Method getDocletArtifacts.

Returns:
List

getExcludePackageNames

public List<String> getExcludePackageNames()
Method getExcludePackageNames.

Returns:
List

getExcludedDocfilesSubdirs

public String getExcludedDocfilesSubdirs()
Get list of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories.

Returns:
String

getGroups

public List<Group> getGroups()
Method getGroups.

Returns:
List

getJavadocResourcesDirectory

public String getJavadocResourcesDirectory()
Get path relative to project basedir where javadoc resources were located. This is mainly useful in multimodule builds where the reactor is still populated.

Returns:
String

getLinks

public List<String> getLinks()
Method getLinks.

Returns:
List

getModelEncoding

public String getModelEncoding()
Get the modelEncoding field.

Returns:
String

getOfflineLinks

public List<OfflineLink> getOfflineLinks()
Method getOfflineLinks.

Returns:
List

getResourcesArtifacts

public List<ResourcesArtifact> getResourcesArtifacts()
Method getResourcesArtifacts.

Returns:
List

getTagletArtifacts

public List<TagletArtifact> getTagletArtifacts()
Method getTagletArtifacts.

Returns:
List

getTaglets

public List<Taglet> getTaglets()
Method getTaglets.

Returns:
List

getTags

public List<Tag> getTags()
Method getTags.

Returns:
List

isDocfilesSubdirsUsed

public boolean isDocfilesSubdirsUsed()
Get enables deep copying of the '**/doc-files' directories and the specific 'resources' directory.

Returns:
boolean

removeBootclasspathArtifact

public void removeBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
Method removeBootclasspathArtifact.

Parameters:
bootclasspathArtifact -

removeDocletArtifact

public void removeDocletArtifact(DocletArtifact docletArtifact)
Method removeDocletArtifact.

Parameters:
docletArtifact -

removeExcludePackageName

public void removeExcludePackageName(String string)
Method removeExcludePackageName.

Parameters:
string -

removeGroup

public void removeGroup(Group group)
Method removeGroup.

Parameters:
group -

removeLink

public void removeLink(String string)
Method removeLink.

Parameters:
string -

removeOfflineLink

public void removeOfflineLink(OfflineLink offlineLink)
Method removeOfflineLink.

Parameters:
offlineLink -

removeResourcesArtifact

public void removeResourcesArtifact(ResourcesArtifact resourcesArtifact)
Method removeResourcesArtifact.

Parameters:
resourcesArtifact -

removeTag

public void removeTag(Tag tag)
Method removeTag.

Parameters:
tag -

removeTaglet

public void removeTaglet(Taglet taglet)
Method removeTaglet.

Parameters:
taglet -

removeTagletArtifact

public void removeTagletArtifact(TagletArtifact tagletArtifact)
Method removeTagletArtifact.

Parameters:
tagletArtifact -

setBootclasspathArtifacts

public void setBootclasspathArtifacts(List<BootclasspathArtifact> bootclasspathArtifacts)
Set a list of BootclasspathArtifact parameters.

Parameters:
bootclasspathArtifacts -

setDocfilesSubdirsUsed

public void setDocfilesSubdirsUsed(boolean docfilesSubdirsUsed)
Set enables deep copying of the '**/doc-files' directories and the specific 'resources' directory.

Parameters:
docfilesSubdirsUsed -

setDocletArtifacts

public void setDocletArtifacts(List<DocletArtifact> docletArtifacts)
Set a list of DocletArtifact parameters.

Parameters:
docletArtifacts -

setExcludePackageNames

public void setExcludePackageNames(List<String> excludePackageNames)
Set list of subpackage patterns to exclude from javadoc generation.

Parameters:
excludePackageNames -

setExcludedDocfilesSubdirs

public void setExcludedDocfilesSubdirs(String excludedDocfilesSubdirs)
Set list of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories.

Parameters:
excludedDocfilesSubdirs -

setGroups

public void setGroups(List<Group> groups)
Set a list of Group parameters.

Parameters:
groups -

setJavadocResourcesDirectory

public void setJavadocResourcesDirectory(String javadocResourcesDirectory)
Set path relative to project basedir where javadoc resources were located. This is mainly useful in multimodule builds where the reactor is still populated.

Parameters:
javadocResourcesDirectory -

setLinks

public void setLinks(List<String> links)
Set list of URLs to javadocs for external classes.

Parameters:
links -

setModelEncoding

public void setModelEncoding(String modelEncoding)
Set the modelEncoding field.

Parameters:
modelEncoding -

setOfflineLinks

public void setOfflineLinks(List<OfflineLink> offlineLinks)
Set a list of OfflineLink parameters.

Parameters:
offlineLinks -

setResourcesArtifacts

public void setResourcesArtifacts(List<ResourcesArtifact> resourcesArtifacts)
Set a list of ResourcesArtifact parameters.

Parameters:
resourcesArtifacts -

setTagletArtifacts

public void setTagletArtifacts(List<TagletArtifact> tagletArtifacts)
Set a list of TagletArtifact parameters.

Parameters:
tagletArtifacts -

setTaglets

public void setTaglets(List<Taglet> taglets)
Set a list of Taglet parameters.

Parameters:
taglets -

setTags

public void setTags(List<Tag> tags)
Set a list of Tag parameters.

Parameters:
tags -


Copyright © 2004–2014 The Apache Software Foundation. All rights reserved.