Examples with JavadocOptions org.apache.maven.plugin.javadoc.options.JavadocOptions used on opensource projects

Example 6 with JavadocOptions

use of org.apache.maven.plugin.javadoc.options.JavadocOptions in project maven-plugins by apache.

the class AbstractJavadocMojo method getExcludedPackages.

/**
     * Method to get the packages specified in the <code>excludePackageNames</code> parameter. The packages are split
     * with ',', ':', or ';' and then formatted.
     *
     * @return an array of String objects that contain the package names
     * @throws MavenReportException
     */
private String[] getExcludedPackages() throws MavenReportException {
    Set<String> excluded = new LinkedHashSet<String>();
    if (includeDependencySources) {
        try {
            resolveDependencyBundles();
        } catch (IOException e) {
            throw new MavenReportException("Failed to resolve javadoc bundles from dependencies: " + e.getMessage(), e);
        }
        if (isNotEmpty(dependencyJavadocBundles)) {
            for (JavadocBundle bundle : dependencyJavadocBundles) {
                JavadocOptions options = bundle.getOptions();
                if (options != null && isNotEmpty(options.getExcludePackageNames())) {
                    excluded.addAll(options.getExcludePackageNames());
                }
            }
        }
    }
    // for the specified excludePackageNames
    if (StringUtils.isNotEmpty(excludePackageNames)) {
        List<String> packageNames = Arrays.asList(excludePackageNames.split("[,:;]"));
        excluded.addAll(trimValues(packageNames));
    }
    String[] result = new String[excluded.size()];
    if (isNotEmpty(excluded)) {
        int idx = 0;
        for (String exclude : excluded) {
            result[idx] = exclude.replace('.', File.separatorChar);
            idx++;
        }
    }
    return result;
}

Example 7 with JavadocOptions

use of org.apache.maven.plugin.javadoc.options.JavadocOptions in project maven-plugins by apache.

the class AbstractJavadocMojo method buildJavadocOptions.

/**
     * Generate a javadoc-options XML file, for either bundling with a javadoc-resources artifact OR
     * supplying to a distro module in a includeDependencySources configuration, so the javadoc options
     * from this execution can be reconstructed and merged in the distro build.
     *
     * @return {@link JavadocOptions}
     * @throws IOException {@link IOException}
     * @since 2.7
     */
protected final JavadocOptions buildJavadocOptions() throws IOException {
    JavadocOptions options = new JavadocOptions();
    options.setBootclasspathArtifacts(toList(bootclasspathArtifacts));
    options.setDocfilesSubdirsUsed(docfilessubdirs);
    options.setDocletArtifacts(toList(docletArtifact, docletArtifacts));
    options.setExcludedDocfilesSubdirs(excludedocfilessubdir);
    options.setExcludePackageNames(toList(excludePackageNames));
    options.setGroups(toList(groups));
    options.setLinks(links);
    options.setOfflineLinks(toList(offlineLinks));
    options.setResourcesArtifacts(toList(resourcesArtifacts));
    options.setTagletArtifacts(toList(tagletArtifact, tagletArtifacts));
    options.setTaglets(toList(taglets));
    options.setTags(toList(tags));
    if (getProject() != null && getJavadocDirectory() != null) {
        options.setJavadocResourcesDirectory(toRelative(getProject().getBasedir(), getJavadocDirectory().getAbsolutePath()));
    }
    File optionsFile = getJavadocOptionsFile();
    Writer writer = null;
    try {
        writer = WriterFactory.newXmlWriter(optionsFile);
        new JavadocOptionsXpp3Writer().write(writer, options);
    } finally {
        close(writer);
    }
    return options;
}

Example 8 with JavadocOptions

use of org.apache.maven.plugin.javadoc.options.JavadocOptions in project maven-plugins by apache.

the class AbstractJavadocMojo method copyJavadocResources.

/**
     * Method that copy all <code>doc-files</code> directories from <code>javadocDirectory</code> of
     * the current project or of the projects in the reactor to the <code>outputDirectory</code>.
     *
     * @param anOutputDirectory the output directory
     * @throws java.io.IOException if any
     * @see <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/whatsnew-1.2.html#docfiles">Reference
     *      Guide, Copies new "doc-files" directory for holding images and examples</a>
     * @see #docfilessubdirs
     */
private void copyJavadocResources(File anOutputDirectory) throws IOException {
    if (anOutputDirectory == null || !anOutputDirectory.exists()) {
        throw new IOException("The outputDirectory " + anOutputDirectory + " doesn't exists.");
    }
    if (includeDependencySources) {
        resolveDependencyBundles();
        if (isNotEmpty(dependencyJavadocBundles)) {
            for (JavadocBundle bundle : dependencyJavadocBundles) {
                File dir = bundle.getResourcesDirectory();
                JavadocOptions options = bundle.getOptions();
                if (dir != null && dir.isDirectory()) {
                    JavadocUtil.copyJavadocResources(anOutputDirectory, dir, options == null ? null : options.getExcludedDocfilesSubdirs());
                }
            }
        }
    }
    if (getJavadocDirectory() != null) {
        JavadocUtil.copyJavadocResources(anOutputDirectory, getJavadocDirectory(), excludedocfilessubdir);
    }
    if (isAggregator() && project.isExecutionRoot()) {
        for (MavenProject subProject : reactorProjects) {
            if (subProject != project && getJavadocDirectory() != null) {
                String javadocDirRelative = PathUtils.toRelative(project.getBasedir(), getJavadocDirectory().getAbsolutePath());
                File javadocDir = new File(subProject.getBasedir(), javadocDirRelative);
                JavadocUtil.copyJavadocResources(anOutputDirectory, javadocDir, excludedocfilessubdir);
            }
        }
    }
}