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 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_IDENTICAL
-identical flag -- allows the file to be checked in even if it is identical to the original
static String
FLAG_KEEPCOPY
-keep flag -- keeps a copy of the file with a .keep extension
static String
FLAG_NOCOMMENT
-nc flag -- no comment is specified
static String
FLAG_NOWARN
-nwarn flag -- suppresses warning messages
static String
FLAG_PRESERVETIME
-ptime flag -- preserves the modification time

Fields inherited from class 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

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Method Summary

void
execute()
Executes the task.
String
getComment()
Get comment string
String
getCommentFile()
Get comment file
boolean
getIdentical()
Get identical flag status
boolean
getKeepCopy()
Get keepcopy flag status
boolean
getNoWarn()
Get nowarn flag status
boolean
getPreserveTime()
Get preservetime flag status
void
setComment(String comment)
Sets the comment string.
void
setCommentFile(String cfile)
Specifies a file containing a comment.
void
setIdentical(boolean identical)
If true, allows the file to be checked in even if it is identical to the original.
void
setKeepCopy(boolean keep)
If true, keeps a copy of the file with a .keep extension.
void
setNoWarn(boolean nwarn)
If true, suppress warning messages.
void
setPreserveTime(boolean ptime)
If true, preserve the modification time.

Methods inherited from class org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase

getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Field Details

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 Details

execute

public void execute()
            throws BuildException
Executes the task.

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

Overrides:
execute in interface Task

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-2005 Apache Software Foundation. All Rights Reserved.