terp - the Codemesh Modular
Template Interpreter v1.3.337

com.codemesh.terp.data
Class Ant.AntExecutor

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.data.Ant.AntExecutor
All Implemented Interfaces:
Executor<ProcessExecutor.Result>, Named, Versioned, java.lang.Comparable<Ant.AntExecutor>
Enclosing interface:
Ant

public static class Ant.AntExecutor
extends ShellExecutor
implements java.lang.Comparable<Ant.AntExecutor>, Versioned, Named

An executor for ANT build scripts.

See Also:
the converter creating instances of this type, registered under the ^ant alias.

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
protected static java.util.List<Ant.AntExecutor> ALL_ANTS
           
protected  java.util.Map<java.lang.String,java.lang.Object> theDefaultArguments
           
protected  Version theVersion
           
protected static Converter<Version> TO_VERSION
           
protected static java.util.regex.Pattern VERSION_FORMAT
           
 
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, logger, theEnvironment, theExecutable, theTerpCmdVar, theWorkingDir, TO_FILE, TO_LIST
 
Constructor Summary
Ant.AntExecutor()
           
 
Method Summary
static Ant.AntExecutor antFromFile(java.io.File executableOrHome)
           
static Ant.AntExecutor antFromMap(Ant.AntExecutor result, java.util.Map<java.lang.String,java.lang.Object> map)
           
static Ant.AntExecutor antFromMap(java.util.Map<java.lang.String,java.lang.Object> map)
           
static Ant.AntExecutor antFromString(java.lang.String executableOrHome)
           
 int compareTo(Ant.AntExecutor o)
           Compares by executable path.
 boolean equals(java.lang.Object o)
           
 java.io.File getHome()
          Return the ANT installation's home directory.
 java.io.File getLauncher()
          Returns the ANT launcher.
 java.lang.String getName()
          Always returns the string "ANT".
 Version getVersion()
          Returns the ANT version.
 int hashCode()
           
 java.lang.String[] marshallArguments(java.util.List<java.lang.Object> args)
           
static void populate()
           
 void setLauncher(java.io.File launcher)
          Sets the ANT launcher, usually a shell script in the ANT distribution's bin directory.
 void setVersion(Version version)
          Sets the ANT version.
 java.lang.String toString()
           
 
Methods inherited from class com.codemesh.terp.eval.executors.ShellExecutor
addToEnvironment, createEnvironment, getExecFlag, getShell, removeFromEnvironment, setExecFlag, setShell, shellFromFile, shellFromMap, shellFromMap, shellFromString
 
Methods inherited from class com.codemesh.terp.eval.executors.ProcessExecutor
appendToEnvironment, execute, 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, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

theVersion

protected Version theVersion

theDefaultArguments

protected java.util.Map<java.lang.String,java.lang.Object> theDefaultArguments

VERSION_FORMAT

protected static final java.util.regex.Pattern VERSION_FORMAT

TO_VERSION

protected static final Converter<Version> TO_VERSION

ALL_ANTS

protected static final java.util.List<Ant.AntExecutor> ALL_ANTS
Constructor Detail

Ant.AntExecutor

public Ant.AntExecutor()
Method Detail

compareTo

public int compareTo(Ant.AntExecutor o)
Compares by executable path.

Specified by:
compareTo in interface java.lang.Comparable<Ant.AntExecutor>

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

populate

public static void populate()

getName

public java.lang.String getName()
Always returns the string "ANT".

Specified by:
getName in interface Named
Returns:
always returns "ANT".

setLauncher

public void setLauncher(java.io.File launcher)
Sets the ANT launcher, usually a shell script in the ANT distribution's bin directory.

Parameters:
launcher - the file used to kick of an ANT build.

getLauncher

public java.io.File getLauncher()
Returns the ANT launcher.

Returns:
the ANT launcher.

getHome

public java.io.File getHome()
Return the ANT installation's home directory.

Returns:

setVersion

public void setVersion(Version version)
Sets the ANT version. You don't usually call this method. It is designed for use by the framework.

Parameters:
version - the ANT version.

getVersion

public Version getVersion()
Returns the ANT version.

Specified by:
getVersion in interface Versioned
Returns:
the ANT version.

antFromString

public static Ant.AntExecutor antFromString(java.lang.String executableOrHome)

antFromFile

public static Ant.AntExecutor antFromFile(java.io.File executableOrHome)

marshallArguments

public java.lang.String[] marshallArguments(java.util.List<java.lang.Object> args)
Overrides:
marshallArguments in class ShellExecutor

antFromMap

public static Ant.AntExecutor antFromMap(java.util.Map<java.lang.String,java.lang.Object> map)

antFromMap

public static Ant.AntExecutor antFromMap(Ant.AntExecutor result,
                                         java.util.Map<java.lang.String,java.lang.Object> map)

terp - the Codemesh Modular
Template Interpreter v1.3.337

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