public class DefaultScriptingHelpManager extends Object implements ScriptingHelpManager
ScriptingHelpManager.ScriptingHelpClass, ScriptingHelpManager.ScriptingHelpMethod
Modifier and Type | Field and Description |
---|---|
protected List<File> |
helpRoots |
protected HelpSet |
helpSet |
protected IndexerHelper |
indexer |
protected static Logger |
logger |
protected MethodList |
methodsList |
Constructor and Description |
---|
DefaultScriptingHelpManager(ScriptingManager manager) |
Modifier and Type | Method and Description |
---|---|
void |
addMethods(URL methodsfile) |
boolean |
existsHelp(String name)
Checks if exists a help module from the application's helpset with the
same identificator
|
Map<String,ScriptingHelpManager.ScriptingHelpMethod> |
findMethods(String text)
Gets the methods of all the classes includes on the JavaDocs which
matches with the text provided
|
ScriptingHelpManager.ScriptingHelpClass |
getHelpClass(String name) |
List<ScriptingHelpManager.ScriptingHelpClass> |
getHelpClasses() |
List<File> |
getHelpRoots() |
HelpSet |
getHelpSet()
Returns the HelpSet with the Help information of the JavaDocs registered
|
List<ScriptingHelpManager.ScriptingHelpMethod> |
getMethods()
Gets a List of all the
ScriptingHelpManager.ScriptingHelpMethod s contained on the
JavaDocs |
boolean |
importJavadoc(String name,
File folder,
SimpleTaskStatus status)
Adds a new help module to the application's helpset with the
identificator specified
|
void |
loadHelps() |
URL |
makeURL(File helpsetfolder,
URL sourceurl) |
void |
reloadHelp()
Reloads the Help information of the JavaDocs
|
boolean |
removeHelp(String name)
Removes a help module from the application's helpset
|
protected static final Logger logger
protected HelpSet helpSet
protected IndexerHelper indexer
protected MethodList methodsList
public DefaultScriptingHelpManager(ScriptingManager manager)
public void loadHelps()
public URL makeURL(File helpsetfolder, URL sourceurl)
makeURL
in interface ScriptingHelpManager
public void reloadHelp()
ScriptingHelpManager
reloadHelp
in interface ScriptingHelpManager
public boolean existsHelp(String name)
ScriptingHelpManager
existsHelp
in interface ScriptingHelpManager
name
- String with the identificator of the module help to checkpublic boolean removeHelp(String name)
ScriptingHelpManager
removeHelp
in interface ScriptingHelpManager
name
- String with the identificator of the module help to removepublic void addMethods(URL methodsfile)
addMethods
in interface ScriptingHelpManager
public List<ScriptingHelpManager.ScriptingHelpMethod> getMethods()
ScriptingHelpManager
ScriptingHelpManager.ScriptingHelpMethod
s contained on the
JavaDocsgetMethods
in interface ScriptingHelpManager
ScriptingHelpManager.ScriptingHelpMethod
s on all the
ScriptingHelpAPI
s importedpublic ScriptingHelpManager.ScriptingHelpClass getHelpClass(String name)
getHelpClass
in interface ScriptingHelpManager
public List<ScriptingHelpManager.ScriptingHelpClass> getHelpClasses()
getHelpClasses
in interface ScriptingHelpManager
public Map<String,ScriptingHelpManager.ScriptingHelpMethod> findMethods(String text)
ScriptingHelpManager
findMethods
in interface ScriptingHelpManager
public List<File> getHelpRoots()
getHelpRoots
in interface ScriptingHelpManager
public HelpSet getHelpSet()
ScriptingHelpManager
getHelpSet
in interface ScriptingHelpManager
public boolean importJavadoc(String name, File folder, SimpleTaskStatus status)
ScriptingHelpManager
importJavadoc
in interface ScriptingHelpManager
name
- String with the identificator of the module help to add