Class JavaHelpFactory

java.lang.Object

com.sun.interview.JavaHelpFactory

All Implemented Interfaces:

HelpSetFactory

public class JavaHelpFactory
extends Object
implements HelpSetFactory

Implementation of the HelpSetFactory interface which is aware of javax.help library.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaHelpFactory.BadHelpFault	This exception is to report problems found while opening a JavaHelp help set.
static class	JavaHelpFactory.HelpNotFoundFault	This exception is thrown when a named help set cannot be found.

Nested classes/interfaces inherited from interface HelpSetFactory

HelpSetFactory.Default

Field Summary

Fields inherited from interface HelpSetFactory

DEFAULT

Constructor Summary

Constructors

Constructor	Description
JavaHelpFactory()

Method Summary

Modifier and Type	Method	Description
Object	createHelpID(Object hsObject, String target)
Object	createHelpSetObject(String name, File file)	Creates an instance of HelpSet.
Object	createHelpSetObject(String name, Class<?> c)	Creates an instance of HelpSet.
Object	updateHelpSetObject(Interview interview, Object object)	Updates a HelpSet instance associated with the given interview.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JavaHelpFactory

public JavaHelpFactory()

Method Details

createHelpSetObject

public Object createHelpSetObject(String name,
 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 Object createHelpSetObject(String name,
 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 Object createHelpID(Object hsObject,
 String target)

Specified by:

createHelpID in interface HelpSetFactory

updateHelpSetObject

public Object updateHelpSetObject(Interview interview,
 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