protoj.lang
Class JavadocArchive

java.lang.Object
  protoj.lang.JavadocArchive

public final class JavadocArchive
extends java.lang.Object

Responsible for creating one or more archives from the parent javadoc files. Call addArchive(String, String, String, String, String, ArgRunnable) to configure each additional archive with the specified name and createArchive(String) to create one of the added archive. During creation, the config argument specified in the constructor will be called back to give the caller a chance to provide further archive configuration.

Author:

Ashley Williams

Nested Class Summary

static class

JavadocArchive.JavadocEntry Adds javadoc specific information to a wrapped ArchiveEntry instance.

Constructor Summary

JavadocArchive(ArchiveFeature parent)
Creates with the parent feature.

Method Summary

void	addArchive(java.lang.String name, java.lang.String manifest, java.lang.String includes, java.lang.String excludes, java.lang.String memory, ArgRunnable<JavadocArchive> config) Use to enable creation of an additional archive.
void	createArchive(java.lang.String name) Creates the jar for the given name under ProjectLayout.getArchiveDir().
void	createArchives() Delegates to createArchive(String) for each archive that was added through a call to addArchive(String, String, String, String, String, ArgRunnable).
AssembleTask	getCurrentAssembleTask() The ant task responsible for creating the jar during the call to createArchive(String).
ArchiveEntry<JavadocArchive>	getCurrentEntry() The instance used to hold information about the the archive being created during the call to createArchive(String).
JavadocArchive.JavadocEntry	getEntry(java.lang.String name) Accessor for the entry corresponding to the given name.
JavadocTask	getJavadocTask() The ant task responsible for creating the javadocs during the call to createArchive(String).
java.io.File	getWorkingDir() Used to create the javadoc files before archiving.
void	visit(ArgRunnable<JavadocArchive.JavadocEntry> visitor) Convenient method that visits each entry in this archive.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocArchive

public JavadocArchive(ArchiveFeature parent)

Creates with the parent feature.

Parameters:

parent -

Method Detail

addArchive

public void addArchive(java.lang.String name,
                       java.lang.String manifest,
                       java.lang.String includes,
                       java.lang.String excludes,
                       java.lang.String memory,
                       ArgRunnable<JavadocArchive> config)

Use to enable creation of an additional archive.

Parameters:

name - the name of the jar file to be created, without the extension.

manifest - the name of the manifest to be used from the manifest directory, without the extension. Can be null if a default manifest is required.

includes - the resources that should be included in the archive, can be null to include all resources

excludes - the resources that should be excluded in the archive, can be null to exclude no resources

memory - the maximum amount of memory to be used by the javadoc vm, eg "16m"

config - this will be called back during the invocatin of createArchive(String) if the caller wishes to provide further configuration. Can be null if the defaults are ok.

createArchives

public void createArchives()

Delegates to createArchive(String) for each archive that was added through a call to addArchive(String, String, String, String, String, ArgRunnable).

createArchive

public void createArchive(java.lang.String name)

Creates the jar for the given name under ProjectLayout.getArchiveDir(). The jar file will have a name of [name]-javadoc.jar.

Parameters:

name - the name as specified in the call to addArchive(String, String, String, String, String, ArgRunnable) .

visit

public void visit(ArgRunnable<JavadocArchive.JavadocEntry> visitor)

Convenient method that visits each entry in this archive.

Parameters:

visitor -

getEntry

public JavadocArchive.JavadocEntry getEntry(java.lang.String name)

Accessor for the entry corresponding to the given name.

Parameters:

name -

Returns:

getJavadocTask

public JavadocTask getJavadocTask()

The ant task responsible for creating the javadocs during the call to createArchive(String).

Returns:

getWorkingDir

public java.io.File getWorkingDir()

Used to create the javadoc files before archiving.

Returns:

getCurrentAssembleTask

public AssembleTask getCurrentAssembleTask()

The ant task responsible for creating the jar during the call to createArchive(String).

Returns:

getCurrentEntry

public ArchiveEntry<JavadocArchive> getCurrentEntry()

The instance used to hold information about the the archive being created during the call to createArchive(String).

Returns: