org.apache.shindig.gadgets.spec

Class UserPref

java.lang.Object

org.apache.shindig.gadgets.spec.UserPref

public class UserPref
extends Object

Represents a UserPref tag.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserPref.DataType Possible values for UserPref@datatype
static class	UserPref.EnumValuePair Simple data structure representing a value/displayValue pair for UserPref enums.

Constructor Summary

Constructors

Constructor and Description
UserPref(Element element)

Method Summary

Methods

Modifier and Type	Method and Description
UserPref.DataType	getDataType()
String	getDefaultValue()
String	getDisplayName()
Map<String,String>	getEnumValues()
String	getName()
List<UserPref.EnumValuePair>	getOrderedEnumValues()
boolean	getRequired()
UserPref	substitute(Substitutions substituter) Performs substitutions on the pref.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UserPref

public UserPref(Element element)
         throws SpecParserException

Parameters:

element -

Throws:

SpecParserException

Method Detail

getName

public String getName()

getDisplayName

public String getDisplayName()

getDefaultValue

public String getDefaultValue()

getRequired

public boolean getRequired()

getDataType

public UserPref.DataType getDataType()

getEnumValues

public Map<String,String> getEnumValues()

getOrderedEnumValues

public List<UserPref.EnumValuePair> getOrderedEnumValues()

substitute

public UserPref substitute(Substitutions substituter)

Performs substitutions on the pref. See field comments for details on what is substituted.

Parameters:

substituter -

Returns:

The substituted pref.

toString

public String toString()

Overrides:

toString in class Object