com.urswolfer.gerrit.client.rest.http.groups

Class GroupsRestClient

java.lang.Object

com.google.gerrit.extensions.api.groups.Groups.NotImplemented

com.urswolfer.gerrit.client.rest.http.groups.GroupsRestClient

All Implemented Interfaces:

Groups

public class GroupsRestClient
extends Groups.NotImplemented
implements Groups

Author:

Shawn Stafford

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.gerrit.extensions.api.groups.Groups

Groups.ListRequest, Groups.NotImplemented, Groups.QueryRequest

Constructor Summary

Constructors

Constructor and Description
GroupsRestClient(GerritRestClient gerritRestClient, GroupsParser groupsParser)

Method Summary

Modifier and Type	Method and Description
GroupApi	create(GroupInput input) Create a new group.
GroupApi	create(String name) Create a new group with the given name and default options.
GroupApi	id(String id) Look up a group by ID.
Groups.ListRequest	list()
Groups.QueryRequest	query() Query groups.
protected List<GroupInfo>	query(Groups.QueryRequest queryRequest)
Groups.QueryRequest	query(String query) Query groups.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupsRestClient

public GroupsRestClient(GerritRestClient gerritRestClient,
                        GroupsParser groupsParser)

Method Detail

id

public GroupApi id(String id)
            throws RestApiException

Description copied from interface: Groups

Look up a group by ID.

Note: This method eagerly reads the group. Methods that mutate the group do not necessarily re-read the group. Therefore, calling a getter method on an instance after calling a mutation method on that same instance is not guaranteed to reflect the mutation. It is not recommended to store references to groupApi instances.

Specified by:

id in interface Groups

Overrides:

id in class Groups.NotImplemented

Parameters:

id - any identifier supported by the REST API, including group name or UUID.

Returns:

API for accessing the group.

Throws:

RestApiException - if an error occurred.

create

public GroupApi create(String name)
                throws RestApiException

Description copied from interface: Groups

Create a new group with the given name and default options.

Specified by:

create in interface Groups

Overrides:

create in class Groups.NotImplemented

Throws:

RestApiException

create

public GroupApi create(GroupInput input)
                throws RestApiException

Description copied from interface: Groups

Create a new group.

Specified by:

create in interface Groups

Overrides:

create in class Groups.NotImplemented

Throws:

RestApiException

list

public Groups.ListRequest list()

Specified by:

list in interface Groups

Overrides:

list in class Groups.NotImplemented

Returns:

new request for listing groups.

query

public Groups.QueryRequest query()

Description copied from interface: Groups

Query groups.

Example code: query().withQuery("inname:test").withLimit(10).get()

Specified by:

query in interface Groups

Overrides:

query in class Groups.NotImplemented

Returns:

API for setting parameters and getting result.

query

protected List<GroupInfo> query(Groups.QueryRequest queryRequest)
                         throws RestApiException

Throws:

RestApiException

query

public Groups.QueryRequest query(String query)

Description copied from interface: Groups

Query groups.

Shortcut API for query().withQuery(String).

Specified by:

query in interface Groups

Overrides:

query in class Groups.NotImplemented

See Also:

Groups.query()