|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.gadgets.spec.UserPrefSpec
@Immutable public final class UserPrefSpec
Represents a user pref containing the details from the gadget spec XML
Nested Class Summary | |
---|---|
static class |
UserPrefSpec.Builder
A builder that facilitates construction of UserPrefSpec objects. |
Method Summary | |
---|---|
DataType |
getDataType()
Returns the DataType of this pref. |
String |
getDefaultValue()
Returns the pref's default value. |
String |
getDisplayName()
Returns the display name of this parameter. |
Map<String,String> |
getEnumValues()
Returns the possible values for an enumerated pref. |
String |
getName()
Returns the pref name. |
boolean |
isRequired()
Returns true if the pref is required. |
String |
toString()
|
static UserPrefSpec.Builder |
userPrefSpec(String name)
Factory method to create a new builder which can be used to create UserPrefSpec objects. |
static UserPrefSpec.Builder |
userPrefSpec(UserPrefSpec userPrefSpec)
Factory method which allows you to create a new UserPrefSpec object based on an existing
UserPrefSpec . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public String getName()
public String getDisplayName()
public boolean isRequired()
public DataType getDataType()
DataType
of this pref.
public Map<String,String> getEnumValues()
public String getDefaultValue()
public static UserPrefSpec.Builder userPrefSpec(String name)
UserPrefSpec
objects. It returns
a Builder
which allows you to set the user pref spec values.
name
- the pref name
Builder
which allows you to set the user pref spec valuespublic static UserPrefSpec.Builder userPrefSpec(UserPrefSpec userPrefSpec)
UserPrefSpec
object based on an existing
UserPrefSpec
.
userPrefSpec
- the UserPrefSpec
to start with when building the new UserPrefSpec
Builder
which allows you to set the gadget spec valuespublic String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |