Package help.validator.location

Class JarHelpModuleLocation

java.lang.Object

help.validator.location.HelpModuleLocation

help.validator.location.JarHelpModuleLocation

public class JarHelpModuleLocation
extends HelpModuleLocation

Field Summary

Fields inherited from class help.validator.location.HelpModuleLocation

helpDir, sourceTOCFile

Method Summary

Modifier and Type	Method	Description
static JarHelpModuleLocation	fromFile(File jar)
Path	getHelpModuleLocation()
boolean	isHelpInputSource()	Returns true if this help location represents a source of input files to generate help output
javax.help.HelpSet	loadHelpSet()
GhidraTOCFile	loadSourceTOCFile()

Methods inherited from class help.validator.location.HelpModuleLocation

getAllHREFs, getAllIMGs, getHelpLocation, getHelpTopics, getModuleRepoRoot, loadHelpTopics, toString

Methods inherited from class java.lang.Object

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

Method Details

fromFile

public static JarHelpModuleLocation fromFile(File jar)

isHelpInputSource

public boolean isHelpInputSource()

Description copied from class: HelpModuleLocation

Returns true if this help location represents a source of input files to generate help output

Specified by:

isHelpInputSource in class HelpModuleLocation

Returns:

true if this help location represents a source of input files to generate help output

loadHelpSet

public javax.help.HelpSet loadHelpSet()

Specified by:

loadHelpSet in class HelpModuleLocation

getHelpModuleLocation

public Path getHelpModuleLocation()

Overrides:

getHelpModuleLocation in class HelpModuleLocation

loadSourceTOCFile

public GhidraTOCFile loadSourceTOCFile()

Specified by:

loadSourceTOCFile in class HelpModuleLocation