/*
 * Copyright 2004-present the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.security.core.annotation;

/**
 * Provides a mechanism for providing custom values from enum types used in security
 * meta-annotation expressions. For example:
 *
 * <pre>
 * enum Permission implements ExpressionTemplateValueProvider {
 *   READ,
 *   WRITE;
 *
 *   &#64;Override
 *   public String getExpressionTemplateValue() {
 *     return switch (this) {
 *       case READ -> "user.permission-read";
 *       case WRITE -> "user.permission-write";
 *     };
 *   }
 *
 * }
 * </pre>
 *
 * @author Mike Heath
 * @since 7.0
 */
public interface ExpressionTemplateValueProvider {

	/**
	 * Returns the value to be used in an expression template.
	 * @return the value to be used in an expression template
	 */
	String getExpressionTemplateValue();

}
