Class RemoveCopiedComponentsTask

  • All Implemented Interfaces:
    SubTask

    public class RemoveCopiedComponentsTask
    extends AbstractBaseTask

    A Rhino management sub task for removing copied components.

    Components can be removed by either specifying the URL of a deployable unit, in which case all copied components in the deployable unit will be removed, or by specifying one or more nested <component> elements.

    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.

    url

    URL of deployable unit to remove copied components from.

    Only required/allowed if no nested component elements are present.

    Element

    Description

    Required

    component

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

    Only required/allowed if the url attribute is not present. Multiple component elements are allowed.

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

    • Constructor Detail

      • RemoveCopiedComponentsTask

        public RemoveCopiedComponentsTask()
    • 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
      • setUrl

        public void setUrl​(String url)