Class JavaHelpFactory

  • All Implemented Interfaces:
    HelpSetFactory

    public class JavaHelpFactory
    extends java.lang.Object
    implements HelpSetFactory
    Implementation of the HelpSetFactory interface which is aware of javax.help library.
    • Constructor Summary

      Constructors 
      Constructor Description
      JavaHelpFactory()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object createHelpID​(java.lang.Object hsObject, java.lang.String target)  
      java.lang.Object createHelpSetObject​(java.lang.String name, java.io.File file)
      Creates an instance of HelpSet.
      java.lang.Object createHelpSetObject​(java.lang.String name, java.lang.Class<?> c)
      Creates an instance of HelpSet.
      java.lang.Object updateHelpSetObject​(Interview interview, java.lang.Object object)
      Updates a HelpSet instance associated with the given interview.
      • Methods inherited from class java.lang.Object

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

      • JavaHelpFactory

        public JavaHelpFactory()
    • Method Detail

      • createHelpSetObject

        public java.lang.Object createHelpSetObject​(java.lang.String name,
                                                    java.lang.Class<?> c)
                                             throws Interview.Fault
        Description copied from interface: HelpSetFactory
        Creates an instance of HelpSet. Real implementation should create of javax.help.HelpSet, when a stub implementation just object.
        Specified by:
        createHelpSetObject in interface HelpSetFactory
        Throws:
        Interview.Fault - if something went wrong
      • createHelpSetObject

        public java.lang.Object createHelpSetObject​(java.lang.String name,
                                                    java.io.File file)
                                             throws Interview.Fault
        Description copied from interface: HelpSetFactory
        Creates an instance of HelpSet. Real implementation should create of javax.help.HelpSet, when a stub implementation just object.
        Specified by:
        createHelpSetObject in interface HelpSetFactory
        Throws:
        Interview.Fault - if something went wrong
      • createHelpID

        public java.lang.Object createHelpID​(java.lang.Object hsObject,
                                             java.lang.String target)
        Specified by:
        createHelpID in interface HelpSetFactory
      • updateHelpSetObject

        public java.lang.Object updateHelpSetObject​(Interview interview,
                                                    java.lang.Object object)
        Description copied from interface: HelpSetFactory
        Updates a HelpSet instance associated with the given interview.
        Specified by:
        updateHelpSetObject in interface HelpSetFactory
        Parameters:
        interview - - interview object to reset HelpSet
        object - - an instance of javax.help.HelpSet