java/com/google/gerrit/server/permissions/ChangePermissionOrLabel.java

// 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.server.permissions;

import com.google.gerrit.extensions.api.access.GerritPermission;
import java.util.Optional;

/** A {@link ChangePermission} or a {@link AbstractLabelPermission}. */
public interface ChangePermissionOrLabel extends GerritPermission {
  /**
   * A hint that explains under which conditions this permission is permitted.
   *
   * <p>This is useful for permissions that are not directly assigned but are indirectly permitted
   * by the user having other permissions or being the change owner.
   */
  default Optional<String> hintForException() {
    return Optional.empty();
  }
}