Class Help

java.lang.Object
com.sun.interview.Help

public class Help extends Object
Class that contains a number of static method to work with both JavaTest and JavaHelp objects to make the core JavaTest classes unaware of JavaHelp.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    An exception used to report errors while using a TestSuite object.
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    static com.sun.javatest.tool.jthelp.HelpSet[]
    Get helpsets containing any related documents for this test suite.
    static com.sun.javatest.tool.jthelp.HelpID
    Get the JavaHelp HelpID identifying the "more info" help for this question, or null if none.
    static com.sun.javatest.tool.jthelp.HelpSet
    Get the help set used to locate the "more info" for each question.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Help

      public Help()
  • Method Details

    • getHelpSet

      public static com.sun.javatest.tool.jthelp.HelpSet getHelpSet(Interview i)
      Get the help set used to locate the "more info" for each question.
      Parameters:
      i - interview
      Returns:
      object returned by i.getHelpSet() casted to the HelpSet type.
      See Also:
    • getHelpID

      public static com.sun.javatest.tool.jthelp.HelpID getHelpID(Question q)
      Get the JavaHelp HelpID identifying the "more info" help for this question, or null if none.
      Returns:
      the JavaHelp HelpID identifying the "more info" help for this question, or null if none.
    • getAdditionalDocs

      public static com.sun.javatest.tool.jthelp.HelpSet[] getAdditionalDocs(TestSuite ts) throws Help.Fault
      Get helpsets containing any related documents for this test suite. By default, the resource names for the help sets are obtained from getAdditionalDocNames().
      Parameters:
      ts - The test suite to look for the docs within.
      Returns:
      an array of help sets containing docs associated with this testsuite. The array will be empty if there are no such docs.
      Throws:
      Help.Fault - if there are problems opening any of the helpsets.