Apache Ant 1.10.14 · org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout

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

Modifier and Type	Field and Description
public static final String	FLAG_BRANCH -branch flag -- checks out the file on a specified branch
public static final String	FLAG_COMMENT -c flag -- comment to attach to the file
public static final String	FLAG_COMMENTFILE -cfile flag -- file containing a comment to attach to the file
public static final String	FLAG_NOCOMMENT -nc flag -- no comment is specified
public static final String	FLAG_NODATA -ndata flag -- checks out the file but does not create an editable file containing its data
public static final String	FLAG_NOWARN -nwarn flag -- suppresses warning messages
public static final String	FLAG_OUT -out flag -- create a writable file under a different filename
public static final String	FLAG_RESERVED -reserved flag -- check out the file as reserved
public static final String	FLAG_UNRESERVED -reserved flag -- check out the file as unreserved
public static final String	FLAG_VERSION -version flag -- allows checkout of a version that is not main latest
private String	mBranch
private String	mCfile
private String	mComment
private boolean	mNdata
private boolean	mNotco
private boolean	mNwarn
private String	mOut
private boolean	mReserved
private boolean	mVersion

Inherited from 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

Constructor Summary

Access	Constructor and Description
public	CCCheckout()

Method Summary

Modifier and Type	Method and Description
private void	checkOptions(Commandline cmd) Check the command line options.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Executes the task.
public String	Returns: String containing the name of the branch getBranch() Get branch name
private void	getBranchCommand(Commandline containing the command line string with or without the branch flag and name appended cmd) Get the 'branch' command
public String	Returns: String containing the comment getComment() Get comment string
private void	getCommentCommand(Commandline containing the command line string with or without the comment flag and string appended cmd) Get the 'comment' command
public String	Returns: String containing the path to the comment file getCommentFile() Get comment file
private void	getCommentFileCommand(Commandline containing the command line string with or without the cfile flag and file appended cmd) Get the 'cfile' command
public boolean	Returns: boolean containing status of ndata flag getNoData() Get nodata flag status
public boolean	Returns: boolean containing status of notco flag getNotco() Get notco flag status
public boolean	Returns: boolean containing status of nwarn flag getNoWarn() Get nowarn flag status
public String	Returns: String containing the path to the out file getOut() Get out file
private void	getOutCommand(Commandline containing the command line string with or without the out flag and path appended cmd) Get the 'out' command
public boolean	Returns: boolean containing status of reserved flag getReserved() Get reserved flag status
public boolean	Returns: boolean containing status of version flag getVersion() Get version flag status
private boolean	lsCheckout() Check to see if the element is checked out in the current view.
public void	setBranch(String the name of the branch branch) Specify a branch to check out the file to.
public void	setComment(String the comment string comment) Sets the comment string.
public void	setCommentFile(String the path to the comment file cfile) Specifies a file containing a comment.
public void	setNoData(boolean the status to set the flag to ndata) If true, checks out the file but does not create an editable file containing its data.
public void	setNotco(boolean the status to set the flag to notco) If true, checkout fails if the element is already checked out to the current view.
public void	setNoWarn(boolean the status to set the flag to nwarn) If true, warning messages are suppressed.
public void	setOut(String the path to the out file outf) Creates a writable file under a different filename.
public void	setReserved(boolean the status to set the flag to reserved) If true, checks out the file as reserved.
public void	setVersion(boolean the status to set the flag to version) If true, allows checkout of a version other than main latest.

Inherited from org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase:: getClearToolCommand getFailOnErr getObjSelect getViewPath getViewPathBasename run runS runS setClearToolDir setFailOnErr setObjSelect setViewPath

Field Detail

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

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

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

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

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

FLAG_NOWARN	back to summary
public static final String FLAG_NOWARN -nwarn flag -- suppresses warning messages

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

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

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

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

mBranch	back to summary
private String mBranch

mCfile	back to summary
private String mCfile

mComment	back to summary
private String mComment

mNdata	back to summary
private boolean mNdata

mNotco	back to summary
private boolean mNotco

mNwarn	back to summary
private boolean mNwarn

mOut	back to summary
private String mOut

mReserved	back to summary
private boolean mReserved

mVersion	back to summary
private boolean mVersion

Constructor Detail

CCCheckout	back to summary
public CCCheckout()

Method Detail

checkOptions	back to summary
private void checkOptions(Commandline cmd) Check the command line options.

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Executes the task. Builds a command line to execute cleartool and then calls Exec's run method to execute the command line. Annotations @Override Exceptions BuildException: if the command fails and failonerr is set to true

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Executes the task.

Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.

Annotations

@Override

Exceptions

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

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

getBranch

back to summary

public String getBranch()

Get branch name

Returns:String: String containing the name of the branch

getBranchCommand	back to summary
private void getBranchCommand(Commandline cmd) Get the 'branch' command Parameters cmd:Commandline containing the command line string with or without the branch flag and name appended

getBranchCommand

back to summary

private void getBranchCommand(Commandline cmd)

Get the 'branch' command

Parameters

cmd:Commandline: containing the command line string with or without the branch flag and name appended

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

getComment

back to summary

public String getComment()

Get comment string

Returns:String: String containing the comment

getCommentCommand	back to summary
private void getCommentCommand(Commandline cmd) Get the 'comment' command Parameters cmd:Commandline containing the command line string with or without the comment flag and string appended

getCommentCommand

back to summary

private void getCommentCommand(Commandline cmd)

Get the 'comment' command

Parameters

cmd:Commandline: containing the command line string with or without the comment flag and string appended

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

getCommentFile

back to summary

public String getCommentFile()

Get comment file

Returns:String: String containing the path to the comment file

getCommentFileCommand	back to summary
private void getCommentFileCommand(Commandline cmd) Get the 'cfile' command Parameters cmd:Commandline containing the command line string with or without the cfile flag and file appended

getCommentFileCommand

back to summary

private void getCommentFileCommand(Commandline cmd)

Get the 'cfile' command

Parameters

cmd:Commandline: containing the command line string with or without the cfile flag and file appended

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

getNoData

back to summary

public boolean getNoData()

Get nodata flag status

Returns:boolean: boolean containing status of ndata flag

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

getNotco

back to summary

public boolean getNotco()

Get notco flag status

Returns:boolean: boolean containing status of notco flag
Since: ant 1.6.1

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

getNoWarn

back to summary

public boolean getNoWarn()

Get nowarn flag status

Returns:boolean: boolean containing status of nwarn flag

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

getOut

back to summary

public String getOut()

Get out file

Returns:String: String containing the path to the out file

getOutCommand	back to summary
private void getOutCommand(Commandline cmd) Get the 'out' command Parameters cmd:Commandline containing the command line string with or without the out flag and path appended

getOutCommand

back to summary

private void getOutCommand(Commandline cmd)

Get the 'out' command

Parameters

cmd:Commandline: containing the command line string with or without the out flag and path appended

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

getReserved

back to summary

public boolean getReserved()

Get reserved flag status

Returns:boolean: boolean containing status of reserved flag

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

getVersion

back to summary

public boolean getVersion()

Get version flag status

Returns:boolean: boolean containing status of version flag

lsCheckout	back to summary
private boolean lsCheckout() Check to see if the element is checked out in the current view.

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

setBranch

back to summary

public void setBranch(String branch)

Specify a branch to check out the file to.

Parameters

branch:String: the name of the branch

setComment	back to summary
public void setComment(String comment) Sets the comment string. Parameters comment:String the comment string

setComment

back to summary

public void setComment(String comment)

Sets the comment string.

Parameters

comment:String: the comment string

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

setCommentFile

back to summary

public void setCommentFile(String cfile)

Specifies a file containing a comment.

Parameters

cfile:String: the path to the comment file

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

setNoData

back to summary

public void setNoData(boolean ndata)

If true, checks out the file but does not create an editable file containing its data.

Parameters

ndata:boolean: the status to set the flag to

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

setNotco

back to summary

public void setNotco(boolean notco)

If true, checkout fails if the element is already checked out to the current view.

Parameters

notco:boolean: the status to set the flag to

Since

ant 1.6.1

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

setNoWarn

back to summary

public void setNoWarn(boolean nwarn)

If true, warning messages are suppressed.

Parameters

nwarn:boolean: the status to set the flag to

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

setOut

back to summary

public void setOut(String outf)

Creates a writable file under a different filename.

Parameters

outf:String: the path to the out file

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

setReserved

back to summary

public void setReserved(boolean reserved)

If true, checks out the file as reserved.

Parameters

reserved:boolean: the status to set the flag to

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

setVersion

back to summary

public void setVersion(boolean version)

If true, allows checkout of a version other than main latest.

Parameters

version:boolean: the status to set the flag to

public Class CCCheckout

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail