org.spf4j.jdiff

Class JavadocExecutor

java.lang.Object

org.spf4j.jdiff.JavadocExecutor

public final class JavadocExecutor
extends Object

Execute javadoc

Constructor Summary

Constructors

Constructor and Description
JavadocExecutor()
JavadocExecutor(String executable) The constructor

Method Summary

Modifier and Type	Method and Description
void	addArgument(String arg) Add an javadoc argument
void	addArgumentPair(String argKey, String argValue) Add a javadoc argument pair
void	execute(File dir) Execute from the workingDir
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocExecutor

public JavadocExecutor()

JavadocExecutor

public JavadocExecutor(String executable)

The constructor

Parameters:

executable - the executable

log - the mojo logger

Method Detail

addArgumentPair

public void addArgumentPair(String argKey,
                            String argValue)

Add a javadoc argument pair

Parameters:

argKey - the key

argValue - the value

addArgument

public void addArgument(String arg)

Add an javadoc argument

Parameters:

arg - the argument

execute

public void execute(File dir)
             throws JavadocExecutionException,
                    IOException

Execute from the workingDir

Parameters:

workingDir - the directory to execute the javadoc command from

Throws:

JavadocExecutionException - if an exception occurs during the execution of javadoc or if that execution doesn't exit with 0

IOException

toString

public String toString()

Overrides:

toString in class Object