Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.AbstractCvsTask
public abstract class AbstractCvsTask
extends Task
Field Summary | |
static int |
|
Fields inherited from class org.apache.tools.ant.ProjectComponent | |
description , location , project |
Constructor Summary | |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
protected void |
|
void |
|
String |
|
String |
|
String |
|
File |
|
protected OutputStream |
|
protected ExecuteStreamHandler |
|
protected OutputStream |
|
String |
|
File |
|
int |
|
String |
|
protected void |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
protected void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from class org.apache.tools.ant.Task | |
bindToOwner , execute , 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 , log , log , setDescription , setLocation , setProject |
public static final int DEFAULT_COMPRESSION_LEVEL
Default compression level to use, if compression is enabled via setCompression( true ).
- Field Value:
- 3
public void addCommandArgument(String arg)
This needs to be public to allow configuration of commands externally.
- Parameters:
arg
- command argument
public void addCommandArgument(Commandline c, String arg)
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
public void addConfiguredCommandline(Commandline c)
Adds direct command-line to execute.
- Parameters:
c
- command line to execute
public void addConfiguredCommandline(Commandline c, boolean insertAtStart)
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
protected void configureCommandline(Commandline c)
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
public void execute() throws BuildException
do the work
- Throws:
BuildException
- if failonerror is set to true and the cvs command fails.
public String getCommand()
accessor to a command line as string This should be deprecated AntoineLL July 23d 2003
- Returns:
- command line as string
public String getCvsRoot()
access the CVSROOT variable
- Returns:
- CVSROOT
public String getCvsRsh()
access the CVS_RSH variable
- Returns:
- the CVS_RSH variable
public File getDest()
get the file where the checked out files should be placed
- Returns:
- directory where the checked out files should be placed
protected OutputStream 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
protected ExecuteStreamHandler getExecuteStreamHandler()
find the handler and instantiate it if it does not exist yet
- Returns:
- handler for output and error streams
protected OutputStream 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
public String getPackage()
access the package or module to operate upon
- Returns:
- package/module
public File getPassFile()
find the password file
- Returns:
- password file
public int getPort()
access the port of CVS
- Returns:
- the port of CVS
public String getTag()
tag or branch
- Returns:
- tag or branch
- Since:
- ant 1.6.1
protected void removeCommandline(Commandline c)
remove a particular command from a vector of command lines
- Parameters:
c
- command line which should be removed
protected void runCommand(Commandline toExecute) throws BuildException
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
public void setAppend(boolean value)
Whether to append output/error when redirecting to a file.
- Parameters:
value
- true indicated you want to append
public void setCommand(String c)
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
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.
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
public void setCvsRoot(String root)
The CVSROOT variable.
- Parameters:
root
- the CVSROOT variable
public void setCvsRsh(String rsh)
The CVS_RSH variable.
- Parameters:
rsh
- the CVS_RSH variable
public void setDate(String p)
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
public void setDest(File dest)
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
public void setError(File error)
The file to direct standard error from the command.
- Parameters:
error
- a file to which stderr should go
protected void setErrorStream(OutputStream errorStream)
sets a stream to which the stderr from the cvs exe should go
- Parameters:
errorStream
- an output stream willing to process stderr
public void setExecuteStreamHandler(ExecuteStreamHandler handler)
sets the handler
- Parameters:
handler
- a handler able of processing the output and error streams from the cvs exe
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
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.
public void setOutput(File output)
The file to direct standard output from the command.
- Parameters:
output
- a file to which stdout should go
protected void setOutputStream(OutputStream outputStream)
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
public void setPackage(String p)
The package/module to operate upon.
- Parameters:
p
- package or module to operate upon
public void setPassfile(File passFile)
Password file to read passwords from.
- Parameters:
passFile
- password file to read passwords from
public void setPort(int port)
Port used by CVS to communicate with the server.
- Parameters:
port
- port of CVS
public void setQuiet(boolean q)
If true, suppress informational messages.
- Parameters:
q
- if true, suppress informational messages
public void setReallyquiet(boolean q)
If true, suppress all messages.
- Parameters:
q
- if true, suppress all messages
- Since:
- Ant 1.6
public void setTag(String p)
The tag of the package/module to operate upon.
- Parameters:
p
- tag