com.google.gerrit.server.restapi.project

Class DashboardsCollection

java.lang.Object

com.google.gerrit.server.restapi.project.DashboardsCollection

All Implemented Interfaces:

ChildCollection<ProjectResource,DashboardResource>, RestCollection<ProjectResource,DashboardResource>, RestView<ProjectResource>

public class DashboardsCollection
extends Object
implements ChildCollection<ProjectResource,DashboardResource>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DashboardsCollection.InvalidDashboardId

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DASHBOARD_NAME

Method Summary

Modifier and Type	Method and Description
static boolean	isDefaultDashboard(IdString id)
static boolean	isDefaultDashboard(String id)
RestView<ProjectResource>	list() Create a view to list the contents of the collection.
static DashboardInfo	newDashboardInfo(String ref, String path)
static String	normalizeDashboardRef(String ref)
DashboardResource	parse(ProjectResource parent, IdString id) Parse a path component into a resource handle.
DynamicMap<RestView<DashboardResource>>	views() Get the views that support this collection.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DASHBOARD_NAME

public static final String DEFAULT_DASHBOARD_NAME

See Also:

Constant Field Values

Method Detail

isDefaultDashboard

public static boolean isDefaultDashboard(String id)

isDefaultDashboard

public static boolean isDefaultDashboard(IdString id)

list

public RestView<ProjectResource> list()
                               throws ResourceNotFoundException

Description copied from interface: RestCollection

Create a view to list the contents of the collection.

The returned view should accept the parent type to scope the search, and may want to take a "q" parameter option to narrow the results.

Specified by:

list in interface RestCollection<ProjectResource,DashboardResource>

Returns:

view to list the collection.

Throws:

ResourceNotFoundException - if the collection doesn't support listing.

parse

public DashboardResource parse(ProjectResource parent,
                               IdString id)
                        throws RestApiException,
                               IOException,
                               org.eclipse.jgit.errors.ConfigInvalidException,
                               PermissionBackendException

Description copied from interface: RestCollection

Parse a path component into a resource handle.

Specified by:

parse in interface RestCollection<ProjectResource,DashboardResource>

Parameters:

parent - the handle to the collection.

id - string identifier supplied by the client. In a URL such as /changes/1234/abandon this string is "1234".

Returns:

a resource handle for the identified object.

Throws:

ResourceNotFoundException - the object does not exist, or the caller is not permitted to know if the resource exists.

RestApiException

IOException

org.eclipse.jgit.errors.ConfigInvalidException

PermissionBackendException

normalizeDashboardRef

public static String normalizeDashboardRef(String ref)

views

public DynamicMap<RestView<DashboardResource>> views()

Description copied from interface: RestCollection

Get the views that support this collection.

Within a resource the views are accessed as RESOURCE/plugin~view.

Specified by:

views in interface RestCollection<ProjectResource,DashboardResource>

Returns:

map of views.

newDashboardInfo

public static DashboardInfo newDashboardInfo(String ref,
                                             String path)