org.apache.tools.ant.taskdefs.optional.ccm: public class: CCMCheck

org.apache.tools.ant.taskdefs.optional.ccm
public class: CCMCheck [javadoc | source]

java.lang.Object
   org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
         org.apache.tools.ant.taskdefs.optional.ccm.Continuus
            org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck

All Implemented Interfaces:
Cloneable

Direct Known Subclasses:
CCMCheckinDefault, CCMCheckout, CCMCheckin

Class common to all check commands (checkout, checkin,checkin default task);

ant.task: ignore - ="true"

Field Summary
protected Vector	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

Fields inherited from org.apache.tools.ant.taskdefs.optional.ccm.Continuus:
COMMAND_CREATE_TASK, COMMAND_CHECKOUT, COMMAND_CHECKIN, COMMAND_RECONFIGURE, COMMAND_DEFAULT_TASK

Fields inherited from org.apache.tools.ant.Task:
target, taskName, taskType, wrapper

Fields inherited from org.apache.tools.ant.ProjectComponent:
project, location, description

Constructor:
public CCMCheck() { // CheckStyle:VisibilityModifier ON super(); } Constructor for CCMCheck.

Constructor:

 public CCMCheck() {
    // CheckStyle:VisibilityModifier ON
        super();
}

Constructor for CCMCheck.

Method from org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck Summary:
addFileset, execute, getComment, getFile, getTask, setComment, setFile, setTask

Methods from org.apache.tools.ant.taskdefs.optional.ccm.Continuus:
getCcmAction, getCcmCommand, run, run, setCcmAction, setCcmDir

Methods from org.apache.tools.ant.Task:
bindToOwner, execute, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, markInvalid, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods from org.apache.tools.ant.ProjectComponent:
clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck Detail:
public void addFileset(FileSet set) { filesets.addElement(set); } Adds a set of files to copy.
public void execute() throws BuildException { if (file == null && filesets.size() == 0) { throw new BuildException( "Specify at least one source - a file or a fileset."); } if (file != null && file.exists() && file.isDirectory()) { throw new BuildException("CCMCheck cannot be generated for directories"); } if (file != null && filesets.size() > 0) { throw new BuildException("Choose between file and fileset !"); } if (getFile() != null) { doit(); return; } int sizeofFileSet = filesets.size(); for (int i = 0; i < sizeofFileSet; i++) { FileSet fs = (FileSet) filesets.elementAt(i); DirectoryScanner ds = fs.getDirectoryScanner(getProject()); String[] srcFiles = ds.getIncludedFiles(); for (int j = 0; j < srcFiles.length; j++) { File src = new File(fs.getDir(getProject()), srcFiles[j]); setFile(src); doit(); } } } Executes the task. Builds a command line to execute ccm and then calls Exec's run method to execute the command line.
public String getComment() { return comment; } Get the value of comment.
public File getFile() { return file; } Get the value of file.
public String getTask() { return task; } Get the value of task.
public void setComment(String v) { this.comment = v; } Specifies a comment.
public void setFile(File v) { log("working file " + v, Project.MSG_VERBOSE); this.file = v; } Sets the path to the file that the command will operate on.
public void setTask(String v) { this.task = v; } Specifies the task number used to check in the file (may use 'default').

Method from org.apache.tools.ant.taskdefs.optional.ccm.CCMCheck Detail:

 public  void addFileset(FileSet set) {
        filesets.addElement(set);
}

Adds a set of files to copy.

 public  void execute() throws BuildException {
        if (file == null && filesets.size() == 0) {
            throw new BuildException(
                "Specify at least one source - a file or a fileset.");
        }
        if (file != null && file.exists() && file.isDirectory()) {
            throw new BuildException("CCMCheck cannot be generated for directories");
        }
        if (file != null  && filesets.size()  > 0) {
            throw new BuildException("Choose between file and fileset !");
        }
        if (getFile() != null) {
            doit();
            return;
        }
        int sizeofFileSet = filesets.size();
        for (int i = 0; i <  sizeofFileSet; i++) {
            FileSet fs = (FileSet) filesets.elementAt(i);
            DirectoryScanner ds = fs.getDirectoryScanner(getProject());
            String[] srcFiles = ds.getIncludedFiles();
            for (int j = 0; j <  srcFiles.length; j++) {
                File src = new File(fs.getDir(getProject()), srcFiles[j]);
                setFile(src);
                doit();
            }
        }
}

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

 public String getComment() {
        return comment;
}

Get the value of comment.

 public File getFile() {
        return file;
}

Get the value of file.

 public String getTask() {
        return task;
}

Get the value of task.

 public  void setComment(String v) {
        this.comment = v;
}

Specifies a comment.

 public  void setFile(File v) {
        log("working file " + v, Project.MSG_VERBOSE);
        this.file = v;
}

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

 public  void setTask(String v) {
        this.task = v;
}

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