Package com.inductiveautomation.ignition.common.script.hints

Class PropertiesFileDocProvider

java.lang.Object

com.inductiveautomation.ignition.common.script.hints.PropertiesFileDocProvider

All Implemented Interfaces:

ScriptFunctionDocProvider

public class PropertiesFileDocProvider
extends Object
implements ScriptFunctionDocProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RIGHTWARDS_ARROW

Fields inherited from interface com.inductiveautomation.ignition.common.script.hints.ScriptFunctionDocProvider

NO_DOC_PROVIDER

Constructor Summary

Constructors

Constructor	Description
PropertiesFileDocProvider()

Method Summary

Modifier and Type	Method	Description
protected String	getBundlePrefix(Method m)
protected String	getDescriptionDocs(String path, Method m)
String	getMethodDescription(String path, Method m)
Map<String,String>	getParameterDescriptions(String path, Method m)
protected Map<String,String>	getParameterDocs(String path, Method m)
protected String	getReturnDocs(String path, Method m)
String	getReturnValueDescription(String path, Method m)
protected Map<String,String>	parameterDocsFromKeywordArgs(String path, Method m)
protected Map<String,String>	parameterDocsFromScriptArgs(String path, Method m)

Methods inherited from class java.lang.Object

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

Field Details

RIGHTWARDS_ARROW

public static final String RIGHTWARDS_ARROW

See Also:

• Constant Field Values

Constructor Details

PropertiesFileDocProvider

public PropertiesFileDocProvider()

Method Details

getMethodDescription

public String getMethodDescription(String path,
 Method m)

Specified by:

getMethodDescription in interface ScriptFunctionDocProvider

Parameters:

path - The path this function is being added at, as given to the ScriptManager.

m - The Method being added as a scripting function.

Returns:

A description of what the function does.

getParameterDescriptions

public Map<String,String> getParameterDescriptions(String path,
 Method m)

Specified by:

getParameterDescriptions in interface ScriptFunctionDocProvider

Parameters:

path - The path this function is being added at, as given to the ScriptManager.

m - The Method being added as a scripting function.

Returns:

Map of parameter names matched to their descriptions.

getReturnValueDescription

public String getReturnValueDescription(String path,
 Method m)

Specified by:

getReturnValueDescription in interface ScriptFunctionDocProvider

Parameters:

path - The path this function is being added at, as given to the ScriptManager.

m - The Method being added as a scripting function.

Returns:

A description of the function's return value.

getDescriptionDocs

protected String getDescriptionDocs(String path,
 Method m)

getParameterDocs

protected Map<String,String> getParameterDocs(String path,
 Method m)

parameterDocsFromKeywordArgs

protected Map<String,String> parameterDocsFromKeywordArgs(String path,
 Method m)

parameterDocsFromScriptArgs

protected Map<String,String> parameterDocsFromScriptArgs(String path,
 Method m)

getReturnDocs

protected String getReturnDocs(String path,
 Method m)

getBundlePrefix

protected String getBundlePrefix(Method m)