org.apache.tools.ant.taskdefs.optional.clearcase.CCCheckout

All Implemented Interfaces:: Cloneable

public class CCCheckout extends ClearCase

Performs ClearCase checkout.

The following attributes are interpreted:

Task attributes
Attribute	Values	Required
viewpath	Path to the ClearCase view file or directory that the command will operate on	No
reserved	Specifies whether to check out the file as reserved or not	Yes
out	Creates a writable file under a different filename	No
nodata	Checks out the file but does not create an editable file containing its data	No
branch	Specify a branch to check out the file to	No
version	Allows checkout of a version other than main latest	No
nowarn	Suppress warning messages	No
comment	Specify a comment. Only one of comment or cfile may be used.	No
commentfile	Specify a file containing a comment. Only one of comment or cfile may be used.	No
notco	Fail if it's already checked out to the current view. Set to false to ignore it.	No
failonerr	Throw an exception if the command fails. Default is true	No

Field Summary

Fields

Modifier and Type

Field

Description

static final String

FLAG_BRANCH

-branch flag -- checks out the file on a specified branch

static final String

FLAG_COMMENT

-c flag -- comment to attach to the file

static final String

FLAG_COMMENTFILE

-cfile flag -- file containing a comment to attach to the file

static final String

FLAG_NOCOMMENT

-nc flag -- no comment is specified

static final String

FLAG_NODATA

-ndata flag -- checks out the file but does not create an editable file containing its data

static final String

FLAG_NOWARN

-nwarn flag -- suppresses warning messages

static final String

FLAG_OUT

-out flag -- create a writable file under a different filename

static final String

FLAG_RESERVED

-reserved flag -- check out the file as reserved

static final String

FLAG_UNRESERVED

-reserved flag -- check out the file as unreserved

static final String

FLAG_VERSION

-version flag -- allows checkout of a version that is not main latest

Fields inherited from class ClearCase
COMMAND_CHECKIN, COMMAND_CHECKOUT, COMMAND_LOCK, COMMAND_LSCO, COMMAND_MKATTR, COMMAND_MKBL, COMMAND_MKDIR, COMMAND_MKELEM, COMMAND_MKLABEL, COMMAND_MKLBTYPE, COMMAND_RMTYPE, COMMAND_UNCHECKOUT, COMMAND_UNLOCK, COMMAND_UPDATE

Modifier and Type

Field

Description

static final String

COMMAND_CHECKIN

The 'Checkin' command

static final String

COMMAND_CHECKOUT

The 'Checkout' command

static final String

COMMAND_LOCK

The 'Lock' command

static final String

COMMAND_LSCO

The 'LsCheckout' command

static final String

COMMAND_MKATTR

The 'Mkattr' command

static final String

COMMAND_MKBL

The 'Mkbl' command

static final String

COMMAND_MKDIR

The 'Mkdir' command

static final String

COMMAND_MKELEM

The 'Mkelem' command

static final String

COMMAND_MKLABEL

The 'Mklabel' command

static final String

COMMAND_MKLBTYPE

The 'Mklbtype' command

static final String

COMMAND_RMTYPE

The 'Rmtype' command

static final String

COMMAND_UNCHECKOUT

The 'UndoCheckout' command

static final String

COMMAND_UNLOCK

The 'Unlock' command

static final String

COMMAND_UPDATE

The 'Update' command

Fields inherited from class Task
target, taskName, taskType, wrapper

Modifier and Type

Field

Description

protected Target

target

Deprecated.
since 1.6.x.

protected String

taskName

Deprecated.
since 1.6.x.

protected String

taskType

Deprecated.
since 1.6.x.

protected RuntimeConfigurable

wrapper

Deprecated.
since 1.6.x.

Fields inherited from class ProjectComponent
description, location, project

Modifier and Type

Field

Description

protected String

description

Deprecated.
since 1.6.x.

protected Location

location

Deprecated.
since 1.6.x.

protected Project

project

Deprecated.
since 1.6.x.
Constructor Summary

Constructors

Constructor

Description

CCCheckout()
Method Summary

Modifier and Type

Method

Description

void

execute()

Executes the task.

String

getBranch()

Get branch name

String

getComment()

Get comment string

String

getCommentFile()

Get comment file

boolean

getNoData()

Get nodata flag status

boolean

getNotco()

Get notco flag status

boolean

getNoWarn()

Get nowarn flag status

String

getOut()

Get out file

boolean

getReserved()

Get reserved flag status

boolean

getVersion()

Get version flag status

void

setBranch(String branch)

Specify a branch to check out the file to.

void

setComment(String comment)

Sets the comment string.

void

setCommentFile(String cfile)

Specifies a file containing a comment.

void

setNoData(boolean ndata)

If true, checks out the file but does not create an editable file containing its data.

void

setNotco(boolean notco)

If true, checkout fails if the element is already checked out to the current view.

void

setNoWarn(boolean nwarn)

If true, warning messages are suppressed.

void

setOut(String outf)

Creates a writable file under a different filename.

void

setReserved(boolean reserved)

If true, checks out the file as reserved.

void

setVersion(boolean version)

If true, allows checkout of a version other than main latest.

Methods inherited from class ClearCase
getClearToolCommand, getFailOnErr, getObjSelect, getViewPath, getViewPathBasename, run, runS, runS, setClearToolDir, setFailOnErr, setObjSelect, setViewPath

Modifier and Type

Method

Description

protected final String

getClearToolCommand()

Builds and returns the command string to execute cleartool

boolean

getFailOnErr()

Get failonerr flag status

String

getObjSelect()

Get the object to operate on

String

getViewPath()

Get the path to the item in a clearcase view

String

getViewPathBasename()

Get the basename path of the item in a clearcase view

protected int

run(Commandline cmd)

Execute the given command are return success or failure

protected String

runS(Commandline cmdline)

Deprecated.
use the two arg version instead

protected String

runS(Commandline cmdline, boolean failOnError)

Execute the given command, and return it's output

final void

setClearToolDir(String dir)

Set the directory where the cleartool executable is located.

void

setFailOnErr(boolean failonerr)

If true, command will throw an exception on failure.

final void

setObjSelect(String objSelect)

Set the object to operate on.

final void

setViewPath(String viewPath)

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

Methods inherited from class Task
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type

Method

Description

final void

bindToOwner(Task owner)

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

Target

getOwningTarget()

Returns the container target of this task.

RuntimeConfigurable

getRuntimeConfigurableWrapper()

Returns the wrapper used for runtime configuration.

String

getTaskName()

Returns the name to use in logging messages.

String

getTaskType()

Return the type of task.

protected RuntimeConfigurable

getWrapper()

Return the runtime configurable structure for this task.

protected void

handleErrorFlush(String output)

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

protected void

handleErrorOutput(String output)

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

protected void

handleFlush(String output)

Handles output by logging it with the INFO priority.

protected int

handleInput(byte[] buffer, int offset, int length)

Handle an input request by this task.

protected void

handleOutput(String output)

Handles output by logging it with the INFO priority.

void

init()

Called by the project to let the task initialize properly.

protected final boolean

isInvalid()

Has this task been marked invalid?

void

log(String msg)

Logs a message with the default (INFO) priority.

void

log(String msg, int msgLevel)

Logs a message with the given priority.

void

log(String msg, Throwable t, int msgLevel)

Logs a message with the given priority.

void

log(Throwable t, int msgLevel)

Logs a message with the given priority.

void

maybeConfigure()

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

final void

perform()

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

void

reconfigure()

Force the task to be reconfigured from its RuntimeConfigurable.

void

setOwningTarget(Target target)

Sets the target container of this task.

void

setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)

Sets the wrapper to be used for runtime configuration.

void

setTaskName(String name)

Sets the name to use in logging messages.

void

setTaskType(String type)

Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type

Method

Description

Object

clone()

String

getDescription()

Returns the description of the current action.

Location

getLocation()

Returns the file/location where this task was defined.

Project

getProject()

Returns the project to which this component belongs.

void

setDescription(String desc)

Sets a description of the current action.

void

setLocation(Location location)

Sets the file/location where this task was defined.

void

setProject(Project project)

Sets the project object of this component.

Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- FLAG_RESERVED
  public static final String FLAG_RESERVED
  
  -reserved flag -- check out the file as reserved
  
  See Also:
  
  Constant Field Values
- FLAG_UNRESERVED
  public static final String FLAG_UNRESERVED
  
  -reserved flag -- check out the file as unreserved
  
  See Also:
  
  Constant Field Values
- FLAG_OUT
  public static final String FLAG_OUT
  
  -out flag -- create a writable file under a different filename
  
  See Also:
  
  Constant Field Values
- FLAG_NODATA
  public static final String FLAG_NODATA
  
  -ndata flag -- checks out the file but does not create an editable file containing its data
  
  See Also:
  
  Constant Field Values
- FLAG_BRANCH
  public static final String FLAG_BRANCH
  
  -branch flag -- checks out the file on a specified branch
  
  See Also:
  
  Constant Field Values
- FLAG_VERSION
  public static final String FLAG_VERSION
  
  -version flag -- allows checkout of a version that is not main latest
  
  See Also:
  
  Constant Field Values
- FLAG_NOWARN
  public static final String FLAG_NOWARN
  
  -nwarn flag -- suppresses warning messages
  
  See Also:
  
  Constant Field Values
- FLAG_COMMENT
  public static final String FLAG_COMMENT
  
  -c flag -- comment to attach to the file
  
  See Also:
  
  Constant Field Values
- FLAG_COMMENTFILE
  public static final String FLAG_COMMENTFILE
  
  -cfile flag -- file containing a comment to attach to the file
  
  See Also:
  
  Constant Field Values
- FLAG_NOCOMMENT
  public static final String FLAG_NOCOMMENT
  
  -nc flag -- no comment is specified
  
  See Also:
  
  Constant Field Values
Constructor Details
- CCCheckout
  
  public CCCheckout()
Method Details
- execute
  
  public void execute() throws BuildException
  
  Executes the task.
  Builds a command line to execute cleartool and then calls Exec's run method to execute the command line.
  
  Overrides:
  
  execute in class Task
  
  Throws:
  
  BuildException - if the command fails and failonerr is set to true
- setReserved
  
  public void setReserved(boolean reserved)
  
  If true, checks out the file as reserved.
  
  Parameters:
  
  reserved - the status to set the flag to
- getReserved
  
  public boolean getReserved()
  
  Get reserved flag status
  
  Returns:
  
  boolean containing status of reserved flag
- setNotco
  
  public void setNotco(boolean notco)
  
  If true, checkout fails if the element is already checked out to the current view.
  
  Parameters:
  
  notco - the status to set the flag to
  
  Since:
  
  ant 1.6.1
- getNotco
  
  public boolean getNotco()
  
  Get notco flag status
  
  Returns:
  
  boolean containing status of notco flag
  
  Since:
  
  ant 1.6.1
- setOut
  
  public void setOut(String outf)
  
  Creates a writable file under a different filename.
  
  Parameters:
  
  outf - the path to the out file
- getOut
  
  public String getOut()
  
  Get out file
  
  Returns:
  
  String containing the path to the out file
- setNoData
  
  public void setNoData(boolean ndata)
  
  If true, checks out the file but does not create an editable file containing its data.
  
  Parameters:
  
  ndata - the status to set the flag to
- getNoData
  
  public boolean getNoData()
  
  Get nodata flag status
  
  Returns:
  
  boolean containing status of ndata flag
- setBranch
  
  public void setBranch(String branch)
  
  Specify a branch to check out the file to.
  
  Parameters:
  
  branch - the name of the branch
- getBranch
  
  public String getBranch()
  
  Get branch name
  
  Returns:
  
  String containing the name of the branch
- setVersion
  
  public void setVersion(boolean version)
  
  If true, allows checkout of a version other than main latest.
  
  Parameters:
  
  version - the status to set the flag to
- getVersion
  
  public boolean getVersion()
  
  Get version flag status
  
  Returns:
  
  boolean containing status of version flag
- setNoWarn
  
  public void setNoWarn(boolean nwarn)
  
  If true, warning messages are suppressed.
  
  Parameters:
  
  nwarn - the status to set the flag to
- getNoWarn
  
  public boolean getNoWarn()
  
  Get nowarn flag status
  
  Returns:
  
  boolean containing status of nwarn flag
- setComment
  
  public void setComment(String comment)
  
  Sets the comment string.
  
  Parameters:
  
  comment - the comment string
- getComment
  
  public String getComment()
  
  Get comment string
  
  Returns:
  
  String containing the comment
- setCommentFile
  
  public void setCommentFile(String cfile)
  
  Specifies a file containing a comment.
  
  Parameters:
  
  cfile - the path to the comment file
- getCommentFile
  
  public String getCommentFile()
  
  Get comment file
  
  Returns:
  
  String containing the path to the comment file

Class CCCheckout

Field Summary

Fields inherited from class ClearCase

Fields inherited from class Task

Fields inherited from class ProjectComponent

Constructor Summary

Method Summary

Methods inherited from class ClearCase

Methods inherited from class Task

Methods inherited from class ProjectComponent

Methods inherited from class Object

Field Details

FLAG_RESERVED

FLAG_UNRESERVED

FLAG_OUT

FLAG_NODATA

FLAG_BRANCH

FLAG_VERSION

FLAG_NOWARN

FLAG_COMMENT

FLAG_COMMENTFILE

FLAG_NOCOMMENT

Constructor Details

CCCheckout

Method Details

execute

setReserved

getReserved

setNotco

getNotco

setOut

getOut

setNoData

getNoData

setBranch

getBranch

setVersion

getVersion

setNoWarn

getNoWarn

setComment

getComment

setCommentFile

getCommentFile