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

Class CCCheckout


public class CCCheckout
extends ClearCase

Performs ClearCase checkout.

The following attributes are interpreted:

AttributeValuesRequired
viewpathPath to the ClearCase view file or directory that the command will operate onNo
reservedSpecifies whether to check out the file as reserved or notYes
outCreates a writable file under a different filenameNo
nodataChecks out the file but does not create an editable file containing its dataNo
branchSpecify a branch to check out the file toNo
versionAllows checkout of a version other than main latestNo
nowarnSuppress warning messagesNo
commentSpecify a comment. Only one of comment or cfile may be used.No
commentfileSpecify a file containing a comment. Only one of comment or cfile may be used.No
notcoFail if it's already checked out to the current view. Set to false to ignore it.No
failonerrThrow an exception if the command fails. Default is trueNo

Field Summary

static String
FLAG_BRANCH
-branch flag -- checks out the file on a specified branch
static String
FLAG_COMMENT
-c flag -- comment to attach to the file
static String
FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified
static String
FLAG_NODATA
-ndata flag -- checks out the file but does not create an editable file containing its data
static String
FLAG_NOWARN
-nwarn flag -- suppresses warning messages
static String
FLAG_OUT
-out flag -- create a writable file under a different filename
static String
FLAG_RESERVED
-reserved flag -- check out the file as reserved
static String
FLAG_UNRESERVED
-reserved flag -- check out the file as unreserved
static String
FLAG_VERSION
-version flag -- allows checkout of a version that is not main latest

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.
String
getBranch()
Get branch name
String
getComment()
Get comment string
String
getCommentFile()
Get comment file
boolean
getNoData()
Get nodata flag status
boolean
getNoWarn()
Get nowarn flag status
boolean
getNotco()
Get notco flag status
String
getOut()
Get out file
boolean
getReserved()
Get reserved flag status
boolean
getVersion()
Get version flag status
void
setBranch(String branch)
Specify a branch to check out the file to.
void
setComment(String comment)
Sets the comment string.
void
setCommentFile(String cfile)
Specifies a file containing a comment.
void
setNoData(boolean ndata)
If true, checks out the file but does not create an editable file containing its data.
void
setNoWarn(boolean nwarn)
If true, warning messages are suppressed.
void
setNotco(boolean notco)
If true, checkout fails if the element is already checked out to the current view.
void
setOut(String outf)
Creates a writable file under a different filename.
void
setReserved(boolean reserved)
If true, checks out the file as reserved.
void
setVersion(boolean version)
If true, allows checkout of a version other than main latest.

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_BRANCH

public static final String FLAG_BRANCH
-branch flag -- checks out the file on a specified branch

FLAG_COMMENT

public static final String FLAG_COMMENT
-c flag -- comment to attach to the file

FLAG_COMMENTFILE

public static final String FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file

FLAG_NOCOMMENT

public static final String FLAG_NOCOMMENT
-nc flag -- no comment is specified

FLAG_NODATA

public static final String FLAG_NODATA
-ndata flag -- checks out the file but does not create an editable file containing its data

FLAG_NOWARN

public static final String FLAG_NOWARN
-nwarn flag -- suppresses warning messages

FLAG_OUT

public static final String FLAG_OUT
-out flag -- create a writable file under a different filename

FLAG_RESERVED

public static final String FLAG_RESERVED
-reserved flag -- check out the file as reserved

FLAG_UNRESERVED

public static final String FLAG_UNRESERVED
-reserved flag -- check out the file as unreserved

FLAG_VERSION

public static final String FLAG_VERSION
-version flag -- allows checkout of a version that is not main latest

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

getBranch

public String getBranch()
Get branch name
Returns:
String containing the name of the branch

getComment

public String getComment()
Get comment string
Returns:
String containing the comment

getCommentFile

public String getCommentFile()
Get comment file
Returns:
String containing the path to the comment file

getNoData

public boolean getNoData()
Get nodata flag status
Returns:
boolean containing status of ndata flag

getNoWarn

public boolean getNoWarn()
Get nowarn flag status
Returns:
boolean containing status of nwarn flag

getNotco

public boolean getNotco()
Get notco flag status
Returns:
boolean containing status of notco flag
Since:
ant 1.6.1

getOut

public String getOut()
Get out file
Returns:
String containing the path to the out file

getReserved

public boolean getReserved()
Get reserved flag status
Returns:
boolean containing status of reserved flag

getVersion

public boolean getVersion()
Get version flag status
Returns:
boolean containing status of version flag

setBranch

public void setBranch(String branch)
Specify a branch to check out the file to.
Parameters:
branch - the name of the branch

setComment

public void setComment(String comment)
Sets the comment string.
Parameters:
comment - the comment string

setCommentFile

public void setCommentFile(String cfile)
Specifies a file containing a comment.
Parameters:
cfile - the path to the comment file

setNoData

public void setNoData(boolean ndata)
If true, checks out the file but does not create an editable file containing its data.
Parameters:
ndata - the status to set the flag to

setNoWarn

public void setNoWarn(boolean nwarn)
If true, warning messages are suppressed.
Parameters:
nwarn - the status to set the flag to

setNotco

public void setNotco(boolean notco)
If true, checkout fails if the element is already checked out to the current view.
Parameters:
notco - the status to set the flag to
Since:
ant 1.6.1

setOut

public void setOut(String outf)
Creates a writable file under a different filename.
Parameters:
outf - the path to the out file

setReserved

public void setReserved(boolean reserved)
If true, checks out the file as reserved.
Parameters:
reserved - the status to set the flag to

setVersion

public void setVersion(boolean version)
If true, allows checkout of a version other than main latest.
Parameters:
version - the status to set the flag to

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.