java/com/google/gerrit/server/UsedAt.java

// Copyright (C) 2018 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.server;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import com.google.common.annotations.GwtCompatible;
import com.google.inject.BindingAnnotation;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

/**
 * A marker for a method that is public solely because it is called from inside a project or an
 * organisation using Gerrit.
 */
@BindingAnnotation
@Target({METHOD, TYPE})
@Retention(RUNTIME)
@GwtCompatible
public @interface UsedAt {
  /** Enumeration of projects that call a method that would otherwise be private. */
  enum Project {
    GOOGLE,
    COLLABNET,
    PLUGIN_DELETE_PROJECT,
    PLUGIN_SERVICEUSER,
    PLUGINS_ALL, // Use this project if a method/type is generally made available to all plugins.
  }

  /** Reference to the project that uses the method annotated with this annotation. */
  Project value();
}