IuAnnotatedElement.java

/*
 * Copyright © 2025 Indiana University
 * All rights reserved.
 *
 * BSD 3-Clause License
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * 
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * 
 * - Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package edu.iu.type;

import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.util.function.Predicate;

/**
 * Facade interface for annotated type elements.
 * 
 * <p>
 * This interface supports backwards compatibility for annotations on elements
 * defined using legacy annotation types. For example, if a type is marked with
 * {@code javax.annotation.Resource}, it will automatically be translated to
 * {@code jakarta.annotation.Resource}.
 * </p>
 * 
 * @see AnnotatedElement
 */
public interface IuAnnotatedElement {

	/**
	 * Gets all defined annotations.
	 * 
	 * @return all annotations
	 */
	Iterable<? extends Annotation> annotations();

	/**
	 * Gets an annotation.
	 * 
	 * @param <A>            annotation type
	 * @param annotationType annotation type
	 * @return annotation if present, else null
	 */
	<A extends Annotation> A annotation(Class<A> annotationType);

	/**
	 * Determines if an annotation is present.
	 * 
	 * @param annotationType annotation type
	 * @return true if the annotation is present, else null
	 */
	boolean hasAnnotation(Class<? extends Annotation> annotationType);

	/**
	 * Determines if access to this element is permitted in the current context.
	 * 
	 * @param isUserInRole Delegates role-checks to a higher level module.
	 * @return true if access is permitted in the current context; else false
	 */
	boolean permitted(Predicate<String> isUserInRole);

	/**
	 * Determines if access to this element is permitted for all users in the
	 * current context.
	 * 
	 * @return true if access is permitted for all users in the current context;
	 *         else false
	 */
	default boolean permitted() {
		return permitted(role -> false);
	}

}