org.springframework.extensions.webscripts

Class ResourceDescription

java.lang.Object

org.springframework.extensions.webscripts.AbstractBaseDescription

org.springframework.extensions.webscripts.ResourceDescription

All Implemented Interfaces:

BaseDescription

public class ResourceDescription
extends AbstractBaseDescription

Resource description

Author:

drq

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT_ELEMENT_NAME
static String	WEBSCRIPTS_ELEMENT_NAME

Constructor Summary

Constructors

Constructor and Description
ResourceDescription() Default constructor
ResourceDescription(String shortName, String description, String[] scriptIds) Constructor with shortname, description and scriptIds

Method Summary

Modifier and Type	Method and Description
boolean	compare(ResourceDescription newResourceDescription) Utility for comparint this instance with another ResourceDsecription
String[]	getScriptIds()
String	getScriptIdsAsString()
static ResourceDescription	newInstance() Return a new instance of ResourceDescription
void	parse(org.dom4j.Element elem) Populates fields from given XML element without validation
void	setScriptIds(String[] scriptIds)
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

Field Detail

ROOT_ELEMENT_NAME

public static final String ROOT_ELEMENT_NAME

See Also:

Constant Field Values

WEBSCRIPTS_ELEMENT_NAME

public static final String WEBSCRIPTS_ELEMENT_NAME

See Also:

Constant Field Values

Constructor Detail

ResourceDescription

public ResourceDescription(String shortName,
                           String description,
                           String[] scriptIds)

Constructor with shortname, description and scriptIds

Parameters:

shortName - String

description - String

scriptIds - String[]

ResourceDescription

public ResourceDescription()

Default constructor

Method Detail

getScriptIdsAsString

public String getScriptIdsAsString()

Returns:

the scriptIds

getScriptIds

public String[] getScriptIds()

Returns:

the scriptIds

setScriptIds

public void setScriptIds(String[] scriptIds)

Parameters:

scriptIds - the scriptIds 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

toString

public String toString()

Overrides:

toString in class Object

newInstance

public static ResourceDescription newInstance()

Return a new instance of ResourceDescription

Returns:

a new instance of ResourceDescription

compare

public boolean compare(ResourceDescription newResourceDescription)

Utility for comparint this instance with another ResourceDsecription

Parameters:

newResourceDescription - instance to be compared to

Returns:

true if they are different