Interface HelpSetFactory

All Known Implementing Classes:
HelpSetFactory.Default, JavaHelpFactory

public interface HelpSetFactory
The interface that implements bridge between javax.help package and JavaTest. Default implementation of this interface just provides stubs, it doesn't use javax.help and could be used in the batch mode. Interview while initialization checks if Desktop is available or not, if yes, the rich factory will be used.
  • Field Details

    • DEFAULT

      static final HelpSetFactory DEFAULT
      The very default implementation of the HelpSetFactory interface. It should be used in case when help is not required (command line mode)
  • Method Details

    • createHelpSetObject

      Object createHelpSetObject(String name, Class<?> c) throws Interview.Fault
      Creates an instance of HelpSet. Real implementation should create of javax.help.HelpSet, when a stub implementation just object.
      Throws:
      Interview.Fault - if something went wrong
    • createHelpSetObject

      Object createHelpSetObject(String name, File file) throws Interview.Fault
      Creates an instance of HelpSet. Real implementation should create of javax.help.HelpSet, when a stub implementation just object.
      Throws:
      Interview.Fault - if something went wrong
    • updateHelpSetObject

      Object updateHelpSetObject(Interview interview, Object object)
      Updates a HelpSet instance associated with the given interview.
      Parameters:
      interview - - interview object to reset HelpSet
      object - - an instance of javax.help.HelpSet
    • createHelpID

      Object createHelpID(Object hs, String str)