Package org.apache.commons.launcher

Interface LaunchFilter

public interface LaunchFilter
An interface that provides a means for application developers to perform dynamic configuration and error checking of the attributes and nested elements associated with a "launch" task that connot be easily done within the constraints of Ant.

An implementor of this interface can be attached to a "launch" task by setting the following "launch" task attributes in the Launcher's XML file:

  • filterclassname - The name of the class that implements this interface
  • filterclasspath - (Optional) The classpath for the class that implements
Author:
Patrick Luby

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    filter(LaunchCommand launchCommand)
    Perform error checking and editing of the JVM command line arguments that an instance of the LaunchTask class has constructed.

  • Method Details

    • filter

      void filter(LaunchCommand launchCommand) throws org.apache.tools.ant.BuildException
      Perform error checking and editing of the JVM command line arguments that an instance of the LaunchTask class has constructed. Implementors will receive an instance of the LaunchCommand from the LaunchTask instance that invokes this method. The implementor of this method can then retrieve and edit any of the JVM command line arguments via the LaunchCommand class' public methods.
      Parameters:
      launchCommand - a configured LaunchCommand instance
      Throws:
      org.apache.tools.ant.BuildException - if any errors occur