org.apache.tools.ant.taskdefs.optional.clearcase
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 |
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 |
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 | getNotco()
Get notco flag status
|
boolean | getNoWarn()
Get nowarn 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 | 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(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.
|
Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
Throws: BuildException if the command fails and failonerr is set to true
Returns: String containing the name of the branch
Returns: String containing the comment
Returns: String containing the path to the comment file
Returns: boolean containing status of ndata flag
Returns: boolean containing status of notco flag
Since: ant 1.6.1
Returns: boolean containing status of nwarn flag
Returns: String containing the path to the out file
Returns: boolean containing status of reserved flag
Returns: boolean containing status of version flag
Parameters: branch the name of the branch
Parameters: comment the comment string
Parameters: cfile the path to the comment file
Parameters: ndata the status to set the flag to
Parameters: notco the status to set the flag to
Since: ant 1.6.1
Parameters: nwarn the status to set the flag to
Parameters: outf the path to the out file
Parameters: reserved the status to set the flag to
Parameters: version the status to set the flag to