Top Description Fields Constructors Methods
org.apache.tools.ant.taskdefs.optional.ccm

public Class CCMCheck

extends Continuus
Class Inheritance
Known Direct Subclasses
org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckin, org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckinDefault, org.apache.tools.ant.taskdefs.optional.ccm.CCMCheckout
Imports
java.io.File, java.util.Vector, org.apache.tools.ant.BuildException, .DirectoryScanner, .Project, org.apache.tools.ant.taskdefs.Execute, org.apache.tools.ant.types.Commandline, .FileSet
Class common to all check commands (checkout, checkin,checkin default task);

Field Summary

Modifier and TypeField and Description
private String
comment

private File
file

protected Vector<FileSet>
filesets

public static final String
FLAG_COMMENT

-comment flag -- comment to attach to the file

public static final String
FLAG_TASK

-task flag -- associate checkout task with task

private String
task

Inherited from org.apache.tools.ant.taskdefs.optional.ccm.Continuus:
COMMAND_CHECKINCOMMAND_CHECKOUTCOMMAND_CREATE_TASKCOMMAND_DEFAULT_TASKCOMMAND_RECONFIGURE

Constructor Summary

AccessConstructor and Description
public
CCMCheck()

Method Summary

Modifier and TypeMethod and Description
public void
addFileset(FileSet
the set of files
set)

Adds a set of files to copy.

private void
checkOptions(Commandline cmd)

Check the command line options.

private void
doit()

check the file given by getFile().

public void
execute()

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

Executes the task.
public String

Returns:

value of comment.
getComment()

Get the value of comment.

public File

Returns:

value of file.
getFile()

Get the value of file.

public String

Returns:

value of task.
getTask()

Get the value of task.

public void
setComment(String
Value to assign to comment.
v)

Specifies a comment.

public void
setFile(File
Value to assign to file.
v)

Sets the path to the file that the command will operate on.

public void
setTask(String
Value to assign to task.
v)

Specifies the task number used to check in the file (may use 'default').

Inherited from org.apache.tools.ant.taskdefs.optional.ccm.Continuus:
getCcmActiongetCcmCommandrunrunsetCcmActionsetCcmDir

Field Detail

commentback to summary
private String comment
fileback to summary
private File file
filesetsback to summary
protected Vector<FileSet> filesets
FLAG_COMMENTback to summary
public static final String FLAG_COMMENT

-comment flag -- comment to attach to the file

FLAG_TASKback to summary
public static final String FLAG_TASK

-task flag -- associate checkout task with task

taskback to summary
private String task

Constructor Detail

CCMCheckback to summary
public CCMCheck()

Method Detail

addFilesetback to summary
public void addFileset(FileSet set)

Adds a set of files to copy.

Parameters
set:FileSet

the set of files

checkOptionsback to summary
private void checkOptions(Commandline cmd)

Check the command line options.

doitback to summary
private void doit()

check the file given by getFile().

executeback to summary
public void execute() throws BuildException

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

Executes the task.

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

Annotations
@Override
Exceptions
BuildException:
on error
getCommentback to summary
public String getComment()

Get the value of comment.

Returns:String

value of comment.

getFileback to summary
public File getFile()

Get the value of file.

Returns:File

value of file.

getTaskback to summary
public String getTask()

Get the value of task.

Returns:String

value of task.

setCommentback to summary
public void setComment(String v)

Specifies a comment.

Parameters
v:String

Value to assign to comment.

setFileback to summary
public void setFile(File v)

Sets the path to the file that the command will operate on.

Parameters
v:File

Value to assign to file.

setTaskback to summary
public void setTask(String v)

Specifies the task number used to check in the file (may use 'default').

Parameters
v:String

Value to assign to task.