org.nakedobjects.runtime.help.file
Class FileBasedHelpManager

java.lang.Object
  org.nakedobjects.runtime.help.HelpManagerAbstract
      org.nakedobjects.runtime.help.file.FileBasedHelpManager

All Implemented Interfaces:

ApplicationScopedComponent, Component, HelpManager

public class FileBasedHelpManager
extends HelpManagerAbstract

Field Summary

static java.lang.String

DEFAULT_FILE_NAME The name of the file used unless overridden with setFileName(String).

Constructor Summary

FileBasedHelpManager(NakedObjectConfiguration configuration)

Method Summary

protected java.io.BufferedReader	getReader()
java.lang.String	help(Identifier identifier) Returns help text for the specified identifier.
void	setFileName(java.lang.String fileName)

Methods inherited from class org.nakedobjects.runtime.help.HelpManagerAbstract

init, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILE_NAME

public static final java.lang.String DEFAULT_FILE_NAME

The name of the file used unless overridden with setFileName(String).

See Also:

Constant Field Values

Constructor Detail

FileBasedHelpManager

public FileBasedHelpManager(NakedObjectConfiguration configuration)

Method Detail

setFileName

public void setFileName(java.lang.String fileName)

help

public java.lang.String help(Identifier identifier)

Description copied from interface: HelpManager

Returns help text for the specified identifier. If no help text is available then an empty String should be returned.

Specified by:

help in interface HelpManager

Specified by:

help in class HelpManagerAbstract

getReader

protected java.io.BufferedReader getReader()
                                    throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException