org.ceryle.wiki.plugin.util
Class Parameter

java.lang.Object
  org.ceryle.wiki.plugin.util.Parameter

Direct Known Subclasses:

BooleanParam, IntParam, StringParam

public abstract class Parameter
extends Object

Serves as a boolean parameter object in expressions.

Author:

John Volkar (john.volkar at gmail.com)

Constructor Summary

Parameter(String name, boolean required, String description, ParameterGroup group)

Method Summary

String	describe()
String	getDescription()
String	getName()
String	getSuppliedValue()
boolean	isRequired()
protected abstract void	parseSuppliedValue()
void	throwBad(String extraMessage)
void	update(Map stringParamMap)
boolean	usingDefault()

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter(String name,
                 boolean required,
                 String description,
                 ParameterGroup group)

Method Detail

getSuppliedValue

public String getSuppliedValue()

throwBad

public void throwBad(String extraMessage)
              throws ParameterException

Throws:

ParameterException

update

public void update(Map stringParamMap)
            throws ParameterException

Throws:

ParameterException

parseSuppliedValue

protected abstract void parseSuppliedValue()
                                    throws ParameterException

Throws:

ParameterException

usingDefault

public boolean usingDefault()

Returns:

true if this parameter wasn't given an explicit value.

describe

public String describe()

getDescription

public String getDescription()

Returns:

Returns the description.

getName

public String getName()

Returns:

Returns the name.

isRequired

public boolean isRequired()

Returns:

Returns the required.