Package help.validator.location
Class HelpModuleLocation
- java.lang.Object
 - 
- help.validator.location.HelpModuleLocation
 
 
- 
- Direct Known Subclasses:
 DirectoryHelpModuleLocation,JarHelpModuleLocation
public abstract class HelpModuleLocation extends java.lang.Object 
- 
- 
Field Summary
Fields Modifier and Type Field Description protected java.nio.file.PathhelpDirThe help dir parent of the help topics and suchprotected GhidraTOCFilesourceTOCFilethis is the TOC_Source.xml file, not the generated file 
- 
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.util.Collection<HREF>getAllHREFs()java.util.Collection<IMG>getAllIMGs()java.nio.file.PathgetHelpLocation()java.nio.file.PathgetHelpModuleLocation()java.util.Collection<HelpTopic>getHelpTopics()java.nio.file.PathgetModuleRepoRoot()abstract booleanisHelpInputSource()Returns true if this help location represents a source of input files to generate help outputabstract javax.help.HelpSetloadHelpSet()protected voidloadHelpTopics()abstract GhidraTOCFileloadSourceTOCFile()java.lang.StringtoString() 
 - 
 
- 
- 
Field Detail
- 
helpDir
protected java.nio.file.Path helpDir
The help dir parent of the help topics and such 
- 
sourceTOCFile
protected GhidraTOCFile sourceTOCFile
this is the TOC_Source.xml file, not the generated file 
 - 
 
- 
Method Detail
- 
loadSourceTOCFile
public abstract GhidraTOCFile loadSourceTOCFile()
 
- 
loadHelpSet
public abstract javax.help.HelpSet loadHelpSet()
 
- 
isHelpInputSource
public abstract boolean isHelpInputSource()
Returns true if this help location represents a source of input files to generate help output 
- 
loadHelpTopics
protected void loadHelpTopics()
 
- 
getHelpLocation
public java.nio.file.Path getHelpLocation()
 
- 
getHelpModuleLocation
public java.nio.file.Path getHelpModuleLocation()
 
- 
getModuleRepoRoot
public java.nio.file.Path getModuleRepoRoot()
 
- 
getHelpTopics
public java.util.Collection<HelpTopic> getHelpTopics()
 
- 
getAllHREFs
public java.util.Collection<HREF> getAllHREFs()
 
- 
getAllIMGs
public java.util.Collection<IMG> getAllIMGs()
 
- 
toString
public java.lang.String toString()
- Overrides:
 toStringin classjava.lang.Object
 
 - 
 
 -