jakarta.enterprise.inject.spi.configurator.AnnotatedFieldConfigurator Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2016, Red Hat, Inc., and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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 jakarta.enterprise.inject.spi.configurator;

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

import jakarta.enterprise.inject.spi.AnnotatedField;

/**
 * This interface is part of the {@link AnnotatedTypeConfigurator} SPI and helps defining an {@link AnnotatedField}
 *
 * CDI Lite implementations are not required to provide support for Portable Extensions.
 *
 * @author Martin Kouba
 * @author Antoine Sabot-Durand
 * @since 2.0
 * @param  the class declaring the field
 */
public interface AnnotatedFieldConfigurator {
    
    /**
     * 
     * @return the original {@link AnnotatedField}
     */
    AnnotatedField getAnnotated();
    
    /**
     * Add an annotation to the field.
     * 
     * @param annotation the annotation to add
     * @return self
     */
    AnnotatedFieldConfigurator add(Annotation annotation);

    /**
     * Remove annotations that match the specified predicate.
     *
     * 
     * Example predicates:
     * 
     * 
     *      *  {@code
     * // To remove all the annotations:
     * (a) -> true
     * 
     * // To remove annotations with a concrete annotation type:
     * (a) -> a.annotationType().equals(Foo.class)
     * 
     * // To remove annotation equal to a specified object:
     * (a) -> a.equals(fooAnnotation)
     * 
     * // To remove annotations that are considered equivalent for the purposes of typesafe resolution:
     * (a) -> beanManager.areQualifiersEquivalent(a, fooQualifier)
     * (a) -> beanManager.areInterceptorBindingsEquivalent(a, fooInterceptorBinding)
     * }
     * 
     * 
     * @param predicate {@link Predicate} used to filter annotations to remove
     * @return self
     */
    AnnotatedFieldConfigurator remove(Predicate predicate);
    
    /**
     * Remove all the annotations.
     * 
     * @return self
     */
    default AnnotatedFieldConfigurator removeAll() {
        return remove((a) -> true);
    }

}