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

Task attributes
Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	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
nowarn	Suppress warning messages	No
preservetime	Preserve the modification time	No
keepcopy	Keeps a copy of the file with a .keep extension	No
identical	Allows the file to be checked in even if it is identical to the original	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_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_IDENTICAL -identical flag -- allows the file to be checked in even if it is identical to the original
public static final String	FLAG_KEEPCOPY -keep flag -- keeps a copy of the file with a .keep extension
public static final String	FLAG_NOCOMMENT -nc flag -- no comment is specified
public static final String	FLAG_NOWARN -nwarn flag -- suppresses warning messages
public static final String	FLAG_PRESERVETIME -ptime flag -- preserves the modification time
private String	mCfile
private String	mComment
private boolean	mIdentical
private boolean	mKeep
private boolean	mNwarn
private boolean	mPtime

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	CCCheckin()

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 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 commentfile flag and file appended cmd) Get the 'commentfile' command
public boolean	Returns: boolean containing status of identical flag getIdentical() Get identical flag status
public boolean	Returns: boolean containing status of keepcopy flag getKeepCopy() Get keepcopy flag status
public boolean	Returns: boolean containing status of nwarn flag getNoWarn() Get nowarn flag status
public boolean	Returns: boolean containing status of preservetime flag getPreserveTime() Get preservetime flag status
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	setIdentical(boolean the status to set the flag to identical) If true, allows the file to be checked in even if it is identical to the original.
public void	setKeepCopy(boolean the status to set the flag to keep) If true, keeps a copy of the file with a .keep extension.
public void	setNoWarn(boolean the status to set the flag to nwarn) If true, suppress warning messages.
public void	setPreserveTime(boolean the status to set the flag to ptime) If true, preserve the modification time.

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_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_IDENTICAL	back to summary
public static final String FLAG_IDENTICAL -identical flag -- allows the file to be checked in even if it is identical to the original

FLAG_KEEPCOPY	back to summary
public static final String FLAG_KEEPCOPY -keep flag -- keeps a copy of the file with a .keep extension

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

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

FLAG_PRESERVETIME	back to summary
public static final String FLAG_PRESERVETIME -ptime flag -- preserves the modification time

mCfile	back to summary
private String mCfile

mComment	back to summary
private String mComment

mIdentical	back to summary
private boolean mIdentical

mKeep	back to summary
private boolean mKeep

mNwarn	back to summary
private boolean mNwarn

mPtime	back to summary
private boolean mPtime

Constructor Detail

CCCheckin	back to summary
public CCCheckin()

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

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 'commentfile' command Parameters cmd:Commandline containing the command line string with or without the commentfile flag and file appended

getCommentFileCommand

back to summary

private void getCommentFileCommand(Commandline cmd)

Get the 'commentfile' command

Parameters

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

getIdentical	back to summary
public boolean getIdentical() Get identical flag status Returns:boolean boolean containing status of identical flag

getIdentical

back to summary

public boolean getIdentical()

Get identical flag status

Returns:boolean: boolean containing status of identical flag

getKeepCopy	back to summary
public boolean getKeepCopy() Get keepcopy flag status Returns:boolean boolean containing status of keepcopy flag

getKeepCopy

back to summary

public boolean getKeepCopy()

Get keepcopy flag status

Returns:boolean: boolean containing status of keepcopy flag

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

getPreserveTime	back to summary
public boolean getPreserveTime() Get preservetime flag status Returns:boolean boolean containing status of preservetime flag

getPreserveTime

back to summary

public boolean getPreserveTime()

Get preservetime flag status

Returns:boolean: boolean containing status of preservetime flag

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

setIdentical	back to summary
public void setIdentical(boolean identical) If true, allows the file to be checked in even if it is identical to the original. Parameters identical:boolean the status to set the flag to

setIdentical

back to summary

public void setIdentical(boolean identical)

If true, allows the file to be checked in even if it is identical to the original.

Parameters

identical:boolean: the status to set the flag to

setKeepCopy	back to summary
public void setKeepCopy(boolean keep) If true, keeps a copy of the file with a .keep extension. Parameters keep:boolean the status to set the flag to

setKeepCopy

back to summary

public void setKeepCopy(boolean keep)

If true, keeps a copy of the file with a .keep extension.

Parameters

keep:boolean: the status to set the flag to

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

setNoWarn

back to summary

public void setNoWarn(boolean nwarn)

If true, suppress warning messages.

Parameters

nwarn:boolean: the status to set the flag to

setPreserveTime	back to summary
public void setPreserveTime(boolean ptime) If true, preserve the modification time. Parameters ptime:boolean the status to set the flag to

setPreserveTime

back to summary

public void setPreserveTime(boolean ptime)

If true, preserve the modification time.

Parameters

ptime:boolean: the status to set the flag to

public Class CCCheckin

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail