Line data    Source code

       1             : // Copyright (C) 2018 The Android Open Source Project
       2             : //
       3             : // Licensed under the Apache License, Version 2.0 (the "License");
       4             : // you may not use this file except in compliance with the License.
       5             : // You may obtain a copy of the License at
       6             : //
       7             : // http://www.apache.org/licenses/LICENSE-2.0
       8             : //
       9             : // Unless required by applicable law or agreed to in writing, software
      10             : // distributed under the License is distributed on an "AS IS" BASIS,
      11             : // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      12             : // See the License for the specific language governing permissions and
      13             : // limitations under the License.
      14             : 
      15             : package com.google.gerrit.extensions.api.access;
      16             : 
      17             : import java.util.Locale;
      18             : 
      19             : /** Gerrit permission for hosts, projects, refs, changes, labels and plugins. */
      20             : public interface GerritPermission {
      21             :   /**
      22             :    * A description in the context of an exception message.
      23             :    *
      24             :    * <p>Should be grammatical when used in the construction "not permitted: [description] on
      25             :    * [resource]", although individual {@code PermissionBackend} implementations may vary the
      26             :    * wording.
      27             :    */
      28             :   String describeForException();
      29             : 
      30             :   static String describeEnumValue(Enum<?> value) {
      31          57 :     return value.name().toLowerCase(Locale.US).replace('_', ' ');
      32             :   }
      33             : }