org.springframework.extensions.webscripts

Class ArgumentTypeDescription

java.lang.Object

org.springframework.extensions.webscripts.AbstractBaseDescription

org.springframework.extensions.webscripts.ArgumentTypeDescription

All Implemented Interfaces:

BaseDescription

public class ArgumentTypeDescription
extends AbstractBaseDescription

Webscript argument description

Author:

drq

Constructor Summary

Constructors

Constructor and Description
ArgumentTypeDescription() Default constructor
ArgumentTypeDescription(String shortName, String description, String defaultValue) Constructor with shortName, description and defaultValue

Method Summary

Modifier and Type	Method and Description
boolean	compare(ArgumentTypeDescription newArgumentTypeDescription) Utility function for comparing this ArgumentTypeDescription with another ArgumentTypeDescription instance.
String	getDefaultValue()
boolean	isRequired()
static ArgumentTypeDescription	newInstance() Returns a new instance of ArgumentTypeDescription
void	parse(org.dom4j.Element elem) Populates fields from given XML element without validation
void	setDefaultValue(String defaultValue)
void	setRequired(boolean required)
String	toString()

Methods inherited from class org.springframework.extensions.webscripts.AbstractBaseDescription

compareField, getDescription, getId, getShortName, setDescription, setId, setShortName, validateRootElement

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentTypeDescription

public ArgumentTypeDescription(String shortName,
                               String description,
                               String defaultValue)

Constructor with shortName, description and defaultValue

Parameters:

shortName - String

description - String

defaultValue - String

ArgumentTypeDescription

public ArgumentTypeDescription()

Default constructor

Method Detail

getDefaultValue

public String getDefaultValue()

Returns:

the defaultValue

setDefaultValue

public void setDefaultValue(String defaultValue)

Parameters:

defaultValue - the defaultValue to set

parse

public void parse(org.dom4j.Element elem)

Description copied from class: AbstractBaseDescription

Populates fields from given XML element without validation

Overrides:

parse in class AbstractBaseDescription

Parameters:

elem - root element for parsing

isRequired

public boolean isRequired()

Returns:

the required

setRequired

public void setRequired(boolean required)

Parameters:

required - the required to set

toString

public String toString()

Overrides:

toString in class Object

newInstance

public static ArgumentTypeDescription newInstance()

Returns a new instance of ArgumentTypeDescription

Returns:

a new instance of ArgumentTypeDescription

compare

public boolean compare(ArgumentTypeDescription newArgumentTypeDescription)

Utility function for comparing this ArgumentTypeDescription with another ArgumentTypeDescription instance.

Parameters:

newArgumentTypeDescription - ArgumentTypeDescription instance to be compared to

Returns:

true if they are different