Class CCUpdate

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

org.apache.tools.ant.taskdefs.optional.clearcase.CCUpdate

All Implemented Interfaces:

Cloneable

public class CCUpdate
extends ClearCase

Performs a ClearCase Update command.

The following attributes are interpreted:

Task attributes

Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	No
graphical	Displays a graphical dialog during the update	No
log	Specifies a log file for ClearCase to write to	No
overwrite	Specifies whether to overwrite hijacked files or not	No
rename	Specifies that hijacked files should be renamed with a .keep extension	No
currenttime	Specifies that modification time should be written as the current time. Either currenttime or preservetime can be specified.	No
preservetime	Specifies that modification time should preserved from the VOB time. Either currenttime or preservetime can be specified.	No
failonerr	Throw an exception if the command fails. Default is true	No

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FLAG_CURRENTTIME	-ctime flag -- modified time is written as the current time
static final String	FLAG_GRAPHICAL	-graphical flag -- display graphical dialog during update operation
static final String	FLAG_LOG	-log flag -- file to log status to
static final String	FLAG_NOVERWRITE	-noverwrite flag -- do not overwrite hijacked files
static final String	FLAG_OVERWRITE	-overwrite flag -- overwrite hijacked files
static final String	FLAG_PRESERVETIME	-ptime flag -- modified time is written as the VOB time
static final String	FLAG_RENAME	-rename flag -- rename hijacked files with .keep extension

Fields inherited from class ClearCase

COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE

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_LOCK	The 'Lock' command
static final String	COMMAND_LSCO	The 'LsCheckout' command
static final String	COMMAND_MKATTR	The 'Mkattr' command
static final String	COMMAND_MKBL	The 'Mkbl' command
static final String	COMMAND_MKDIR	The 'Mkdir' command
static final String	COMMAND_MKELEM	The 'Mkelem' command
static final String	COMMAND_MKLABEL	The 'Mklabel' command
static final String	COMMAND_MKLBTYPE	The 'Mklbtype' command
static final String	COMMAND_RMTYPE	The 'Rmtype' command
static final String	COMMAND_UNCHECKOUT	The 'UndoCheckout' command
static final String	COMMAND_UNLOCK	The 'Unlock' command
static final String	COMMAND_UPDATE	The 'Update' 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
CCUpdate()

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the task.
boolean	getCurrentTime()	Get current time status
boolean	getGraphical()	Get graphical flag status
String	getLog()	Get log file
boolean	getOverwrite()	Get overwrite hijacked files status
boolean	getPreserveTime()	Get preserve time status
boolean	getRename()	Get rename hijacked files status
void	setCurrentTime(boolean ct)	If true, modification time should be written as the current time.
void	setGraphical(boolean graphical)	If true, displays a graphical dialog during the update.
void	setLog(String log)	Sets the log file where cleartool records the status of the command.
void	setOverwrite(boolean ow)	If true, overwrite hijacked files.
void	setPreserveTime(boolean pt)	If true, modification time should be preserved from the VOB time.
void	setRename(boolean ren)	If true, hijacked files are renamed with a .keep extension.

Methods inherited from class ClearCase

getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

Modifier and Type	Method	Description
protected final String	getClearToolCommand()	Builds and returns the command string to execute cleartool
boolean	getFailOnErr()	Get failonerr flag status
String	getObjSelect()	Get the object to operate on
String	getViewPath()	Get the path to the item in a clearcase view
String	getViewPathBasename()	Get the basename path of the item in a clearcase view
protected int	run(Commandline cmd)	Execute the given command are return success or failure
protected String	runS(Commandline cmdline)	Deprecated. use the two arg version instead
protected String	runS(Commandline cmdline, boolean failOnError)	Execute the given command, and return it's output
final void	setClearToolDir(String dir)	Set the directory where the cleartool executable is located.
void	setFailOnErr(boolean failonerr)	If true, command will throw an exception on failure.
final void	setObjSelect(String objSelect)	Set the object to operate on.
final void	setViewPath(String viewPath)	Set the path to the item in a ClearCase view to operate on.

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_GRAPHICAL

public static final String FLAG_GRAPHICAL

-graphical flag -- display graphical dialog during update operation

See Also:

• Constant Field Values

FLAG_LOG

public static final String FLAG_LOG

-log flag -- file to log status to

See Also:

• Constant Field Values

FLAG_OVERWRITE

public static final String FLAG_OVERWRITE

-overwrite flag -- overwrite hijacked files

See Also:

• Constant Field Values

FLAG_NOVERWRITE

public static final String FLAG_NOVERWRITE

-noverwrite flag -- do not overwrite hijacked files

See Also:

• Constant Field Values

FLAG_RENAME

public static final String FLAG_RENAME

-rename flag -- rename hijacked files with .keep extension

See Also:

• Constant Field Values

FLAG_CURRENTTIME

public static final String FLAG_CURRENTTIME

-ctime flag -- modified time is written as the current time

See Also:

• Constant Field Values

FLAG_PRESERVETIME

public static final String FLAG_PRESERVETIME

-ptime flag -- modified time is written as the VOB time

See Also:

• Constant Field Values

Constructor Details

CCUpdate

public CCUpdate()

Method Details

execute

public void execute()
             throws BuildException

Executes the task.

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

Overrides:

execute in class Task

Throws:

BuildException - if the command fails and failonerr is set to true

setGraphical

public void setGraphical(boolean graphical)

If true, displays a graphical dialog during the update.

Parameters:

graphical - the status to set the flag to

getGraphical

public boolean getGraphical()

Get graphical flag status

Returns:

boolean containing status of graphical flag

setOverwrite

public void setOverwrite(boolean ow)

If true, overwrite hijacked files.

Parameters:

ow - the status to set the flag to

getOverwrite

public boolean getOverwrite()

Get overwrite hijacked files status

Returns:

boolean containing status of overwrite flag

setRename

public void setRename(boolean ren)

If true, hijacked files are renamed with a .keep extension.

Parameters:

ren - the status to set the flag to

getRename

public boolean getRename()

Get rename hijacked files status

Returns:

boolean containing status of rename flag

setCurrentTime

public void setCurrentTime(boolean ct)

If true, modification time should be written as the current time. Either currenttime or preservetime can be specified.

Parameters:

ct - the status to set the flag to

getCurrentTime

public boolean getCurrentTime()

Get current time status

Returns:

boolean containing status of current time flag

setPreserveTime

public void setPreserveTime(boolean pt)

If true, modification time should be preserved from the VOB time. Either currenttime or preservetime can be specified.

Parameters:

pt - the status to set the flag to

getPreserveTime

public boolean getPreserveTime()

Get preserve time status

Returns:

boolean containing status of preserve time flag

setLog

public void setLog(String log)

Sets the log file where cleartool records the status of the command.

Parameters:

log - the path to the log file

getLog

public String getLog()

Get log file

Returns:

String containing the path to the log file