util.paramhandler

Class ParamLibrary

java.lang.Object

util.paramhandler.ParamLibrary

Direct Known Subclasses:

CaptureParamLibrary

public class ParamLibrary
extends Object

The Default-ParamLibrary. If you want to add new Params or Functions for your Plugin, extend this Plugin and overwrite the public Methods. For an example see the Code in the CapturePlugin

Author:

bodum

Constructor Summary

Constructors

Constructor and Description
ParamLibrary()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescriptionForFunctions(String function) Get the description for a specific Funtion
String	getDescriptionForKey(String key) Get the description for one Key
String	getErrorString() Returns the Error, empty if none occured
String[]	getPossibleFunctions() Get the List of possible Functions
String[]	getPossibleKeys() Get the possible Keys
String	getStringForFunction(Program prg, String function, String[] params) Returns the Value of a function
String	getStringForKey(Program prg, String key) Get the String for a key
boolean	hasErrors() Has an Error occured ?
void	setErrors(boolean errors) Set the Error-Boolean
void	setErrorString(String error) Set the Error

Methods inherited from class java.lang.Object

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

Constructor Detail

ParamLibrary

public ParamLibrary()

Method Detail

hasErrors

public boolean hasErrors()

Has an Error occured ?

Returns:

true if an error occured

setErrors

public void setErrors(boolean errors)

Set the Error-Boolean

Parameters:

errors - True, if an error occured

getErrorString

public String getErrorString()

Returns the Error, empty if none occured

setErrorString

public void setErrorString(String error)

Set the Error

Parameters:

error - the Error

getPossibleKeys

public String[] getPossibleKeys()

Get the possible Keys

Returns:

Array with possible Keys

getDescriptionForKey

public String getDescriptionForKey(String key)

Get the description for one Key

Returns:

description for one key

getPossibleFunctions

public String[] getPossibleFunctions()

Get the List of possible Functions

Returns:

List of possible Functions

getDescriptionForFunctions

public String getDescriptionForFunctions(String function)

Get the description for a specific Funtion

Returns:

getStringForKey

public String getStringForKey(Program prg,
                     String key)

Get the String for a key

Parameters:

prg - Program to use

key - Key to use

Returns:

Value of key in prg

getStringForFunction

public String getStringForFunction(Program prg,
                          String function,
                          String[] params)

Returns the Value of a function

Parameters:

prg - Program to use

function - Function to use

params - Params for the Function

Returns:

Return-Value of Function