Class HTMLTestFinder

java.lang.Object
com.sun.javatest.TestFinder
com.sun.javatest.finder.HTMLTestFinder
public class HTMLTestFinder extends TestFinder
This class searches out test descriptions as represented by certain HTML elements in a hierarchy of HTML files.
See Also:

  • Field Details

    • WEB_WALK

      public static final int WEB_WALK
      A value for setMode(int) to specify that the child files within the test tree should be determined from the HTML <a href=...> tags.
      See Also:

    • DIR_WALK

      public static final int DIR_WALK
      A value for setMode(int) to specify that the child files within the test tree should be determined by sub-directories and HTML files within directories.
      See Also:

  • Constructor Details

    • HTMLTestFinder

      public HTMLTestFinder()
      Create an HTMLTestFinder.

  • Method Details

    • decodeArg

      protected int decodeArg(String[] args, int i) throws TestFinder.Fault
      Description copied from class: TestFinder
      Decode the arg at a specified position in the arg array. If overridden by a subtype, the subtype should try and decode any args it recognizes, and then call super.decodeArg to give the superclass(es) a chance to recognize any arguments.
      Overrides:
      decodeArg in class TestFinder
      Parameters:
      args - The array of arguments
      i - The next argument to be decoded
      Returns:
      The number of elements consumed in the array; for example, for a simple option like "-v" the result should be 1; for an option with an argument like "-f file" the result should be 2, etc.
      Throws:
      TestFinder.Fault - If there is a problem with the value of the current arg, such as a bad value to an option, the Fault exception can be thrown. The exception should NOT be thrown if the current arg is unrecognized: in that case, an implementation should delegate the call to the supertype.

    • getRoot

      public File getRoot()
      Description copied from class: TestFinder
      Get the root file of the test suite, as passed in to the init method.
      Overrides:
      getRoot in class TestFinder
      Returns:
      the root file of the test suite
      See Also:

    • localizedError

      protected void localizedError(String msg)
      Description copied from class: TestFinder
      Report a message to the error handler, without additional processing.
      Overrides:
      localizedError in class TestFinder
      Parameters:
      msg - The message to be reported
      See Also:

    • getMode

      public int getMode()
      Get the current mode for how this test finder determines the child files to be scanned.
      Returns:
      One of WEB_WALK or DIR_WALK
      See Also:

    • setMode

      public void setMode(int mode)
      Specify the mode for how this test finder determines the child files to be scanned. The default is DIR_WALK.
      Parameters:
      mode - One of WEB_WALK or DIR_WALK
      See Also:

    • scan

      protected void scan(File file)
      Description copied from class: TestFinder
      Scan a file, looking for test descriptions and other files that might need to be scanned. The implementation depends on the type of test finder.
      Specified by:
      scan in class TestFinder
      Parameters:
      file - The file to scan

    • getCurrentFile

      protected File getCurrentFile()
      Get the name of the file currently being read.
      Returns:
      the name of the file currently being read.