Package org.apache.tools.ant.taskdefs
Class AbstractCvsTask
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AbstractCvsTask
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
ChangeLogTask
,Cvs
,CvsTagDiff
,CvsVersion
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
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Default compression level to use, if compression is enabled via setCompression(true).Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommandArgument
(String arg) This needs to be public to allow configuration of commands externally.void
addCommandArgument
(Commandline c, String arg) This method adds a command line argument to an external command.void
Adds direct command-line to execute.void
addConfiguredCommandline
(Commandline c, boolean insertAtStart) Configures and adds the given Commandline.void
add a named module/package.protected void
Configure a commandline element for things like cvsRoot, quiet, etc.void
execute()
do the workaccessor to a command line as string This should be deprecated AntoineLL July 23d 2003access the CVSROOT variableaccess the CVS_RSH variablegetDest()
get the file where the checked out files should be placedprotected OutputStream
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 systemprotected ExecuteStreamHandler
find the handler and instantiate it if it does not exist yetprotected List
<AbstractCvsTask.Module> protected OutputStream
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 systemaccess the package or module to operate uponfind the password fileint
getPort()
access the port of CVSgetTag()
tag or branchprotected void
remove a particular command from a vector of command linesprotected void
runCommand
(Commandline toExecute) Sets up the environment for toExecute and then runs it.void
setAppend
(boolean value) Whether to append output/error when redirecting to a file.void
setCommand
(String c) The CVS command to execute.void
setCompression
(boolean usecomp) If true, this is the same as compressionlevel="3".void
setCompressionLevel
(int level) If set to a value 1-9 it adds -zN to the cvs command line, else it disables compression.void
setCvsRoot
(String root) The CVSROOT variable.void
The CVS_RSH variable.void
Use the most recent revision no later than the given date.void
The directory where the checked out files should be placed.void
The file to direct standard error from the command.protected void
setErrorStream
(OutputStream errorStream) sets a stream to which the stderr from the cvs exe should govoid
sets the handlervoid
setFailOnError
(boolean failOnError) Stop the build process if the command exits with a return code other than 0.void
setNoexec
(boolean ne) If true, report only and don't change any files.void
The file to direct standard output from the command.protected void
setOutputStream
(OutputStream outputStream) sets a stream to which the output from the cvs executable should be sentvoid
setPackage
(String p) The package/module to operate upon.void
setPassfile
(File passFile) Password file to read passwords from.void
setPort
(int port) Port used by CVS to communicate with the server.void
setQuiet
(boolean q) If true, suppress informational messages.void
setReallyquiet
(boolean q) If true, suppress all messages.void
The tag of the package/module to operate upon.Methods inherited from class org.apache.tools.ant.Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
-
Field Details
-
DEFAULT_COMPRESSION_LEVEL
public static final int DEFAULT_COMPRESSION_LEVELDefault compression level to use, if compression is enabled via setCompression(true).- See Also:
-
-
Constructor Details
-
AbstractCvsTask
public AbstractCvsTask()
-
-
Method Details
-
setExecuteStreamHandler
sets the handler- Parameters:
handler
- a handler able of processing the output and error streams from the cvs exe
-
getExecuteStreamHandler
find the handler and instantiate it if it does not exist yet- Returns:
- handler for output and error streams
-
setOutputStream
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
-
getOutputStream
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- Returns:
- output stream to which cvs' stdout should go to
-
setErrorStream
sets a stream to which the stderr from the cvs exe should go- Parameters:
errorStream
- an output stream willing to process stderr
-
getErrorStream
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- Returns:
- output stream to which cvs' stderr should go to
-
runCommand
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
-
execute
do the work- Overrides:
execute
in classTask
- Throws:
BuildException
- if failonerror is set to true and the cvs command fails.
-
setCvsRoot
-
getCvsRoot
-
setCvsRsh
-
getCvsRsh
-
setPort
public void setPort(int port) Port used by CVS to communicate with the server.- Parameters:
port
- port of CVS
-
getPort
public int getPort()access the port of CVS- Returns:
- the port of CVS
-
setPassfile
Password file to read passwords from.- Parameters:
passFile
- password file to read passwords from
-
getPassFile
-
setDest
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
-
getDest
get the file where the checked out files should be placed- Returns:
- directory where the checked out files should be placed
-
setPackage
The package/module to operate upon.- Parameters:
p
- package or module to operate upon
-
getPackage
-
getTag
-
setTag
-
addCommandArgument
This needs to be public to allow configuration of commands externally.- Parameters:
arg
- command argument
-
addCommandArgument
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 addedarg
- argument to add
-
setDate
Use the most recent revision no later than the given date.- Parameters:
p
- a date as string in a format that the CVS executable can understand see man cvs
-
setCommand
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
-
getCommand
accessor to a command line as string This should be deprecated AntoineLL July 23d 2003- Returns:
- command line as string
-
setQuiet
public void setQuiet(boolean q) If true, suppress informational messages.- Parameters:
q
- if true, suppress informational messages
-
setReallyquiet
public void setReallyquiet(boolean q) If true, suppress all messages.- Parameters:
q
- if true, suppress all messages- Since:
- Ant 1.6
-
setNoexec
public void setNoexec(boolean ne) If true, report only and don't change any files.- Parameters:
ne
- if true, report only and do not change any files.
-
setOutput
The file to direct standard output from the command.- Parameters:
output
- a file to which stdout should go
-
setError
The file to direct standard error from the command.- Parameters:
error
- a file to which stderr should go
-
setAppend
public void setAppend(boolean value) Whether to append output/error when redirecting to a file.- Parameters:
value
- true indicated you want to append
-
setFailOnError
public void setFailOnError(boolean failOnError) 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 with a return code other than 0
-
configureCommandline
Configure a commandline element for things like cvsRoot, quiet, etc.- Parameters:
c
- the command line which will be configured if the commandline is initially null, the function is a noop otherwise the function append to the commandline arguments concerning- cvs package
- compression
- quiet or reallyquiet
- cvsroot
- noexec
-
removeCommandline
remove a particular command from a vector of command lines- Parameters:
c
- command line which should be removed
-
addConfiguredCommandline
Adds direct command-line to execute.- Parameters:
c
- command line to execute
-
addConfiguredCommandline
Configures and adds the given Commandline.- Parameters:
c
- commandline to insertinsertAtStart
- If true, c is inserted at the beginning of the vector of command lines
-
setCompressionLevel
public void setCompressionLevel(int level) 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
-
setCompression
public void setCompression(boolean usecomp) If true, this is the same as compressionlevel="3".- Parameters:
usecomp
- If true, turns on compression using default level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL.
-
addModule
add a named module/package.- Parameters:
m
- Module- Since:
- Ant 1.8.0
-
getModules
-