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

Class JavadocOptions

  • All Implemented Interfaces:
    java.io.Serializable
    public class JavadocOptions
extends java.lang.Object
implements java.io.Serializable
    Root class to contain all javadoc configuration options for inclusion in javadoc bundle archives.
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Field Detail

      • groups

        private java.util.List<Group> groups
        Field groups.

      • tags

        private java.util.List<Tag> tags
        Field tags.

      • docletArtifacts

        private java.util.List<DocletArtifact> docletArtifacts
        Field docletArtifacts.

      • taglets

        private java.util.List<Taglet> taglets
        Field taglets.

      • offlineLinks

        private java.util.List<OfflineLink> offlineLinks
        Field offlineLinks.

      • tagletArtifacts

        private java.util.List<TagletArtifact> tagletArtifacts
        Field tagletArtifacts.

      • resourcesArtifacts

        private java.util.List<ResourcesArtifact> resourcesArtifacts
        Field resourcesArtifacts.

      • bootclasspathArtifacts

        private java.util.List<BootclasspathArtifact> bootclasspathArtifacts
        Field bootclasspathArtifacts.

      • links

        private java.util.List<java.lang.String> links
        Field links.

      • excludePackageNames

        private java.util.List<java.lang.String> excludePackageNames
        Field excludePackageNames.

      • docfilesSubdirsUsed

        private boolean docfilesSubdirsUsed
        Enables deep copying of the '**/doc-files' directories and the specific 'resources' directory.

      • excludedDocfilesSubdirs

        private java.lang.String excludedDocfilesSubdirs
        List of exclusion patterns separated by ':' for deep copying of the '**/doc-files' directories.

      • javadocResourcesDirectory

        private java.lang.String javadocResourcesDirectory
        Path relative to project basedir where javadoc resources were located. This is mainly useful in multimodule builds where the reactor is still populated.

      • modelEncoding

        private java.lang.String modelEncoding
        Field modelEncoding.

    • 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​(java.lang.String string)
        Method addExcludePackageName.
        Parameters:
        string -

      • addGroup

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

      • addLink

        public void addLink​(java.lang.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 java.util.List<BootclasspathArtifact> getBootclasspathArtifacts()
        Method getBootclasspathArtifacts.
        Returns:
        List

      • getDocletArtifacts

        public java.util.List<DocletArtifact> getDocletArtifacts()
        Method getDocletArtifacts.
        Returns:
        List

      • getExcludePackageNames

        public java.util.List<java.lang.String> getExcludePackageNames()
        Method getExcludePackageNames.
        Returns:
        List

      • getExcludedDocfilesSubdirs

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

      • getGroups

        public java.util.List<Group> getGroups()
        Method getGroups.
        Returns:
        List

      • getJavadocResourcesDirectory

        public java.lang.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 java.util.List<java.lang.String> getLinks()
        Method getLinks.
        Returns:
        List

      • getModelEncoding

        public java.lang.String getModelEncoding()
        Get the modelEncoding field.
        Returns:
        String

      • getOfflineLinks

        public java.util.List<OfflineLink> getOfflineLinks()
        Method getOfflineLinks.
        Returns:
        List

      • getResourcesArtifacts

        public java.util.List<ResourcesArtifact> getResourcesArtifacts()
        Method getResourcesArtifacts.
        Returns:
        List

      • getTagletArtifacts

        public java.util.List<TagletArtifact> getTagletArtifacts()
        Method getTagletArtifacts.
        Returns:
        List

      • getTaglets

        public java.util.List<Taglet> getTaglets()
        Method getTaglets.
        Returns:
        List

      • getTags

        public java.util.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​(java.lang.String string)
        Method removeExcludePackageName.
        Parameters:
        string -

      • removeGroup

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

      • removeLink

        public void removeLink​(java.lang.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​(java.util.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​(java.util.List<DocletArtifact> docletArtifacts)
        Set a list of DocletArtifact parameters.
        Parameters:
        docletArtifacts -

      • setExcludePackageNames

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

      • setExcludedDocfilesSubdirs

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

      • setGroups

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

      • setJavadocResourcesDirectory

        public void setJavadocResourcesDirectory​(java.lang.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​(java.util.List<java.lang.String> links)
        Set list of URLs to javadocs for external classes.
        Parameters:
        links -

      • setModelEncoding

        public void setModelEncoding​(java.lang.String modelEncoding)
        Set the modelEncoding field.
        Parameters:
        modelEncoding -

      • setOfflineLinks

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

      • setResourcesArtifacts

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

      • setTagletArtifacts

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

      • setTaglets

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

      • setTags

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