All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.gerrit.extensions.api.accounts.Accounts Maven / Gradle / Ivy

// Copyright (C) 2014 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.extensions.api.accounts;

import com.google.gerrit.extensions.client.ListAccountsOption;
import com.google.gerrit.extensions.common.AccountInfo;
import com.google.gerrit.extensions.restapi.NotImplementedException;
import com.google.gerrit.extensions.restapi.RestApiException;
import java.util.Arrays;
import java.util.EnumSet;
import java.util.List;

public interface Accounts {
  /**
   * Look up an account by ID.
   *
   * 

Note: This method eagerly reads the account. Methods that mutate the * account do not necessarily re-read the account. 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 {@code AccountApi} instances. * * @param id any identifier supported by the REST API, including numeric ID, email, or username. * @return API for accessing the account. * @throws RestApiException if an error occurred. */ AccountApi id(String id) throws RestApiException; /** @see #id(String) */ AccountApi id(int id) throws RestApiException; /** * Look up the account of the current in-scope user. * * @see #id(String) */ AccountApi self() throws RestApiException; /** Create a new account with the given username and default options. */ AccountApi create(String username) throws RestApiException; /** Create a new account. */ AccountApi create(AccountInput input) throws RestApiException; /** * Suggest users for a given query. * *

Example code: {@code suggestAccounts().withQuery("Reviewer").withLimit(5).get()} * * @return API for setting parameters and getting result. */ SuggestAccountsRequest suggestAccounts() throws RestApiException; /** * Suggest users for a given query. * *

Shortcut API for {@code suggestAccounts().withQuery(String)}. * * @see #suggestAccounts() */ SuggestAccountsRequest suggestAccounts(String query) throws RestApiException; /** * Query users. * *

Example code: {@code query().withQuery("name:John email:example.com").withLimit(5).get()} * * @return API for setting parameters and getting result. */ QueryRequest query() throws RestApiException; /** * Query users. * *

Shortcut API for {@code query().withQuery(String)}. * * @see #query() */ QueryRequest query(String query) throws RestApiException; /** * API for setting parameters and getting result. Used for {@code suggestAccounts()}. * * @see #suggestAccounts() */ abstract class SuggestAccountsRequest { private String query; private int limit; /** Execute query and return a list of accounts. */ public abstract List get() throws RestApiException; /** * Set query. * * @param query needs to be in human-readable form. */ public SuggestAccountsRequest withQuery(String query) { this.query = query; return this; } /** * Set limit for returned list of accounts. Optional; server-default is used when not provided. */ public SuggestAccountsRequest withLimit(int limit) { this.limit = limit; return this; } public String getQuery() { return query; } public int getLimit() { return limit; } } /** * API for setting parameters and getting result. Used for {@code query()}. * * @see #query() */ abstract class QueryRequest { private String query; private int limit; private int start; private EnumSet options = EnumSet.noneOf(ListAccountsOption.class); /** Execute query and return a list of accounts. */ public abstract List get() throws RestApiException; /** * Set query. * * @param query needs to be in human-readable form. */ public QueryRequest withQuery(String query) { this.query = query; return this; } /** * Set limit for returned list of accounts. Optional; server-default is used when not provided. */ public QueryRequest withLimit(int limit) { this.limit = limit; return this; } /** Set number of accounts to skip. Optional; no accounts are skipped when not provided. */ public QueryRequest withStart(int start) { this.start = start; return this; } /** Set an option on the request, appending to existing options. */ public QueryRequest withOption(ListAccountsOption options) { this.options.add(options); return this; } /** Set options on the request, appending to existing options. */ public QueryRequest withOptions(ListAccountsOption... options) { this.options.addAll(Arrays.asList(options)); return this; } /** Set options on the request, replacing existing options. */ public QueryRequest withOptions(EnumSet options) { this.options = options; return this; } public String getQuery() { return query; } public int getLimit() { return limit; } public int getStart() { return start; } public EnumSet getOptions() { return options; } } /** * A default implementation which allows source compatibility when adding new methods to the * interface. */ class NotImplemented implements Accounts { @Override public AccountApi id(String id) throws RestApiException { throw new NotImplementedException(); } @Override public AccountApi id(int id) throws RestApiException { throw new NotImplementedException(); } @Override public AccountApi self() throws RestApiException { throw new NotImplementedException(); } @Override public AccountApi create(String username) throws RestApiException { throw new NotImplementedException(); } @Override public AccountApi create(AccountInput input) throws RestApiException { throw new NotImplementedException(); } @Override public SuggestAccountsRequest suggestAccounts() throws RestApiException { throw new NotImplementedException(); } @Override public SuggestAccountsRequest suggestAccounts(String query) throws RestApiException { throw new NotImplementedException(); } @Override public QueryRequest query() throws RestApiException { throw new NotImplementedException(); } @Override public QueryRequest query(String query) throws RestApiException { throw new NotImplementedException(); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy