com.atlassian.gadgets.spec

Class GadgetSpec.Builder

java.lang.Object

com.atlassian.gadgets.spec.GadgetSpec.Builder

Enclosing class:

GadgetSpec

public static class GadgetSpec.Builder
extends Object

A builder that facilitates construction of GadgetSpec objects. The final GadgetSpec is created by calling the build() method

Method Summary

Modifier and Type	Method and Description
GadgetSpec.Builder	author(String author) Set the author of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	authorEmail(String authorEmail) Set the author email of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec	build() Returns the final constructed GadgetSpec
GadgetSpec.Builder	description(String description) Set the description of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	directoryTitle(String directoryTitle) Set the directory title of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	features(Map<String,Feature> features) Set the Map of Feature for the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	height(int height) Set the height of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	scrolling(boolean scrolling) Set the scrolling setting of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	thumbnail(URI thumbnail) Set the thumbnail URI of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	title(String title) Set the title of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	titleUrl(URI titleUrl) Set the title URI of the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	unsupportedFeatureNames(Iterable<String> unsupportedFeatureNames) Set the list of unsupported features for the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	userPrefs(Iterable<UserPrefSpec> userPrefs) Set the list of UserPrefSpec objects for the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	viewsNames(Set<String> viewsNames) Set the list of view names for the GadgetSpec under construction and return this Builder to allow further construction to be done.
GadgetSpec.Builder	width(int width) Set the width of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Methods inherited from class java.lang.Object

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

Method Detail

userPrefs

public GadgetSpec.Builder userPrefs(Iterable<UserPrefSpec> userPrefs)

Set the list of UserPrefSpec objects for the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

userPrefs - the list of UserPrefSpec to use as the user preference values for the GadgetSpec

Returns:

this builder to allow for further construction

scrolling

public GadgetSpec.Builder scrolling(boolean scrolling)

Set the scrolling setting of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

scrolling - the scrolling setting of this GadgetSpec

Returns:

this builder to allow for further construction

height

public GadgetSpec.Builder height(int height)

Set the height of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

height - the height of this GadgetSpec

Returns:

this builder to allow for further construction

width

public GadgetSpec.Builder width(int width)

Set the width of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

width - the width of this GadgetSpec

Returns:

this builder to allow for further construction

title

public GadgetSpec.Builder title(String title)

Set the title of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

title - the title of this GadgetSpec

Returns:

this builder to allow for further construction

titleUrl

public GadgetSpec.Builder titleUrl(URI titleUrl)

Set the title URI of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

titleUrl - the title URI of this GadgetSpec

Returns:

this builder to allow for further construction

thumbnail

public GadgetSpec.Builder thumbnail(URI thumbnail)

Set the thumbnail URI of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

thumbnail - the thumbnail URI of this GadgetSpec

Returns:

this builder to allow for further construction

author

public GadgetSpec.Builder author(String author)

Set the author of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

author - the author of this GadgetSpec

Returns:

this builder to allow for further construction

authorEmail

public GadgetSpec.Builder authorEmail(String authorEmail)

Set the author email of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

authorEmail - the author email of this GadgetSpec

Returns:

this builder to allow for further construction

description

public GadgetSpec.Builder description(String description)

Set the description of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

description - the description of this GadgetSpec

Returns:

this builder to allow for further construction

directoryTitle

public GadgetSpec.Builder directoryTitle(String directoryTitle)

Set the directory title of the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

directoryTitle - the directory title of this GadgetSpec

Returns:

this builder to allow for further construction

features

public GadgetSpec.Builder features(Map<String,Feature> features)

Set the Map of Feature for the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

features - the Map of Feature for the GadgetSpec

Returns:

this builder to allow for further construction

unsupportedFeatureNames

public GadgetSpec.Builder unsupportedFeatureNames(Iterable<String> unsupportedFeatureNames)

Set the list of unsupported features for the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

unsupportedFeatureNames - the list of unsupported features for the GadgetSpec

Returns:

this builder to allow for further construction

viewsNames

public GadgetSpec.Builder viewsNames(Set<String> viewsNames)

Set the list of view names for the GadgetSpec under construction and return this Builder to allow further construction to be done.

Parameters:

viewsNames - the list of view names for the GadgetSpec

Returns:

this builder to allow for further construction

build

public GadgetSpec build()

Returns the final constructed GadgetSpec

Returns:

the GadgetSpec