Package org.springframework.extensions.webscripts

Class TypeDescription

java.lang.Object

org.springframework.extensions.webscripts.AbstractBaseDescription

org.springframework.extensions.webscripts.TypeDescription

All Implemented Interfaces:

BaseDescription

public class TypeDescription
extends AbstractBaseDescription

type description

Author:

drq

Field Summary

Fields

Modifier and Type	Field	Description
java.lang.String	definition
static java.lang.String	DEFINITION_ELEMENT_NAME
static java.lang.String	DEFINITION_ELEMENT_URL
java.lang.String	format
static java.lang.String	FORMAT_ELEMENT_NAME
static java.lang.String	ROOT_ELEMENT_NAME
java.lang.String	url

Constructor Summary

Constructors

Constructor	Description
TypeDescription()	Default constructor
TypeDescription(java.lang.String id, java.lang.String shortName, java.lang.String description, java.lang.String format, java.lang.String definition)	Constructor with id, shortName, description, format and definition

Method Summary

Modifier and Type	Method	Description
boolean	compare(TypeDescription newTypeDescription)	Utility function for comparing this instance to another instance of TypeDescription
java.lang.String	getDefinition()
java.lang.String	getFormat()
java.lang.String	getUrl()
static TypeDescription	newInstance()	Return a new instance of TypeDescription
void	parse(org.dom4j.Element elem)	Populates fields from given XML element without validation
void	setDefinition(java.lang.String definition)
void	setFormat(java.lang.String format)
void	setUrl(java.lang.String url)
java.lang.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 java.lang.String ROOT_ELEMENT_NAME

See Also:

Constant Field Values

FORMAT_ELEMENT_NAME

public static final java.lang.String FORMAT_ELEMENT_NAME

See Also:

Constant Field Values

DEFINITION_ELEMENT_NAME

public static final java.lang.String DEFINITION_ELEMENT_NAME

See Also:

Constant Field Values

DEFINITION_ELEMENT_URL

public static final java.lang.String DEFINITION_ELEMENT_URL

See Also:

Constant Field Values

format

public java.lang.String format

definition

public java.lang.String definition

url

public java.lang.String url

Constructor Detail

TypeDescription

public TypeDescription(java.lang.String id,
                       java.lang.String shortName,
                       java.lang.String description,
                       java.lang.String format,
                       java.lang.String definition)

Constructor with id, shortName, description, format and definition

Parameters:

id - String

shortName - String

description - String

format - String

definition - String

TypeDescription

public TypeDescription()

Default constructor

Method Detail

getFormat

public java.lang.String getFormat()

Returns:

the format

setFormat

public void setFormat(java.lang.String format)

Parameters:

format - the format to set

getDefinition

public java.lang.String getDefinition()

Returns:

the definition

setDefinition

public void setDefinition(java.lang.String definition)

Parameters:

definition - the definition to set

getUrl

public java.lang.String getUrl()

Returns:

the url

setUrl

public void setUrl(java.lang.String url)

Parameters:

url - the url 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 java.lang.String toString()

Overrides:

toString in class java.lang.Object

newInstance

public static TypeDescription newInstance()

Return a new instance of TypeDescription

Returns:

TypeDescription

compare

public boolean compare(TypeDescription newTypeDescription)

Utility function for comparing this instance to another instance of TypeDescription

Parameters:

newTypeDescription - instance to be compared to

Returns:

true if they are different