SOS Apache Ant 1.7.1)

Methods

Hide/Show inherited methods

publicfinal void bindToOwner (Task owner) [Inherited From Task]

Bind a task to another; use this when configuring a newly created task to do work on behalf of another.

pack-privateabstract Commandline buildCmdLine ()

Subclasses implement the logic required to construct the command line.

public java.lang.Object clone () throws java.lang.CloneNotSupportedException [Inherited From ProjectComponent]

public void execute () throws BuildException [Overrides Task]

Execute the created command line.

protected java.lang.String getComment ()

Get the comment

public java.lang.String getDescription () [Inherited From ProjectComponent]

Returns the description of the current action.

Returns the description of the current action.
Returns: the description of the current action, or null if no description is available.

protected java.lang.String getFilename ()

Get the filename to be acted upon.

protected java.lang.String getLabel ()

Get the label

protected java.lang.String getLocalPath ()

Builds and returns the working directory.

public Location getLocation () [Inherited From ProjectComponent]

Returns the file/location where this task was defined.

Returns the file/location where this task was defined.
Returns: the file/location where this task was defined. Should not return null. Location.UNKNOWN_LOCATION is used for unknown locations.
See Also: Location.UNKNOWN_LOCATION,

protected java.lang.String getNoCache ()

Get the NoCache flag.

protected java.lang.String getNoCompress ()

Get the NoCompress flag.

protected void getOptionalAttributes ()

Adds the optional attributes to the command line.

public Target getOwningTarget () [Inherited From Task]

Returns the container target of this task.

Returns the container target of this task.
Returns: The target containing this task, or null if this task is a top-level task.

protected java.lang.String getPassword ()

Get the password

public Project getProject () [Inherited From ProjectComponent]

Returns the project to which this component belongs.

protected java.lang.String getProjectPath ()

Get the project path

protected java.lang.String getRecursive ()

Get the 'recursive' Flag.

protected void getRequiredAttributes ()

Sets the executable and add the required attributes to the command line.

public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]

Returns the wrapper used for runtime configuration.

protected java.lang.String getSosCommand ()

Get the executable to run.

protected java.lang.String getSosHome ()

Get the SOS home directory.

protected java.lang.String getSosServerPath ()

Get the SOS serve path.

public java.lang.String getTaskName () [Inherited From Task]

Returns the name to use in logging messages.

public java.lang.String getTaskType () [Inherited From Task]

Return the type of task.

protected java.lang.String getUsername ()

Get the username

protected java.lang.String getVerbose ()

Get the 'verbose' Flag.

protected java.lang.String getVersion ()

Get the version

protected java.lang.String getVssServerPath ()

Get the VSS server path

protected RuntimeConfigurable getWrapper () [Inherited From Task]

Return the runtime configurable structure for this task.

protected void handleErrorFlush (java.lang.String output) [Inherited From Task]

Handles an error line by logging it with the WARN priority.

Handles an error line by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.
Since: Ant 1.5.2

protected void handleErrorOutput (java.lang.String output) [Inherited From Task]

Handles an error output by logging it with the WARN priority.

Handles an error output by logging it with the WARN priority.
Parameters:
- output - The error output to log. Should not be null.

protected void handleFlush (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.
Since: Ant 1.5.2

protected int handleInput (byte[] buffer, int offset, int length) throws java.io.IOException [Inherited From Task]

Handle an input request by this task.

protected void handleOutput (java.lang.String output) [Inherited From Task]

Handles output by logging it with the INFO priority.

Handles output by logging it with the INFO priority.
Parameters:
- output - The output to log. Should not be null.

public void init () throws BuildException [Inherited From Task]

Called by the project to let the task initialize properly.

protectedfinal boolean isInvalid () [Inherited From Task]

Has this task been marked invalid?

public void log (java.lang.String msg) [Inherited From Task]

Logs a message with the default (INFO) priority.

Logs a message with the default (INFO) priority.
Parameters:
- msg - The message to be logged. Should not be null.

public void log (java.lang.String msg, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.

public void log (java.lang.String msg, java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- msg - The message to be logged. Should not be null.
- t - The exception to be logged. May be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void log (java.lang.Throwable t, int msgLevel) [Inherited From Task]

Logs a message with the given priority.

Logs a message with the given priority. This delegates
the actual logging to the project.
Parameters:
- t - The exception to be logged. Should not be null.
- msgLevel - The message priority at which this message is to be logged.
Since: 1.7

public void maybeConfigure () throws BuildException [Inherited From Task]

Configures this task - if it hasn't been done already.

publicfinal void perform () [Inherited From Task]

Performs this task if it's still valid, or gets a replacement version and performs that otherwise.

public void reconfigure () [Inherited From Task]

Force the task to be reconfigured from its RuntimeConfigurable.

protected int run (Commandline cmd)

Execute the created command line.

public void setDescription (java.lang.String desc) [Inherited From ProjectComponent]

Sets a description of the current action.

Sets a description of the current action. This may be used for logging
purposes.
Parameters:
- desc - Description of the current action. May be null, indicating that no description is available.

protected void setInternalComment (java.lang.String text)

Set the comment text.

protected void setInternalFilename (java.lang.String file)

Set the file name.

protected void setInternalLabel (java.lang.String text)

Set the label.

protected void setInternalRecursive (boolean recurse)

Set the recursive flag.

protected void setInternalVersion (java.lang.String text)

Set the version.

publicfinal void setLocalPath (Path path)

Override the working directory and get to the specified path.

public void setLocation (Location location) [Inherited From ProjectComponent]

Sets the file/location where this task was defined.

Sets the file/location where this task was defined.
Parameters:
- location - The file/location where this task was defined. Should not be null--use Location.UNKNOWN_LOCATION if the location isn't known.
See Also: Location.UNKNOWN_LOCATION,

publicfinal void setNoCache (boolean nocache)

Flag to disable the cache when set.

publicfinal void setNoCompress (boolean nocompress)

Flag to disable compression when set.

public void setOwningTarget (Target target) [Inherited From Task]

Sets the target container of this task.

Sets the target container of this task.
Parameters:
- target - Target in whose scope this task belongs. May be null, indicating a top-level task.

publicfinal void setPassword (java.lang.String password)

The SourceSafe password.

public void setProject (Project project) [Inherited From ProjectComponent]

Sets the project object of this component.

Sets the project object of this component. This method is used by
Project when a component is added to it so that the component has
access to the functions of the project. It should not be used
for any other purpose.
Parameters:
- project - Project in whose scope this component belongs. Must not be null.

publicfinal void setProjectPath (java.lang.String projectpath)

The SourceSafe project path.

public void setRuntimeConfigurableWrapper (RuntimeConfigurable wrapper) [Inherited From Task]

Sets the wrapper to be used for runtime configuration.

Sets the wrapper to be used for runtime configuration.

This method should be used only by the ProjectHelper and Ant internals.
It is public to allow helper plugins to operate on tasks, normal tasks
should never use it.
Parameters:
- wrapper - The wrapper to be used for runtime configuration. May be null, in which case the next call to getRuntimeConfigurableWrapper will generate a new wrapper.

publicfinal void setSosCmd (java.lang.String dir)

The directory where soscmd(.exe) is located.

publicfinal void setSosHome (java.lang.String sosHome)

Path to the SourceOffSite home directory.

publicfinal void setSosServerPath (java.lang.String sosServerPath)

The address and port of SourceOffSite Server, for example 192.168.0.1:8888.

public void setTaskName (java.lang.String name) [Inherited From Task]

Sets the name to use in logging messages.

Sets the name to use in logging messages.
Parameters:
- name - The name to use in logging messages. Should not be null.

public void setTaskType (java.lang.String type) [Inherited From Task]

Sets the name with which the task has been invoked.

Sets the name with which the task has been invoked.
Parameters:
- type - The name the task has been invoked as. Should not be null.

publicfinal void setUsername (java.lang.String username)

The SourceSafe username.

public void setVerbose (boolean verbose)

Enable verbose output.

publicfinal void setVssServerPath (java.lang.String vssServerPath)

The path to the location of the ss.ini file.

Fields

Hide/Show inherited fields

publicfinalstatic java.lang.String COMMAND_CHECKIN_FILE = "CheckInFile" [Inherited From SOSCmd]

The checkin file command

publicfinalstatic java.lang.String COMMAND_CHECKIN_PROJECT = "CheckInProject" [Inherited From SOSCmd]

The checkin project command

publicfinalstatic java.lang.String COMMAND_CHECKOUT_FILE = "CheckOutFile" [Inherited From SOSCmd]

The checkout file command

publicfinalstatic java.lang.String COMMAND_CHECKOUT_PROJECT = "CheckOutProject" [Inherited From SOSCmd]

The checkout project command

publicfinalstatic java.lang.String COMMAND_GET_FILE = "GetFile" [Inherited From SOSCmd]

The get file command

publicfinalstatic java.lang.String COMMAND_GET_PROJECT = "GetProject" [Inherited From SOSCmd]

The get project command

publicfinalstatic java.lang.String COMMAND_HISTORY = "GetFileHistory" [Inherited From SOSCmd]

The get history command

publicfinalstatic java.lang.String COMMAND_LABEL = "AddLabel" [Inherited From SOSCmd]

The add label command

publicfinalstatic java.lang.String COMMAND_SOS_EXE = "soscmd" [Inherited From SOSCmd]

The sos executable

protected Commandline commandLine

Commandline to be executed.

protected ~~java.lang.String description~~ [Inherited From ProjectComponent]

Description of this component, if any.

publicfinalstatic java.lang.String FLAG_COMMAND = "-command" [Inherited From SOSCmd]

The command option

publicfinalstatic java.lang.String FLAG_COMMENT = "-log" [Inherited From SOSCmd]

The log option

publicfinalstatic java.lang.String FLAG_FILE = "-file" [Inherited From SOSCmd]

The file option

publicfinalstatic java.lang.String FLAG_LABEL = "-label" [Inherited From SOSCmd]

The label option

publicfinalstatic java.lang.String FLAG_NO_CACHE = "-nocache" [Inherited From SOSCmd]

The no cache option

publicfinalstatic java.lang.String FLAG_NO_COMPRESSION = "-nocompress" [Inherited From SOSCmd]

The no compression option

publicfinalstatic java.lang.String FLAG_PASSWORD = "-password" [Inherited From SOSCmd]

The password option

publicfinalstatic java.lang.String FLAG_PROJECT = "-project" [Inherited From SOSCmd]

The project option

publicfinalstatic java.lang.String FLAG_RECURSION = "-recursive" [Inherited From SOSCmd]

The recursive option

publicfinalstatic java.lang.String FLAG_SOS_HOME = "-soshome" [Inherited From SOSCmd]

The sos home option

publicfinalstatic java.lang.String FLAG_SOS_SERVER = "-server" [Inherited From SOSCmd]

The server option

publicfinalstatic java.lang.String FLAG_USERNAME = "-name" [Inherited From SOSCmd]

The username option

publicfinalstatic java.lang.String FLAG_VERBOSE = "-verbose" [Inherited From SOSCmd]

The verbose option

publicfinalstatic java.lang.String FLAG_VERSION = "-revision" [Inherited From SOSCmd]

The revision option

publicfinalstatic java.lang.String FLAG_VSS_SERVER = "-database" [Inherited From SOSCmd]

The database (vss server) option

publicfinalstatic java.lang.String FLAG_WORKING_DIR = "-workdir" [Inherited From SOSCmd]

The workdir option

protected ~~Location location~~ [Inherited From ProjectComponent]

Location within the build file of this task definition.

protected ~~Project project~~ [Inherited From ProjectComponent]

Project object of this component.

publicfinalstatic java.lang.String PROJECT_PREFIX = "$" [Inherited From SOSCmd]

The project prefix

protected ~~Target target~~ [Inherited From Task]

Target this task belongs to, if any.

protected ~~java.lang.String taskName~~ [Inherited From Task]

Name of this task to be used for logging purposes.

protected ~~java.lang.String taskType~~ [Inherited From Task]

Type of this task.

protected ~~RuntimeConfigurable wrapper~~ [Inherited From Task]

Wrapper for this object, used to configure it at runtime.