Package org.apache.maven.plugins.javadoc.options

Class JavadocOptions

java.lang.Object
org.apache.maven.plugins.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$ $Date$
See Also:

  • Constructor Details

    • JavadocOptions

      public JavadocOptions()

  • Method Details

    • addBootclasspathArtifact

      public void addBootclasspathArtifact(BootclasspathArtifact bootclasspathArtifact)
      Method addBootclasspathArtifact.
      Parameters:
      bootclasspathArtifact - a bootclasspathArtifact object.

    • addDocletArtifact

      public void addDocletArtifact(DocletArtifact docletArtifact)
      Method addDocletArtifact.
      Parameters:
      docletArtifact - a docletArtifact object.

    • addExcludePackageName

      public void addExcludePackageName(String string)
      Method addExcludePackageName.
      Parameters:
      string - a string object.

    • addGroup

      public void addGroup(Group group)
      Method addGroup.
      Parameters:
      group - a group object.

    • addLink

      public void addLink(String string)
      Method addLink.
      Parameters:
      string - a string object.

    • addOfflineLink

      public void addOfflineLink(OfflineLink offlineLink)
      Method addOfflineLink.
      Parameters:
      offlineLink - a offlineLink object.

    • addResourcesArtifact

      public void addResourcesArtifact(ResourcesArtifact resourcesArtifact)
      Method addResourcesArtifact.
      Parameters:
      resourcesArtifact - a resourcesArtifact object.

    • addTag

      public void addTag(Tag tag)
      Method addTag.
      Parameters:
      tag - a tag object.

    • addTaglet

      public void addTaglet(Taglet taglet)
      Method addTaglet.
      Parameters:
      taglet - a taglet object.

    • addTagletArtifact

      public void addTagletArtifact(TagletArtifact tagletArtifact)
      Method addTagletArtifact.
      Parameters:
      tagletArtifact - a tagletArtifact object.

    • 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 - a bootclasspathArtifact object.

    • removeDocletArtifact

      public void removeDocletArtifact(DocletArtifact docletArtifact)
      Method removeDocletArtifact.
      Parameters:
      docletArtifact - a docletArtifact object.

    • removeExcludePackageName

      public void removeExcludePackageName(String string)
      Method removeExcludePackageName.
      Parameters:
      string - a string object.

    • removeGroup

      public void removeGroup(Group group)
      Method removeGroup.
      Parameters:
      group - a group object.

    • removeLink

      public void removeLink(String string)
      Method removeLink.
      Parameters:
      string - a string object.

    • removeOfflineLink

      public void removeOfflineLink(OfflineLink offlineLink)
      Method removeOfflineLink.
      Parameters:
      offlineLink - a offlineLink object.

    • removeResourcesArtifact

      public void removeResourcesArtifact(ResourcesArtifact resourcesArtifact)
      Method removeResourcesArtifact.
      Parameters:
      resourcesArtifact - a resourcesArtifact object.

    • removeTag

      public void removeTag(Tag tag)
      Method removeTag.
      Parameters:
      tag - a tag object.

    • removeTaglet

      public void removeTaglet(Taglet taglet)
      Method removeTaglet.
      Parameters:
      taglet - a taglet object.

    • removeTagletArtifact

      public void removeTagletArtifact(TagletArtifact tagletArtifact)
      Method removeTagletArtifact.
      Parameters:
      tagletArtifact - a tagletArtifact object.

    • setBootclasspathArtifacts

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

    • setDocfilesSubdirsUsed

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

    • setDocletArtifacts

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

    • setExcludePackageNames

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

    • setExcludedDocfilesSubdirs

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

    • setGroups

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

    • 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 - a javadocResourcesDirectory object.

    • setLinks

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

    • setModelEncoding

      public void setModelEncoding(String modelEncoding)
      Set the modelEncoding field.
      Parameters:
      modelEncoding - a modelEncoding object.

    • setOfflineLinks

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

    • setResourcesArtifacts

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

    • setTagletArtifacts

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

    • setTaglets

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

    • setTags

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