Class CCRmtype

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class CCRmtype
    extends ClearCase
    Task to perform rmtype command to ClearCase.

    The following attributes are interpreted:

    Task attributes
    Attribute Values Required
    typekind The kind of type to create. Valid types are:
    attype attribute type
    brtype branch type
    eltype element type
    hltype hyperlink type
    lbtype label type
    trtype trigger type
    Yes
    typename The name of the type to remove Yes
    vob Name of the VOB No
    ignore Used with trigger types only. Forces removal of trigger type even if a pre-operation trigger would prevent its removal No
    rmall Removes all instances of a type and the type object itself 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 Detail

      • FLAG_IGNORE

        public static final java.lang.String FLAG_IGNORE
        -ignore flag -- ignore pre-trigger operations when removing a trigger type
        See Also:
        Constant Field Values
      • FLAG_RMALL

        public static final java.lang.String FLAG_RMALL
        -rmall flag -- removes all instances of a type and the type object itself
        See Also:
        Constant Field Values
      • FLAG_FORCE

        public static final java.lang.String FLAG_FORCE
        -force flag -- suppresses confirmation prompts
        See Also:
        Constant Field Values
      • FLAG_COMMENT

        public static final java.lang.String FLAG_COMMENT
        -c flag -- comment to attach to the file
        See Also:
        Constant Field Values
      • FLAG_COMMENTFILE

        public static final java.lang.String FLAG_COMMENTFILE
        -cfile flag -- file containing a comment to attach to the file
        See Also:
        Constant Field Values
      • FLAG_NOCOMMENT

        public static final java.lang.String FLAG_NOCOMMENT
        -nc flag -- no comment is specified
        See Also:
        Constant Field Values
    • Constructor Detail

      • CCRmtype

        public CCRmtype()
    • Method Detail

      • 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
      • setIgnore

        public void setIgnore​(boolean ignore)
        Set the ignore flag
        Parameters:
        ignore - the status to set the flag to
      • getIgnore

        public boolean getIgnore()
        Get ignore flag status
        Returns:
        boolean containing status of ignore flag
      • setRmAll

        public void setRmAll​(boolean rmall)
        Set rmall flag
        Parameters:
        rmall - the status to set the flag to
      • getRmAll

        public boolean getRmAll()
        Get rmall flag status
        Returns:
        boolean containing status of rmall flag
      • setComment

        public void setComment​(java.lang.String comment)
        Set comment string
        Parameters:
        comment - the comment string
      • getComment

        public java.lang.String getComment()
        Get comment string
        Returns:
        String containing the comment
      • setCommentFile

        public void setCommentFile​(java.lang.String cfile)
        Set comment file
        Parameters:
        cfile - the path to the comment file
      • getCommentFile

        public java.lang.String getCommentFile()
        Get comment file
        Returns:
        String containing the path to the comment file
      • setTypeKind

        public void setTypeKind​(java.lang.String tk)
        Set type-kind string
        Parameters:
        tk - the type-kind string
      • getTypeKind

        public java.lang.String getTypeKind()
        Get type-kind string
        Returns:
        String containing the type-kind
      • setTypeName

        public void setTypeName​(java.lang.String tn)
        Set type-name string
        Parameters:
        tn - the type-name string
      • getTypeName

        public java.lang.String getTypeName()
        Get type-name string
        Returns:
        String containing the type-name
      • setVOB

        public void setVOB​(java.lang.String vob)
        Set the VOB name
        Parameters:
        vob - the VOB name
      • getVOB

        public java.lang.String getVOB()
        Get VOB name
        Returns:
        String containing VOB name