Package org.eclipse.tycho.extras.docbundle

Class JavadocRunner

java.lang.Object

org.eclipse.tycho.extras.docbundle.JavadocRunner

public class JavadocRunner
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
private java.io.File	buildDirectory
private BundleReader	bundleReader
private java.util.Collection<java.lang.String>	classPath
private DocletArtifactsResolver	docletArtifactsResolver
private PackageNameMatcher	excludeMatcher
private PackageNameMatcher	includeMatcher
private java.lang.String	lineSeparator
private org.apache.maven.plugin.logging.Log	log
private java.util.Set<java.io.File>	manifestFiles
private JavadocOptions	options
private java.io.File	output
private org.apache.maven.execution.MavenSession	session
private java.util.Set<java.io.File>	sourceFolders
private org.apache.maven.toolchain.ToolchainManager	toolchainManager

Constructor Summary

Constructors

Constructor	Description
JavadocRunner()

Method Summary

Modifier and Type	Method	Description
private void	addArguments(java.lang.StringBuilder sb)
private void	addClassPath(java.lang.StringBuilder sb)
private void	addDoclet(java.lang.StringBuilder sb)
private void	addDocletPaths(java.lang.StringBuilder sb)
private void	addEncoding(java.lang.StringBuilder sb)
private void	addJvmArgs(org.codehaus.plexus.util.cli.Commandline cli)
private int	addPackages(java.lang.StringBuilder sb)
private int	addPackages(java.lang.StringBuilder sb, org.eclipse.osgi.util.ManifestElement[] manifestElements)
private void	addPath(java.lang.StringBuilder sb, java.util.Collection<?> path)
private void	addPathArgument(java.lang.StringBuilder sb, java.lang.String arg, java.util.Collection<?> path)
private void	addSourcePaths(java.lang.StringBuilder sb)
(package private) org.codehaus.plexus.util.cli.Commandline	createCommandLine(java.lang.String optionsFileAbsolutePath)
(package private) java.lang.String	createOptionsFileContent()
protected java.lang.String	getExecutable()
void	run()
void	setBuildDirectory(java.io.File buildDirectory)
void	setBundleReader(BundleReader bundleReader)
void	setClassPath(java.util.Collection<java.lang.String> classPath)
void	setDocletArtifactsResolver(DocletArtifactsResolver docletArtifactsResolver)
void	setLog(org.apache.maven.plugin.logging.Log log)
void	setManifestFiles(java.util.Set<java.io.File> manifestFiles)
void	setOptions(JavadocOptions options)
void	setOutput(java.io.File output)
void	setSession(org.apache.maven.execution.MavenSession session)
void	setSourceFolders(java.util.Set<java.io.File> sourceFolders)
void	setToolchainManager(org.apache.maven.toolchain.ToolchainManager toolchainManager)

Methods inherited from class java.lang.Object

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

Field Detail

output

private java.io.File output

toolchainManager

private org.apache.maven.toolchain.ToolchainManager toolchainManager

session

private org.apache.maven.execution.MavenSession session

sourceFolders

private java.util.Set<java.io.File> sourceFolders

manifestFiles

private java.util.Set<java.io.File> manifestFiles

log

private org.apache.maven.plugin.logging.Log log

options

private JavadocOptions options

buildDirectory

private java.io.File buildDirectory

bundleReader

private BundleReader bundleReader

classPath

private java.util.Collection<java.lang.String> classPath

lineSeparator

private java.lang.String lineSeparator

docletArtifactsResolver

private DocletArtifactsResolver docletArtifactsResolver

includeMatcher

private PackageNameMatcher includeMatcher

excludeMatcher

private PackageNameMatcher excludeMatcher

Constructor Detail

JavadocRunner

public JavadocRunner()

Method Detail

setBundleReader

public void setBundleReader(BundleReader bundleReader)

setBuildDirectory

public void setBuildDirectory(java.io.File buildDirectory)

setOptions

public void setOptions(JavadocOptions options)

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

setSession

public void setSession(org.apache.maven.execution.MavenSession session)

setOutput

public void setOutput(java.io.File output)

run

public void run()
         throws java.lang.Exception

Throws:

java.lang.Exception

createCommandLine

org.codehaus.plexus.util.cli.Commandline createCommandLine(java.lang.String optionsFileAbsolutePath)

createOptionsFileContent

java.lang.String createOptionsFileContent()
                                   throws java.lang.Exception

Throws:

java.lang.Exception

addEncoding

private void addEncoding(java.lang.StringBuilder sb)

addDoclet

private void addDoclet(java.lang.StringBuilder sb)

addDocletPaths

private void addDocletPaths(java.lang.StringBuilder sb)
                     throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

addClassPath

private void addClassPath(java.lang.StringBuilder sb)

addArguments

private void addArguments(java.lang.StringBuilder sb)

addJvmArgs

private void addJvmArgs(org.codehaus.plexus.util.cli.Commandline cli)

addPackages

private int addPackages(java.lang.StringBuilder sb)
                 throws java.lang.Exception

Throws:

java.lang.Exception

addPackages

private int addPackages(java.lang.StringBuilder sb,
                        org.eclipse.osgi.util.ManifestElement[] manifestElements)

addPath

private void addPath(java.lang.StringBuilder sb,
                     java.util.Collection<?> path)

addSourcePaths

private void addSourcePaths(java.lang.StringBuilder sb)

addPathArgument

private void addPathArgument(java.lang.StringBuilder sb,
                             java.lang.String arg,
                             java.util.Collection<?> path)

getExecutable

protected java.lang.String getExecutable()

setToolchainManager

public void setToolchainManager(org.apache.maven.toolchain.ToolchainManager toolchainManager)

setSourceFolders

public void setSourceFolders(java.util.Set<java.io.File> sourceFolders)

setClassPath

public void setClassPath(java.util.Collection<java.lang.String> classPath)

setManifestFiles

public void setManifestFiles(java.util.Set<java.io.File> manifestFiles)

setDocletArtifactsResolver

public void setDocletArtifactsResolver(DocletArtifactsResolver docletArtifactsResolver)