|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.gadgets.spec.GadgetSpec
@Immutable public final class GadgetSpec
Represents a gadget specification
Nested Class Summary | |
---|---|
static class |
GadgetSpec.Builder
A builder that facilitates construction of GadgetSpec objects. |
Method Summary | |
---|---|
static GadgetSpec.Builder |
gadgetSpec(GadgetSpec gadgetSpec)
Factory method which allows you to create a new GadgetSpec object based on an existing
GadgetSpec . |
static GadgetSpec.Builder |
gadgetSpec(URI specUri)
Factory method to create a new builder which can be used to create GadgetSpec objects. |
String |
getAuthor()
Get the author of the gadget in this spec |
String |
getAuthorEmail()
Get the email for the author of the gadget in this spec |
String |
getDescription()
Get the description of the gadget in this spec |
String |
getDirectoryTitle()
Get the title for the directory of the gadget in this spec |
Map<String,Feature> |
getFeatures()
Get the features in this spec |
int |
getHeight()
Get the height of the gadget in this spec |
URI |
getThumbnail()
Get the URI for the thumbnail image representing the gadget |
String |
getTitle()
Get the title of the gadget in this spec |
URI |
getTitleUrl()
Get the url that the title of the gadget in this spec should link to |
Iterable<String> |
getUnsupportedFeatureNames()
Get the features that are needed (required, not optional) but aren't available |
URI |
getUrl()
Get the uri for this gadget spec |
Iterable<UserPrefSpec> |
getUserPrefs()
Get the user prefs in this spec |
int |
getWidth()
Get the width of the gadget in this spec |
boolean |
isScrolling()
Get the scrolling setting of the gadget in this spec |
boolean |
supportsViewType(ViewType viewType)
Check if a particular view is supported in this spec |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public URI getUrl()
public Iterable<UserPrefSpec> getUserPrefs()
public boolean supportsViewType(ViewType viewType)
viewType
- to check if supported
public boolean isScrolling()
public int getHeight()
public int getWidth()
public String getTitle()
public URI getTitleUrl()
public URI getThumbnail()
public String getAuthor()
public String getAuthorEmail()
public String getDescription()
public String getDirectoryTitle()
public Map<String,Feature> getFeatures()
public Iterable<String> getUnsupportedFeatureNames()
public static GadgetSpec.Builder gadgetSpec(URI specUri)
GadgetSpec
objects. It returns
a Builder
which allows you to set the gadget spec values.
specUri
- URI
of the gadget
Builder
which allows you to set the gadget spec valuespublic static GadgetSpec.Builder gadgetSpec(GadgetSpec gadgetSpec)
GadgetSpec
object based on an existing
GadgetSpec
.
gadgetSpec
- the GadgetSpec
to start with when building the new GadgetSpec
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 |