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

Class CCMklbtype

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.clearcase.ClearCase
org.apache.tools.ant.taskdefs.optional.clearcase.CCMklbtype
All Implemented Interfaces:
Cloneable
public class CCMklbtype extends ClearCase
Task to perform mklbtype command to ClearCase.

The following attributes are interpreted:

Task attributes
Attribute Values Required
typename Name of the label type to create Yes
vob Name of the VOB No
replace Replace an existing label definition of the same type No
global Either global or ordinary can be specified, not both. Creates a label type that is global to the VOB or to VOBs that use this VOB No
ordinary Either global or ordinary can be specified, not both. Creates a label type that can be used only in the current VOB. Default No
pbranch Allows the label type to be used once per branch in a given element's version tree No
shared Sets the way mastership is checked by ClearCase. See ClearCase documentation for details 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
failonerr Throw an exception if the command fails. Default is true No

  • Field Details

    • FLAG_REPLACE

      public static final String FLAG_REPLACE
      -replace flag -- replace existing label definition of the same type
      See Also:

    • FLAG_GLOBAL

      public static final String FLAG_GLOBAL
      -global flag -- creates a label type that is global to the VOB or to VOBs that use this VOB
      See Also:

    • FLAG_ORDINARY

      public static final String FLAG_ORDINARY
      -ordinary flag -- creates a label type that can be used only in the current VOB
      See Also:

    • FLAG_PBRANCH

      public static final String FLAG_PBRANCH
      -pbranch flag -- allows label type to be used once per branch
      See Also:

    • FLAG_SHARED

      public static final String FLAG_SHARED
      -shared flag -- sets the way mastership is checked by ClearCase
      See Also:

    • FLAG_COMMENT

      public static final String FLAG_COMMENT
      -c flag -- comment to attach to the file
      See Also:

    • FLAG_COMMENTFILE

      public static final String FLAG_COMMENTFILE
      -cfile flag -- file containing a comment to attach to the file
      See Also:

    • FLAG_NOCOMMENT

      public static final String FLAG_NOCOMMENT
      -nc flag -- no comment is specified
      See Also:

  • Constructor Details

    • CCMklbtype

      public CCMklbtype()

  • 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

    • setTypeName

      public void setTypeName(String tn)
      Set type-name string
      Parameters:
      tn - the type-name string

    • getTypeName

      public String getTypeName()
      Get type-name string
      Returns:
      String containing the type-name

    • setVOB

      public void setVOB(String vob)
      Set the VOB name
      Parameters:
      vob - the VOB name

    • getVOB

      public String getVOB()
      Get VOB name
      Returns:
      String containing VOB name

    • setReplace

      public void setReplace(boolean repl)
      Set the replace flag
      Parameters:
      repl - the status to set the flag to

    • getReplace

      public boolean getReplace()
      Get replace flag status
      Returns:
      boolean containing status of replace flag

    • setGlobal

      public void setGlobal(boolean glob)
      Set the global flag
      Parameters:
      glob - the status to set the flag to

    • getGlobal

      public boolean getGlobal()
      Get global flag status
      Returns:
      boolean containing status of global flag

    • setOrdinary

      public void setOrdinary(boolean ordinary)
      Set the ordinary flag
      Parameters:
      ordinary - the status to set the flag to

    • getOrdinary

      public boolean getOrdinary()
      Get ordinary flag status
      Returns:
      boolean containing status of ordinary flag

    • setPbranch

      public void setPbranch(boolean pbranch)
      Set the pbranch flag
      Parameters:
      pbranch - the status to set the flag to

    • getPbranch

      public boolean getPbranch()
      Get pbranch flag status
      Returns:
      boolean containing status of pbranch flag

    • setShared

      public void setShared(boolean shared)
      Set the shared flag
      Parameters:
      shared - the status to set the flag to

    • getShared

      public boolean getShared()
      Get shared flag status
      Returns:
      boolean containing status of shared flag

    • setComment

      public void setComment(String comment)
      Set 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)
      Set comment file
      Parameters:
      cfile - the path to the comment file

    • getCommentFile

      public String getCommentFile()
      Get comment file
      Returns:
      String containing the path to the comment file