org.apache.tools.ant.taskdefs.optional.ccm

Class Continuus

Implemented Interfaces:
Cloneable
Known Direct Subclasses:
CCMCheck, CCMCreateTask, CCMReconfigure

public abstract class Continuus
extends Task

A base class for creating tasks for executing commands on Continuus 5.1.

The class extends the task as it operates by executing the ccm.exe program supplied with Continuus/Synergy. By default the task expects the ccm executable to be in the path, you can override this be specifying the ccmdir attribute.

Field Summary

static String
COMMAND_CHECKIN
The 'Checkin' command
static String
COMMAND_CHECKOUT
The 'Checkout' command
static String
COMMAND_CREATE_TASK
The 'CreateTask' command
static String
COMMAND_DEFAULT_TASK
The 'Reconfigure' command
static String
COMMAND_RECONFIGURE
The 'Reconfigure' command

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Method Summary

String
getCcmAction()
Get the value of ccmAction.
protected String
getCcmCommand()
Builds and returns the command string to execute ccm
protected int
run(Commandline cmd)
Run the command.
protected int
run(Commandline cmd, ExecuteStreamHandler handler)
Run the command.
void
setCcmAction(String v)
Set the value of ccmAction.
void
setCcmDir(String dir)
Set the directory where the ccm executable is located.

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Field Details

COMMAND_CHECKIN

public static final String COMMAND_CHECKIN
The 'Checkin' command

COMMAND_CHECKOUT

public static final String COMMAND_CHECKOUT
The 'Checkout' command

COMMAND_CREATE_TASK

public static final String COMMAND_CREATE_TASK
The 'CreateTask' command

COMMAND_DEFAULT_TASK

public static final String COMMAND_DEFAULT_TASK
The 'Reconfigure' command

COMMAND_RECONFIGURE

public static final String COMMAND_RECONFIGURE
The 'Reconfigure' command

Method Details

getCcmAction

public String getCcmAction()
Get the value of ccmAction.
Returns:
value of ccmAction.

getCcmCommand

protected final String getCcmCommand()
Builds and returns the command string to execute ccm
Returns:
String containing path to the executable

run

protected int run(Commandline cmd)
Run the command.
Parameters:
cmd - the command line
Returns:
the exit status of the command

run

protected int run(Commandline cmd,
                  ExecuteStreamHandler handler)
Run the command.
Parameters:
cmd - the command line
handler - an execute stream handler
Returns:
the exit status of the command

setCcmAction

public void setCcmAction(String v)
Set the value of ccmAction.
Parameters:
v - Value to assign to ccmAction.

setCcmDir

public final void setCcmDir(String dir)
Set the directory where the ccm executable is located.
Parameters:
dir - the directory containing the ccm executable