| org.apache.tools.ant.Task
 org.apache.tools.ant.taskdefs.AbstractCvsTask
All known Subclasses: org.apache.tools.ant.taskdefs.Cvs, org.apache.tools.ant.taskdefs.cvslib.CvsVersion, org.apache.tools.ant.taskdefs.cvslib.CvsTagDiff, org.apache.tools.ant.taskdefs.cvslib.ChangeLogTask,
| AbstractCvsTask | | abstract public class AbstractCvsTask extends Task (Code) | | original Cvs.java 1.20
NOTE: This implementation has been moved here from Cvs.java with
the addition of some accessors for extensibility. Another task
can extend this with some customized output processing.
since:
Ant 1.5 |
| Field Summary | |
| final public static int | DEFAULT_COMPRESSION_LEVEL
Default compression level to use, if compression is enabled via
setCompression( true ). |
| DEFAULT_COMPRESSION_LEVEL | | final public static int DEFAULT_COMPRESSION_LEVEL(Code) | | Default compression level to use, if compression is enabled via
setCompression( true ).
|
| AbstractCvsTask | | public AbstractCvsTask()(Code) | | empty no-arg constructor
|
| addCommandArgument | | public void addCommandArgument(String arg)(Code) | | This needs to be public to allow configuration
of commands externally.
Parameters:
arg - command argument |
| addCommandArgument | | public void addCommandArgument(Commandline c, String arg)(Code) | | This method adds a command line argument to an external command.
I do not understand what this method does in this class ???
particularly not why it is public ????
AntoineLL July 23d 2003
Parameters:
c - command line to which one argument should be added
Parameters:
arg - argument to add |
| addConfiguredCommandline | | public void addConfiguredCommandline(Commandline c)(Code) | | Adds direct command-line to execute.
Parameters:
c - command line to execute |
| addConfiguredCommandline | | public void addConfiguredCommandline(Commandline c, boolean insertAtStart)(Code) | | Configures and adds the given Commandline.
Parameters:
c - commandline to insert
Parameters:
insertAtStart - If true, c isinserted at the beginning of the vector of command lines |
| configureCommandline | | protected void configureCommandline(Commandline c)(Code) | | Configure a commandline element for things like cvsRoot, quiet, etc.
Parameters:
c - the command line which will be configuredif the commandline is initially null, the function is a noopotherwise the function append to the commandline arguments concerning- cvs package
- compression
- quiet or reallyquiet
- cvsroot
- noexec
|
| getCommand | | public String getCommand()(Code) | | accessor to a command line as string
This should be deprecated
AntoineLL July 23d 2003
command line as string |
| getCvsRoot | | public String getCvsRoot()(Code) | | access the CVSROOT variable
CVSROOT |
| getCvsRsh | | public String getCvsRsh()(Code) | | access the CVS_RSH variable
the CVS_RSH variable |
| getDest | | public File getDest()(Code) | | get the file where the checked out files should be placed
directory where the checked out files should be placed |
| getErrorStream | | protected OutputStream getErrorStream()(Code) | | access the stream to which the stderr from cvs should go
if this stream has already been set, it will be returned
if the stream has not yet been set, if the attribute error
has been set, the output stream will go to the file denoted by the error attribute
otherwise the stderr output will go to ant's logging system
output stream to which cvs' stderr should go to |
| getExecuteStreamHandler | | protected ExecuteStreamHandler getExecuteStreamHandler()(Code) | | find the handler and instantiate it if it does not exist yet
handler for output and error streams |
| getOutputStream | | protected OutputStream getOutputStream()(Code) | | access the stream to which the stdout from cvs should go
if this stream has already been set, it will be returned
if the stream has not yet been set, if the attribute output
has been set, the output stream will go to the output file
otherwise the output will go to ant's logging system
output stream to which cvs' stdout should go to |
| getPackage | | public String getPackage()(Code) | | access the package or module to operate upon
package/module |
| getPassFile | | public File getPassFile()(Code) | | find the password file
password file |
| getPort | | public int getPort()(Code) | | access the port of CVS
the port of CVS |
| getTag | | public String getTag()(Code) | | tag or branch
tag or branch
since:
ant 1.6.1 |
| removeCommandline | | protected void removeCommandline(Commandline c)(Code) | | remove a particular command from a vector of command lines
Parameters:
c - command line which should be removed |
| runCommand | | protected void runCommand(Commandline toExecute) throws BuildException(Code) | | Sets up the environment for toExecute and then runs it.
Parameters:
toExecute - the command line to execute
throws:
BuildException - if failonError is set to true and the cvs command fails |
| setAppend | | public void setAppend(boolean value)(Code) | | Whether to append output/error when redirecting to a file.
Parameters:
value - true indicated you want to append |
| setCommand | | public void setCommand(String c)(Code) | | The CVS command to execute.
This should be deprecated, it is better to use the Commandline class ?
AntoineLL July 23d 2003
Parameters:
c - a command as string |
| setCompression | | public void setCompression(boolean usecomp)(Code) | | If true, this is the same as compressionlevel="3".
Parameters:
usecomp - If true, turns on compression using defaultlevel, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL. |
| setCompressionLevel | | public void setCompressionLevel(int level)(Code) | | If set to a value 1-9 it adds -zN to the cvs command line, else
it disables compression.
Parameters:
level - compression level 1 to 9 |
| setCvsRoot | | public void setCvsRoot(String root)(Code) | | The CVSROOT variable.
Parameters:
root - the CVSROOT variable |
| setCvsRsh | | public void setCvsRsh(String rsh)(Code) | | The CVS_RSH variable.
Parameters:
rsh - the CVS_RSH variable |
| setDate | | public void setDate(String p)(Code) | | Use the most recent revision no later than the given date.
Parameters:
p - a date as string in a format that the CVS executablecan understand see man cvs |
| setDest | | public void setDest(File dest)(Code) | | The directory where the checked out files should be placed.
Note that this is different from CVS's -d command line
switch as Ant will never shorten pathnames to avoid empty
directories.
Parameters:
dest - directory where the checked out files should be placed |
| setError | | public void setError(File error)(Code) | | The file to direct standard error from the command.
Parameters:
error - a file to which stderr should go |
| setErrorStream | | protected void setErrorStream(OutputStream errorStream)(Code) | | sets a stream to which the stderr from the cvs exe should go
Parameters:
errorStream - an output stream willing to process stderr |
| setExecuteStreamHandler | | public void setExecuteStreamHandler(ExecuteStreamHandler handler)(Code) | | sets the handler
Parameters:
handler - a handler able of processing the output and error streams from the cvs exe |
| setFailOnError | | public void setFailOnError(boolean failOnError)(Code) | | Stop the build process if the command exits with
a return code other than 0.
Defaults to false.
Parameters:
failOnError - stop the build process if the command exits witha return code other than 0 |
| setNoexec | | public void setNoexec(boolean ne)(Code) | | If true, report only and don't change any files.
Parameters:
ne - if true, report only and do not change any files. |
| setOutput | | public void setOutput(File output)(Code) | | The file to direct standard output from the command.
Parameters:
output - a file to which stdout should go |
| setOutputStream | | protected void setOutputStream(OutputStream outputStream)(Code) | | sets a stream to which the output from the cvs executable should be sent
Parameters:
outputStream - stream to which the stdout from cvs should go |
| setPackage | | public void setPackage(String p)(Code) | | The package/module to operate upon.
Parameters:
p - package or module to operate upon |
| setPassfile | | public void setPassfile(File passFile)(Code) | | Password file to read passwords from.
Parameters:
passFile - password file to read passwords from |
| setPort | | public void setPort(int port)(Code) | | Port used by CVS to communicate with the server.
Parameters:
port - port of CVS |
| setQuiet | | public void setQuiet(boolean q)(Code) | | If true, suppress informational messages.
Parameters:
q - if true, suppress informational messages |
| setReallyquiet | | public void setReallyquiet(boolean q)(Code) | | If true, suppress all messages.
Parameters:
q - if true, suppress all messages
since:
Ant 1.6 |
| setTag | | public void setTag(String p)(Code) | | The tag of the package/module to operate upon.
Parameters:
p - tag |
|
|