Class RemoveLinkedComponentTask

  • All Implemented Interfaces:
    SubTask

    public class RemoveLinkedComponentTask
    extends AbstractBaseTask

    A Rhino management sub task for removing a virtual component that is a link to another component.

    Ant Parameters
    Attribute Description Required

    failonerror

    Flag to control failure behaviour. If 'true', the sub task will throw a BuildException when an error is encountered. If 'false', the sub task will throw a NonFatalBuildException instead of a BuildException under specific circumstances. See below for conditions (if any) which will cause a NonFatalBuildException.

    No. default value is taken from the Rhino management parent task.

    Parameters available as nested elements
    Element Description Required

    component

    Identifies the linked component to be removed. See SleeComponentElement. (Note that for the removelinkedcomponent sub task the optional type attribute of component is required.)

    Yes.

    NonFatalBuildException throw conditions
    • The task is run targeting a non-existent component.

    • Constructor Detail

      • RemoveLinkedComponentTask

        public RemoveLinkedComponentTask()
    • Method Detail

      • validateParameters

        protected void validateParameters()
                                   throws org.apache.tools.ant.BuildException
        Specified by:
        validateParameters in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException
      • execute

        protected void execute()
                        throws org.apache.tools.ant.BuildException
        Specified by:
        execute in class AbstractBaseTask
        Throws:
        org.apache.tools.ant.BuildException