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

Class CCUpdate


public class CCUpdate
extends ClearCase

Performs a ClearCase Update command.

The following attributes are interpreted:

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

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

Fields inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.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

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

description, location, target, taskName, taskType, wrapper

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

project

Method Summary

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 org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

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

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

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

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

getProject, log, log, setProject

Field Details

FLAG_CURRENTTIME

public static final String FLAG_CURRENTTIME
-ctime flag -- modified time is written as the current time


FLAG_GRAPHICAL

public static final String FLAG_GRAPHICAL
-graphical flag -- display graphical dialog during update operation


FLAG_LOG

public static final String FLAG_LOG
-log flag -- file to log status to


FLAG_NOVERWRITE

public static final String FLAG_NOVERWRITE
-noverwrite flag -- do not overwrite hijacked files


FLAG_OVERWRITE

public static final String FLAG_OVERWRITE
-overwrite flag -- overwrite hijacked files


FLAG_PRESERVETIME

public static final String FLAG_PRESERVETIME
-ptime flag -- modified time is written as the VOB time


FLAG_RENAME

public static final String FLAG_RENAME
-rename flag -- rename hijacked files with .keep extension

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 interface Task

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


getCurrentTime

public boolean getCurrentTime()
Get current time status

Returns:
boolean containing status of current time flag


getGraphical

public boolean getGraphical()
Get graphical flag status

Returns:
boolean containing status of graphical flag


getLog

public String getLog()
Get log file

Returns:
String containing the path to the log file


getOverwrite

public boolean getOverwrite()
Get overwrite hijacked files status

Returns:
boolean containing status of overwrite flag


getPreserveTime

public boolean getPreserveTime()
Get preserve time status

Returns:
boolean containing status of preserve time flag


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


setGraphical

public void setGraphical(boolean graphical)
If true, displays a graphical dialog during the update.

Parameters:
graphical - the status to set the flag to


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


setOverwrite

public void setOverwrite(boolean ow)
If true, overwrite hijacked files.

Parameters:
ow - the status to set the flag to


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


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


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.