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

Class CCCheckin

public class CCCheckin extends ClearCase

Performs ClearCase checkin.

The following attributes are interpreted:

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
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_IDENTICAL
-identical flag -- allows the file to be checked in even if it is identical to the original
static StringFLAG_KEEPCOPY
-keep flag -- keeps a copy of the file with a .keep extension
static StringFLAG_NOCOMMENT
-nc flag -- no comment is specified
static StringFLAG_NOWARN
-nwarn flag -- suppresses warning messages
static StringFLAG_PRESERVETIME
-ptime flag -- preserves the modification time
Method Summary
voidexecute()
Executes the task.
StringgetComment()
Get comment string
StringgetCommentFile()
Get comment file
booleangetIdentical()
Get identical flag status
booleangetKeepCopy()
Get keepcopy flag status
booleangetNoWarn()
Get nowarn flag status
booleangetPreserveTime()
Get preservetime flag status
voidsetComment(String comment)
Sets the comment string.
voidsetCommentFile(String cfile)
Specifies a file containing a comment.
voidsetIdentical(boolean identical)
If true, allows the file to be checked in even if it is identical to the original.
voidsetKeepCopy(boolean keep)
If true, keeps a copy of the file with a .keep extension.
voidsetNoWarn(boolean nwarn)
If true, suppress warning messages.
voidsetPreserveTime(boolean ptime)
If true, preserve the modification time.

Field Detail

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_IDENTICAL

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

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

FLAG_NOCOMMENT

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

FLAG_NOWARN

public static final String FLAG_NOWARN
-nwarn flag -- suppresses warning messages

FLAG_PRESERVETIME

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

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

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

getIdentical

public boolean getIdentical()
Get identical flag status

Returns: boolean containing status of identical flag

getKeepCopy

public boolean getKeepCopy()
Get keepcopy flag status

Returns: boolean containing status of keepcopy flag

getNoWarn

public boolean getNoWarn()
Get nowarn flag status

Returns: boolean containing status of nwarn flag

getPreserveTime

public boolean getPreserveTime()
Get preservetime flag status

Returns: boolean containing status of preservetime flag

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

setIdentical

public void setIdentical(boolean identical)
If true, allows the file to be checked in even if it is identical to the original.

Parameters: identical the status to set the flag to

setKeepCopy

public void setKeepCopy(boolean keep)
If true, keeps a copy of the file with a .keep extension.

Parameters: keep the status to set the flag to

setNoWarn

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

Parameters: nwarn the status to set the flag to

setPreserveTime

public void setPreserveTime(boolean ptime)
If true, preserve the modification time.

Parameters: ptime the status to set the flag to

Copyright B) 2000-2007 Apache Software Foundation. All Rights Reserved.