Task for performing CVS operations.

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.

author | Hans Lellelid <hans@xmpl.org> (Phing)
author | costin@dnt.ro (Ant)
author | stefano@apache.org (Ant)
author | Wolfgang Werner <wwerner@picturesafe.de> (Ant)
author | Kevin Ross <kevin.ross@bredex.com> (Ant)
version | $Id: 642c6947fa58e02a8c7893c8c4dfab2debfdd51d $
package | phing.tasks.system
copyright | 2001,2002 THYRELL. All rights reserved

### Methods

## Configures and adds the given Commandline.

    addConfiguredCommandline(\Commandline $c, $insertAtStart)

### Parameters

#### $c

`\insertAtStart`

If true, c is

#### $insertAtStart

## This needs to be public to allow configuration of commands externally.

    appendCommandArgument($arg)

### Parameters

#### $arg

## getCommand()

    getCommand()

## getCvsRoot()

    getCvsRoot()

## getCvsRsh()

    getCvsRsh()

## Returns the textual description of the task

    getDescription() : string

Inherited

inherited_from | \Task::getDescription()

### Returns

`string`The text description of the task

## getDest()

    getDest()

## Returns the location within the buildfile this task occurs.

    getLocation() : \Location

Inherited

Used by BuildException to give detailed error messages.

inherited_from | \Task::getLocation()

### Returns

`\Location`The location object describing the position of this task within the buildfile.

## getModule()

    getModule()

## Returns the owning target of this task.

    getOwningTarget() : \Target

Inherited

inherited_from | \Task::getOwningTarget()

### Returns

`\Target`The target object that owns this task

## getPassFile()

    getPassFile() : \File

### Returns

`\File`

## getPort()

    getPort() : int

### Returns

`int`

## Returns a reference to current project

    getProject() : \Project

Inherited

inherited_from | \ProjectComponent::getProject()
inherited_from | \Task::getProject()

### Returns

`\Project`Reference to current porject object

## Returns the wrapper object for runtime configuration

    getRuntimeConfigurableWrapper() : \RuntimeConfigurable

Inherited

inherited_from | \Task::getRuntimeConfigurableWrapper()

### Returns

`\RuntimeConfigurable`The wrapper object used by this task

## Returns the name of task, used only for log messages

    getTaskName() : string

Inherited

inherited_from | \Task::getTaskName()

### Returns

`string`Name of this task

## Returns the name of the task under which it was invoked, usually the XML tagname

    getTaskType() : string

Inherited

inherited_from | \Task::getTaskType()

### Returns

`string`The type of this task (XML Tag)

## Called by the parser to let the task initialize properly.

    init()

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

### Exceptions

`\BuildException` |

## Provides a project level log event to the task.

    log(string $msg, integer $level)

Inherited

see | \global\BuildEvent
see | \global\BuildListener
inherited_from | \Task::log()

### Parameters

#### $msg

`string`

The message to log

#### $level

`integer`

The priority of the message

## Called by the project to let the task do it's work.

    main() : void

This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running phing target1 target2 will run all tasks in target3 twice.

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

### Exceptions

`\BuildException` |

## Configure this task if it hasn't been done already.

    maybeConfigure()

Inherited

inherited_from | \Task::maybeConfigure()

## Perfrom this task

    perform()

Inherited

inherited_from | \Task::perform()

## The CVS command to execute.

    setCommand(string $c)

### Parameters

#### $c

`string`

## If true, this is the same as compressionlevel="3".

    setCompression(boolean $usecomp)

### Parameters

#### $usecomp

`boolean`

If true, turns on compression using default level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL.

## If set to a value 1-9 it adds -zN to the cvs command line, else it disables compression.

    setCompressionLevel(int $level)

### Parameters

#### $level

`int`

## The CVSROOT variable.

    setCvsRoot(string $root)

### Parameters

#### $root

`string`

## The CVS_RSH variable.

    setCvsRsh(\rsh $rsh)

### Parameters

#### $rsh

`\rsh`

## Use the most recent revision no later than the given date.

    setDate(\p $p)

### Parameters

#### $p

`\p`

## Sets a textual description of the task

    setDescription(string $desc)

Inherited

inherited_from | \Task::setDescription()

### Parameters

#### $desc

`string`

The text describing the task

## The directory where the checked out files should be placed.

    setDest(\PhingFile $dest)

### Parameters

#### $dest

`\PhingFile`

## File to which error output should be written.

    setError(\PhingFile $f)

### Parameters

#### $f

## Stop the build process if the command exits with a return code other than 0.

    setFailOnError(boolean $failOnError)

Defaults to false.

### Parameters

#### $failOnError

`boolean`

## Sets the location within the buildfile this task occurs.

    setLocation(\Location $location)

Inherited

Called by the parser to set location information.

inherited_from | \Task::setLocation()

### Parameters

#### $location

`\Location`

The location object describing the position of this task within the buildfile.

## The package/module to operate upon.

    setModule($m)

### Parameters

#### $m

## If true, report only and don't change any files.

    setNoexec(boolean $ne)

### Parameters

#### $ne

`boolean`

## File to which output should be written.

    setOutput(\PhingFile $f)

### Parameters

#### $f

## Sets the owning target this task belongs to.

    setOwningTarget(\Target $target)

Inherited

inherited_from | \Task::setOwningTarget()

### Parameters

#### $target

`\Target`

Reference to owning target

## Password file to read passwords from.

    setPassfile(\PhingFile $passFile)

### Parameters

#### $passFile

`\passFile`

## Port used by CVS to communicate with the server.

    setPort(int $port)

### Parameters

#### $port

`int`

## References the project to the current component.

    setProject(\Project $project)

Inherited

inherited_from | \ProjectComponent::setProject()
inherited_from | \Task::setProject()

### Parameters

#### $project

`\Project`

The reference to the current project

## If true, suppress informational messages.

    setQuiet(boolean $q)

### Parameters

#### $q

`boolean`

## Sets the wrapper object this task should use for runtime configurable elements.

    setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)

Inherited

inherited_from | \Task::setRuntimeConfigurableWrapper()

### Parameters

#### $wrapper

`\RuntimeConfigurable`

The wrapper object this task should use

## The tag of the package/module to operate upon.

    setTag(string $p)

### Parameters

#### $p

`string`

## Sets the name of this task for log messages

    setTaskName(string $name) : string

Inherited

inherited_from | \Task::setTaskName()

### Parameters

#### $name

`string`

### Returns

`string`A string representing the name of this task for log

## Sets the type of the task.

    setTaskType(string $name)

Inherited

Usually this is the name of the XML tag

inherited_from | \Task::setTaskType()

### Parameters

#### $name

`string`

The type of this task (XML Tag)

## Configure a commandline element for things like cvsRoot, quiet, etc.

    configureCommandline($c) : string

### Parameters

#### $c

### Returns

`string`

## Returns a name

    getRegisterSlot(string $slotName)

Inherited

inherited_from | \Task::getRegisterSlot()

### Parameters

#### $slotName

`string`

## removeCommandline()

    removeCommandline(\Commandline $c)

### Parameters

#### $c

## Sets up the environment for toExecute and then runs it.

    runCommand(\Commandline $toExecute)

### Parameters

#### $toExecute

`\Commandline`

### Exceptions

`\BuildException` |

### Properties

##

    $description : string

Inherited

inherited_from | \Task::$$description

##

    $location : \Location

Inherited

inherited_from | \Task::$$location

##

    $project : \Project

Inherited

inherited_from | \ProjectComponent::$$project
inherited_from | \Task::$$project

##

    $target : \Target

Inherited

inherited_from | \Task::$$target

##

    $taskName : string

Inherited

inherited_from | \Task::$$taskName

##

    $taskType : string

Inherited

inherited_from | \Task::$$taskType

##

    $wrapper : \RuntimeConfigurable

Inherited

inherited_from | \Task::$$wrapper

##

    $cmd

##

    $command

##

    $commandlines : array

##

    $compression

##

    $cvsModule

##

    $cvsRoot

##

    $cvsRsh

##

    $default_command

##

    $dest : \File

##

    $error

##

    $failOnError : boolean

Default is false. (Iulian)

##

    $noexec

##

    $output

##

    $passFile : \File

##

    $port

##

    $quiet

### Constants

## Default compression level to use, if compression is enabled via setCompression( true ).

    DEFAULT_COMPRESSION_LEVEL