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

Class CCCheckout

public class CCCheckout extends ClearCase

Performs ClearCase checkout.

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 StringFLAG_BRANCH
-branch flag -- checks out the file on a specified branch
static StringFLAG_COMMENT
-c flag -- comment to attach to the file
static StringFLAG_COMMENTFILE
-cfile flag -- file containing a comment to attach to the file
static StringFLAG_NOCOMMENT
-nc flag -- no comment is specified
static StringFLAG_NODATA
-ndata flag -- checks out the file but does not create an editable file containing its data
static StringFLAG_NOWARN
-nwarn flag -- suppresses warning messages
static StringFLAG_OUT
-out flag -- create a writable file under a different filename
static StringFLAG_RESERVED
-reserved flag -- check out the file as reserved
static StringFLAG_UNRESERVED
-reserved flag -- check out the file as unreserved
static StringFLAG_VERSION
-version flag -- allows checkout of a version that is not main latest
Method Summary
voidexecute()
Executes the task.
StringgetBranch()
Get branch name
StringgetComment()
Get comment string
StringgetCommentFile()
Get comment file
booleangetNoData()
Get nodata flag status
booleangetNotco()
Get notco flag status
booleangetNoWarn()
Get nowarn flag status
StringgetOut()
Get out file
booleangetReserved()
Get reserved flag status
booleangetVersion()
Get version flag status
voidsetBranch(String branch)
Specify a branch to check out the file to.
voidsetComment(String comment)
Sets the comment string.
voidsetCommentFile(String cfile)
Specifies a file containing a comment.
voidsetNoData(boolean ndata)
If true, checks out the file but does not create an editable file containing its data.
voidsetNotco(boolean notco)
If true, checkout fails if the element is already checked out to the current view.
voidsetNoWarn(boolean nwarn)
If true, warning messages are suppressed.
voidsetOut(String outf)
Creates a writable file under a different filename.
voidsetReserved(boolean reserved)
If true, checks out the file as reserved.
voidsetVersion(boolean version)
If true, allows checkout of a version other than main latest.

Field Detail

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 Detail

execute

public void execute()
Executes the task.

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

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

getNotco

public boolean getNotco()
Get notco flag status

Returns: boolean containing status of notco flag

Since: ant 1.6.1

getNoWarn

public boolean getNoWarn()
Get nowarn flag status

Returns: boolean containing status of nwarn flag

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

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

setNoWarn

public void setNoWarn(boolean nwarn)
If true, warning messages are suppressed.

Parameters: nwarn the status to set the flag to

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