Class CCMReconfigure

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

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

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

All Implemented Interfaces:

Cloneable

public class CCMReconfigure
extends Continuus

Task allows to reconfigure a project, recursively or not

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLAG_PROJECT	/project flag -- target project
static final String	FLAG_RECURSE	/recurse --
static final String	FLAG_VERBOSE	/recurse --

Fields inherited from class Continuus

COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_CREATE_TASK, COMMAND_DEFAULT_TASK, COMMAND_RECONFIGURE

Modifier and Type	Field	Description
static final String	COMMAND_CHECKIN	The 'Checkin' command
static final String	COMMAND_CHECKOUT	The 'Checkout' command
static final String	COMMAND_CREATE_TASK	The 'CreateTask' command
static final String	COMMAND_DEFAULT_TASK	The 'Reconfigure' command
static final String	COMMAND_RECONFIGURE	The 'Reconfigure' command

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
CCMReconfigure()	Constructor for CCMReconfigure.

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the task.
String	getCcmProject()	Get the value of project.
boolean	isRecurse()	Get the value of recurse.
boolean	isVerbose()	Get the value of verbose.
void	setCcmProject(String v)	Sets the ccm project on which the operation is applied.
void	setRecurse(boolean v)	If true, recurse on subproject (default false).
void	setVerbose(boolean v)	If true, do a verbose reconfigure operation (default false).

Methods inherited from class Continuus

getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir

Modifier and Type	Method	Description
String	getCcmAction()	Get the value of ccmAction.
protected final 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.
final void	setCcmDir(String dir)	Set the directory where the ccm executable is located.

Methods inherited from class Task

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

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

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

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

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

Field Details

FLAG_RECURSE

public static final String FLAG_RECURSE

/recurse --

See Also:

• Constant Field Values

FLAG_VERBOSE

public static final String FLAG_VERBOSE

/recurse --

See Also:

• Constant Field Values

FLAG_PROJECT

public static final String FLAG_PROJECT

/project flag -- target project

See Also:

• Constant Field Values

Constructor Details

CCMReconfigure

public CCMReconfigure()

Constructor for CCMReconfigure.

Method Details

execute

public void execute()
             throws BuildException

Executes the task.

Builds a command line to execute ccm and then calls Exec's run method to execute the command line.

Overrides:

execute in class Task

Throws:

BuildException - on error

getCcmProject

public String getCcmProject()

Get the value of project.

Returns:

value of project.

setCcmProject

public void setCcmProject(String v)

Sets the ccm project on which the operation is applied.

Parameters:

v - Value to assign to project.

isRecurse

public boolean isRecurse()

Get the value of recurse.

Returns:

value of recurse.

setRecurse

public void setRecurse(boolean v)

If true, recurse on subproject (default false).

Parameters:

v - Value to assign to recurse.

isVerbose

public boolean isVerbose()

Get the value of verbose.

Returns:

value of verbose.

setVerbose

public void setVerbose(boolean v)

If true, do a verbose reconfigure operation (default false).

Parameters:

v - Value to assign to verbose.