public class CCCheckout extends ClearCase
The following attributes are interpreted:
Attribute | Values | Required |
---|---|---|
viewpath | Path to the ClearCase view file or directory that the command will operate on | No |
reserved | Specifies whether to check out the file as reserved or not | Yes |
out | Creates a writable file under a different filename | No |
nodata | Checks out the file but does not create an editable file containing its data | No |
branch | Specify a branch to check out the file to | No |
version | Allows checkout of a version other than main latest | No |
nowarn | Suppress warning messages | No |
comment | Specify a comment. Only one of comment or cfile may be used. | No |
commentfile | Specify a file containing a comment. Only one of comment or cfile may be used. | No |
notco | Fail if it's already checked out to the current view. Set to false to ignore it. | No |
failonerr | Throw an exception if the command fails. Default is true | No |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
FLAG_BRANCH
-branch flag -- checks out the file on a specified branch
|
static java.lang.String |
FLAG_COMMENT
-c flag -- comment to attach to the file
|
static java.lang.String |
FLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
|
static java.lang.String |
FLAG_NOCOMMENT
-nc flag -- no comment is specified
|
static java.lang.String |
FLAG_NODATA
-ndata flag -- checks out the file but does not create an editable file containing its data
|
static java.lang.String |
FLAG_NOWARN
-nwarn flag -- suppresses warning messages
|
static java.lang.String |
FLAG_OUT
-out flag -- create a writable file under a different filename
|
static java.lang.String |
FLAG_RESERVED
-reserved flag -- check out the file as reserved
|
static java.lang.String |
FLAG_UNRESERVED
-reserved flag -- check out the file as unreserved
|
static java.lang.String |
FLAG_VERSION
-version flag -- allows checkout of a version that is not main latest
|
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
description, location, project
Constructor and Description |
---|
CCCheckout() |
Modifier and Type | Method and Description |
---|---|
void |
execute()
Executes the task.
|
java.lang.String |
getBranch()
Get branch name
|
java.lang.String |
getComment()
Get comment string
|
java.lang.String |
getCommentFile()
Get comment file
|
boolean |
getNoData()
Get nodata flag status
|
boolean |
getNotco()
Get notco flag status
|
boolean |
getNoWarn()
Get nowarn flag status
|
java.lang.String |
getOut()
Get out file
|
boolean |
getReserved()
Get reserved flag status
|
boolean |
getVersion()
Get version flag status
|
void |
setBranch(java.lang.String branch)
Specify a branch to check out the file to.
|
void |
setComment(java.lang.String comment)
Sets the comment string.
|
void |
setCommentFile(java.lang.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 |
setNotco(boolean notco)
If true, checkout fails if the element is already checked out to the current view.
|
void |
setNoWarn(boolean nwarn)
If true, warning messages are suppressed.
|
void |
setOut(java.lang.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.
|
getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
public static final java.lang.String FLAG_RESERVED
public static final java.lang.String FLAG_UNRESERVED
public static final java.lang.String FLAG_OUT
public static final java.lang.String FLAG_NODATA
public static final java.lang.String FLAG_BRANCH
public static final java.lang.String FLAG_VERSION
public static final java.lang.String FLAG_NOWARN
public static final java.lang.String FLAG_COMMENT
public static final java.lang.String FLAG_COMMENTFILE
public static final java.lang.String FLAG_NOCOMMENT
public void execute() throws BuildException
Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
execute
in class Task
BuildException
- if the command fails and failonerr is set to truepublic void setReserved(boolean reserved)
reserved
- the status to set the flag topublic boolean getReserved()
public void setNotco(boolean notco)
notco
- the status to set the flag topublic boolean getNotco()
public void setOut(java.lang.String outf)
outf
- the path to the out filepublic java.lang.String getOut()
public void setNoData(boolean ndata)
ndata
- the status to set the flag topublic boolean getNoData()
public void setBranch(java.lang.String branch)
branch
- the name of the branchpublic java.lang.String getBranch()
public void setVersion(boolean version)
version
- the status to set the flag topublic boolean getVersion()
public void setNoWarn(boolean nwarn)
nwarn
- the status to set the flag topublic boolean getNoWarn()
public void setComment(java.lang.String comment)
comment
- the comment stringpublic java.lang.String getComment()
public void setCommentFile(java.lang.String cfile)
cfile
- the path to the comment filepublic java.lang.String getCommentFile()