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 java.lang.Object
implements ScriptFunctionDocProvider

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RIGHTWARDS_ARROW

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

NO_DOC_PROVIDER

Constructor Summary

Constructors

Constructor and Description
PropertiesFileDocProvider()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

RIGHTWARDS_ARROW

public static final java.lang.String RIGHTWARDS_ARROW

See Also:

Constant Field Values

Constructor Detail

PropertiesFileDocProvider

public PropertiesFileDocProvider()

Method Detail

getMethodDescription

public java.lang.String getMethodDescription(java.lang.String path,
                                             java.lang.reflect.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 java.util.Map<java.lang.String,java.lang.String> getParameterDescriptions(java.lang.String path,
                                                                                 java.lang.reflect.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 java.lang.String getReturnValueDescription(java.lang.String path,
                                                  java.lang.reflect.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 java.lang.String getDescriptionDocs(java.lang.String path,
                                              java.lang.reflect.Method m)

getParameterDocs

protected java.util.Map<java.lang.String,java.lang.String> getParameterDocs(java.lang.String path,
                                                                            java.lang.reflect.Method m)

parameterDocsFromKeywordArgs

protected java.util.Map<java.lang.String,java.lang.String> parameterDocsFromKeywordArgs(java.lang.String path,
                                                                                        java.lang.reflect.Method m)

parameterDocsFromScriptArgs

protected java.util.Map<java.lang.String,java.lang.String> parameterDocsFromScriptArgs(java.lang.String path,
                                                                                       java.lang.reflect.Method m)

getReturnDocs

protected java.lang.String getReturnDocs(java.lang.String path,
                                         java.lang.reflect.Method m)

getBundlePrefix

protected java.lang.String getBundlePrefix(java.lang.reflect.Method m)