# TreeBasedTask

[This is preliminary documentation and subject to change.]

Base for tree based star team tasks.

Abstracts tree-walking behavior common to many subtasks.

This class provides tree iteration functionality. Derived classes will implement their specific task functionally using the visitor pattern, specifically by implementing the method visit

This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html

You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.

### Parameters

Attribute | Type | Description | Required
--- | --- | --- | ---
rootstarteamfolder | string | Root StarTeam folder to begin operations on. Defaults to the root of the view. | True
excludes | string | Accepts comma de-limited list of expressions to exclude from tree operations. If nothing is specified. NO filespecs are excluded. | False
forced | bool | Default : false - force check in/out actions regardless of the status that StarTeam is maintaining for the file. | False
includes | string | Accepts comma de-limited list of expressions to include in tree operations. If nothing is set ALL filespecs are included. | False
label | string | Label used for checkout. If no label is set latest state of repository is checked out. | False
recursive | bool | Default : true - should tasks recurse through tree. | False
failonerror | bool | Determines if task failure stops the build, or is just reported. The default is true. | False
if | bool | If true then the task will be executed; otherwise, skipped. The default is true. | False
password | string | The password used for login. | False
projectname | string | The name of the StarTeam project to be acted on | False
servername | string | Name of StarTeamServer. | False
serverport | string | Port number of the StarTeam connection. | False
unless | bool | Opposite of `if`. If false then the task will be executed; otherwise, skipped. The default is false. | False
url | string | One stop to set all parameters needed to connect to a StarTeam server. | False
username | string | The StarTeam user name used for login. | False
verbose | bool | Determines whether the task should report detailed build log messages. The default is false. | False
viewname | string | The name of the StarTeam view to be acted on. | False

### Requirements

Assembly: NAnt.Contrib.Tasks (0.93.5002.0)