statalign.postprocess
Class PluginParameters

java.lang.Object
  statalign.postprocess.PluginParameters

public class PluginParameters
extends java.lang.Object

A class which for storing plugin parameters. Any parameters starting with "plugin:" will be passed from the CommandLine class to a static PluginParameters object which is visible to all Postprocess classes. It is the responsibility of the individual Postprocess classes to retrieve the parameters specific to that they require.

Constructor Summary

PluginParameters()

PluginParameters(java.util.ArrayList<java.lang.String> argsVector)
An alternative way to initialise this class.

Method Summary

java.lang.String	getParameter(java.lang.String name) Returns the corresponding parameter value or null if the parameter does not exist.
void	print()
void	removeParameter(java.lang.String name)
void	setParameter(java.lang.String name, java.lang.String value) Given a parameter and a value, sets the corresponding parameter value.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginParameters

public PluginParameters()

PluginParameters

public PluginParameters(java.util.ArrayList<java.lang.String> argsVector)

An alternative way to initialise this class.

Parameters:

args - a list of parameters and values of the form "parameter=value".

Method Detail

getParameter

public java.lang.String getParameter(java.lang.String name)

Returns the corresponding parameter value or null if the parameter does not exist.

Parameters:

name - the name of the parameter to retrieve, excluding the "plugin:" suffix.

Returns:

the corresponding value.

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

Given a parameter and a value, sets the corresponding parameter value.

Parameters:

name - the name of the parameter to set, excluding the "plugin:" suffix.

value - the value of the parameter.

removeParameter

public void removeParameter(java.lang.String name)

print

public void print()