CCUnlock Apache Ant 1.7.1)

Attribute	Values	Required
comment	Specifies how to populate comments fields	No
pname	Specifies the object pathname to be unlocked.	No
objselect	This variable is obsolete. Should use objsel instead.	no
objsel	Specifies the object(s) to be unlocked.	No
failonerr	Throw an exception if the command fails. Default is true	No

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.

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

public void execute () throws BuildException [Overrides Task]

Executes the task.

protectedfinal java.lang.String getClearToolCommand () [Inherited From ClearCase]

Builds and returns the command string to execute cleartool

public java.lang.String getComment ()

Get comment method

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.

public boolean getFailOnErr () [Inherited From ClearCase]

Get failonerr flag status

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,

public java.lang.String getObjselect ()

Get list of objects to be locked

public java.lang.String getObjSelect () [Inherited From ClearCase]

Get the object to operate on

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.

public java.lang.String getPname ()

Get the pathname to be locked

public Project getProject () [Inherited From ProjectComponent]

Returns the project to which this component belongs.

public RuntimeConfigurable getRuntimeConfigurableWrapper () [Inherited From Task]

Returns the wrapper used for runtime configuration.

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.

public java.lang.String getViewPath () [Inherited From ClearCase]

Get the path to the item in a clearcase view

public java.lang.String getViewPathBasename () [Inherited From ClearCase]

Get the basename path of the item in a clearcase view

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) [Inherited From ClearCase]

Execute the given command are return success or failure

Execute the given command are return success or failure
Returns: the exit status of the subprocess or INVALID
Parameters:
- cmd - command line to execute

protected java.lang.String runS (Commandline cmdline) [Inherited From ClearCase]

Execute the given command, and return it's output

publicfinal void setClearToolDir (java.lang.String dir) [Inherited From ClearCase]

Set the directory where the cleartool executable is located.

public void setComment (java.lang.String comment)

Sets how comments should be written for the event record(s)

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.

public void setFailOnErr (boolean failonerr) [Inherited From ClearCase]

If true, command will throw an exception on failure.

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,

public void setObjSel (java.lang.String objsel)

Sets the object(s) to be locked

public void setObjselect (java.lang.String objselect)

Sets the object(s) to be locked

publicfinal void setObjSelect (java.lang.String objSelect) [Inherited From ClearCase]

Set the object to operate on.

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.

public void setPname (java.lang.String pname)

Sets the pathname to be locked

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.

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.

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 setViewPath (java.lang.String viewPath) [Inherited From ClearCase]

Set the path to the item in a ClearCase view to operate on.