com.google.gerrit.extensions.api.plugins.Plugins Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation
API for Gerrit Plugins
There is a newer version: 3.10.1
// Copyright (C) 2017 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.plugins;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import com.google.gerrit.extensions.common.PluginInfo;
import com.google.gerrit.extensions.restapi.NotImplementedException;
import com.google.gerrit.extensions.restapi.RestApiException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.SortedMap;

public interface Plugins {

  ListRequest list() throws RestApiException;

  PluginApi name(String name) throws RestApiException;

  @Deprecated
  @CanIgnoreReturnValue
  PluginApi install(String name, com.google.gerrit.extensions.common.InstallPluginInput input)
      throws RestApiException;

  @CanIgnoreReturnValue
  PluginApi install(String name, InstallPluginInput input) throws RestApiException;

  abstract class ListRequest {
    private boolean all;
    private int limit;
    private int start;
    private String substring;
    private String prefix;
    private String regex;

    public List get() throws RestApiException {
      Map map = getAsMap();
      List result = new ArrayList<>(map.size());
      for (Map.Entry e : map.entrySet()) {
        result.add(e.getValue());
      }
      return result;
    }

    public abstract SortedMap getAsMap() throws RestApiException;

    public ListRequest all() {
      this.all = true;
      return this;
    }

    public boolean getAll() {
      return all;
    }

    public ListRequest limit(int limit) {
      this.limit = limit;
      return this;
    }

    public int getLimit() {
      return limit;
    }

    public ListRequest start(int start) {
      this.start = start;
      return this;
    }

    public int getStart() {
      return start;
    }

    public ListRequest substring(String substring) {
      this.substring = substring;
      return this;
    }

    public String getSubstring() {
      return substring;
    }

    public ListRequest prefix(String prefix) {
      this.prefix = prefix;
      return this;
    }

    public String getPrefix() {
      return prefix;
    }

    public ListRequest regex(String regex) {
      this.regex = regex;
      return this;
    }

    public String getRegex() {
      return regex;
    }
  }

  /**
   * A default implementation which allows source compatibility when adding new methods to the
   * interface.
   */
  class NotImplemented implements Plugins {
    @Override
    public ListRequest list() {
      throw new NotImplementedException();
    }

    @Override
    public PluginApi name(String name) {
      throw new NotImplementedException();
    }

    @Override
    @Deprecated
    public PluginApi install(
        String name, com.google.gerrit.extensions.common.InstallPluginInput input)
        throws RestApiException {
      throw new NotImplementedException();
    }

    @Override
    public PluginApi install(String name, InstallPluginInput input) {
      throw new NotImplementedException();
    }
  }
}