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 SummaryNested Classes
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final intDefault compression level to use, if compression is enabled via setCompression(true).Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidaddCommandArgument(String arg) This needs to be public to allow configuration of commands externally.voidaddCommandArgument(Commandline c, String arg) This method adds a command line argument to an external command.voidAdds direct command-line to execute.voidaddConfiguredCommandline(Commandline c, boolean insertAtStart) Configures and adds the given Commandline.voidadd a named module/package.protected voidConfigure a commandline element for things like cvsRoot, quiet, etc.voidexecute()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 OutputStreamaccess 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 ExecuteStreamHandlerfind the handler and instantiate it if it does not exist yetprotected List<AbstractCvsTask.Module> protected OutputStreamaccess 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 fileintgetPort()access the port of CVSgetTag()tag or branchprotected voidremove a particular command from a vector of command linesprotected voidrunCommand(Commandline toExecute) Sets up the environment for toExecute and then runs it.voidsetAppend(boolean value) Whether to append output/error when redirecting to a file.voidsetCommand(String c) The CVS command to execute.voidsetCompression(boolean usecomp) If true, this is the same as compressionlevel="3".voidsetCompressionLevel(int level) If set to a value 1-9 it adds -zN to the cvs command line, else it disables compression.voidsetCvsRoot(String root) The CVSROOT variable.voidThe CVS_RSH variable.voidUse the most recent revision no later than the given date.voidThe directory where the checked out files should be placed.voidThe file to direct standard error from the command.protected voidsetErrorStream(OutputStream errorStream) sets a stream to which the stderr from the cvs exe should govoidsets the handlervoidsetFailOnError(boolean failOnError) Stop the build process if the command exits with a return code other than 0.voidsetNoexec(boolean ne) If true, report only and don't change any files.voidThe file to direct standard output from the command.protected voidsetOutputStream(OutputStream outputStream) sets a stream to which the output from the cvs executable should be sentvoidsetPackage(String p) The package/module to operate upon.voidsetPassfile(File passFile) Password file to read passwords from.voidsetPort(int port) Port used by CVS to communicate with the server.voidsetQuiet(boolean q) If true, suppress informational messages.voidsetReallyquiet(boolean q) If true, suppress all messages.voidThe tag of the package/module to operate upon.Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Field Details- 
DEFAULT_COMPRESSION_LEVELpublic static final int DEFAULT_COMPRESSION_LEVELDefault compression level to use, if compression is enabled via setCompression(true).- See Also:
 
 
- 
- 
Constructor Details- 
AbstractCvsTaskpublic AbstractCvsTask()
 
- 
- 
Method Details- 
setExecuteStreamHandlersets the handler- Parameters:
- handler- a handler able of processing the output and error streams from the cvs exe
 
- 
getExecuteStreamHandlerfind the handler and instantiate it if it does not exist yet- Returns:
- handler for output and error streams
 
- 
setOutputStreamsets a stream to which the output from the cvs executable should be sent- Parameters:
- outputStream- stream to which the stdout from cvs should go
 
- 
getOutputStreamaccess 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
 
- 
setErrorStreamsets a stream to which the stderr from the cvs exe should go- Parameters:
- errorStream- an output stream willing to process stderr
 
- 
getErrorStreamaccess 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
 
- 
runCommandSets 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
 
- 
executedo the work- Overrides:
- executein class- Task
- Throws:
- BuildException- if failonerror is set to true and the cvs command fails.
 
- 
setCvsRoot
- 
getCvsRoot
- 
setCvsRsh
- 
getCvsRsh
- 
setPortpublic void setPort(int port) Port used by CVS to communicate with the server.- Parameters:
- port- port of CVS
 
- 
getPortpublic int getPort()access the port of CVS- Returns:
- the port of CVS
 
- 
setPassfilePassword file to read passwords from.- Parameters:
- passFile- password file to read passwords from
 
- 
getPassFile
- 
setDestThe 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
 
- 
getDestget the file where the checked out files should be placed- Returns:
- directory where the checked out files should be placed
 
- 
setPackageThe package/module to operate upon.- Parameters:
- p- package or module to operate upon
 
- 
getPackage
- 
getTag
- 
setTag
- 
addCommandArgumentThis needs to be public to allow configuration of commands externally.- Parameters:
- arg- command argument
 
- 
addCommandArgumentThis 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
- arg- argument to add
 
- 
setDateUse 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
 
- 
setCommandThe 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
 
- 
getCommandaccessor to a command line as string This should be deprecated AntoineLL July 23d 2003- Returns:
- command line as string
 
- 
setQuietpublic void setQuiet(boolean q) If true, suppress informational messages.- Parameters:
- q- if true, suppress informational messages
 
- 
setReallyquietpublic void setReallyquiet(boolean q) If true, suppress all messages.- Parameters:
- q- if true, suppress all messages
- Since:
- Ant 1.6
 
- 
setNoexecpublic 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.
 
- 
setOutputThe file to direct standard output from the command.- Parameters:
- output- a file to which stdout should go
 
- 
setErrorThe file to direct standard error from the command.- Parameters:
- error- a file to which stderr should go
 
- 
setAppendpublic void setAppend(boolean value) Whether to append output/error when redirecting to a file.- Parameters:
- value- true indicated you want to append
 
- 
setFailOnErrorpublic 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
 
- 
configureCommandlineConfigure 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
 
 
- 
removeCommandlineremove a particular command from a vector of command lines- Parameters:
- c- command line which should be removed
 
- 
addConfiguredCommandlineAdds direct command-line to execute.- Parameters:
- c- command line to execute
 
- 
addConfiguredCommandlineConfigures and adds the given Commandline.- Parameters:
- c- commandline to insert
- insertAtStart- If true, c is inserted at the beginning of the vector of command lines
 
- 
setCompressionLevelpublic 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
 
- 
setCompressionpublic 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.
 
- 
addModuleadd a named module/package.- Parameters:
- m- Module
- Since:
- Ant 1.8.0
 
- 
getModules
 
-