terp - the Codemesh Modular
Template Interpreter v1.3.337

com.codemesh.terp.eval.executors
Class JavadocExecutor

java.lang.Object
  extended by com.codemesh.terp.api.Executor.AbstractExecutor<ProcessExecutor.Result>
      extended by com.codemesh.terp.eval.executors.ProcessExecutor
          extended by com.codemesh.terp.eval.executors.ShellExecutor
              extended by com.codemesh.terp.eval.executors.BatchExecutor
                  extended by com.codemesh.terp.eval.executors.JavaToolExecutor<JavadocExecutor>
                      extended by com.codemesh.terp.eval.executors.JavadocExecutor
All Implemented Interfaces:
Executor<ProcessExecutor.Result>, Named, Versioned, java.io.Serializable

public class JavadocExecutor
extends JavaToolExecutor<JavadocExecutor>

An executor for the javadoc compiler.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.codemesh.terp.eval.executors.ProcessExecutor
ProcessExecutor.Result
 
Nested classes/interfaces inherited from interface com.codemesh.terp.api.Executor
Executor.AbstractExecutor<T>, Executor.ForMethod
 
Field Summary
 
Fields inherited from class com.codemesh.terp.eval.executors.JavaToolExecutor
bIsWindows, COMPILER, EXECUTABLE, JAR_EXE_NAME, JAVA_EXE_NAME, JAVAC_EXE_NAME, JAVADOC_EXE_NAME, JDK, JRE, logger, MAKER, theJdk, theOS, TO_FILE, TO_JDK, TO_JRE, TO_VERSION, VERSION
 
Fields inherited from class com.codemesh.terp.eval.executors.ShellExecutor
theAddedEnvSettings, theExecFlag, theRemovedEnvSettings, theShell, TO_STRING
 
Fields inherited from class com.codemesh.terp.eval.executors.ProcessExecutor
EOL, IS_WINDOWS, theEnvironment, theExecutable, theTerpCmdVar, theWorkingDir, TO_LIST
 
Constructor Summary
JavadocExecutor()
           
 
Method Summary
protected  java.lang.String getExeName()
          Returns the tool's executable name.
 java.lang.String getName()
          Always returns "javadoc".
protected  JavadocExecutor getTool()
          Returns the JDK's getJavadoc() value.
 
Methods inherited from class com.codemesh.terp.eval.executors.JavaToolExecutor
batchExecute, execute, fromMap, getJdk, getMaker, getVersion, setJdk
 
Methods inherited from class com.codemesh.terp.eval.executors.BatchExecutor
batchFromFile, batchFromMap, batchFromMap, batchFromString, writeCommandsFile
 
Methods inherited from class com.codemesh.terp.eval.executors.ShellExecutor
addToEnvironment, createEnvironment, getExecFlag, getShell, marshallArguments, removeFromEnvironment, setExecFlag, setShell, shellFromFile, shellFromMap, shellFromMap, shellFromString
 
Methods inherited from class com.codemesh.terp.eval.executors.ProcessExecutor
appendToEnvironment, execute, fromFile, fromMap, fromMap, fromString, getEnvironment, getExecutable, getWorkingDir, matches, setEnvironment, setExecutable, setWorkingDir
 
Methods inherited from class com.codemesh.terp.api.Executor.AbstractExecutor
execute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocExecutor

public JavadocExecutor()
Method Detail

getExeName

protected java.lang.String getExeName()
Returns the tool's executable name. This method is implemented by concrete subclasses. This method is implemented to return the platform-appropriate javadoc (javadoc.exe) string.

Specified by:
getExeName in class JavaToolExecutor<JavadocExecutor>
Returns:
the platform-appropriate executable name.

getName

public java.lang.String getName()
Always returns "javadoc".

Specified by:
getName in interface Named
Specified by:
getName in class JavaToolExecutor<JavadocExecutor>
Returns:
the string "javadoc".

getTool

protected JavadocExecutor getTool()
Returns the JDK's getJavadoc() value.

Specified by:
getTool in class JavaToolExecutor<JavadocExecutor>
Returns:
the JDK's configured javadoc compiler.

terp - the Codemesh Modular
Template Interpreter v1.3.337

Copyright © 2008-2016 by Codemesh, Inc. All Rights Reserved.