Class JavadocJarGenerator

java.lang.Object

org.jdrupes.builder.core.AbstractProvider

org.jdrupes.builder.core.AbstractGenerator

org.jdrupes.builder.java.JarBuilder

org.jdrupes.builder.mvnrepo.JavadocJarGenerator

All Implemented Interfaces:

Generator, Renamable, ResourceProvider

public class JavadocJarGenerator
extends JarBuilder

A special JarBuilder that generates a jar with javadoc.

• The content of the jar is obtained by requesting resources of type JavadocDirectory from the project's suppliers and using each as root for a FileTree, which is then added to the jar.

• The name of the jar is set to <artifactId>-<version>-javadoc.jar, where <artifactId> is the value of the project's property MvnProperties.ArtifactId with a fallback to the project's name. <version> is the value of the project's property Project.Properties.Version.

Constructor Summary

Constructors

Constructor	Description
JavadocJarGenerator(Project project)	Initializes a new sources jar generator.

Method Summary

Methods inherited from class JarBuilder

add, add, add, add, addAttributeValues, addEntries, addManifestAttributes, addTrees, attributes, buildJar, collect, collectContents, destination, destination, destination, doProvide, jarName, jarName, jarName, name, resolveDuplicates

Methods inherited from class AbstractGenerator

cleanup, newResource, project, toString

Methods inherited from class AbstractProvider

context, name, of, rename, vavrStream

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ResourceProvider

context, name, of, of, resources

Constructor Details

JavadocJarGenerator

public JavadocJarGenerator(Project project)

Initializes a new sources jar generator.

Parameters:

project - the project