javax.enterprise.inject.spi.builder.AnnotatedFieldConfigurator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdi-api Show documentation

APIs for CDI (Contexts and Dependency Injection for Java EE)

There is a newer version: 2.0.SP1

/*
 * 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 javax.enterprise.inject.spi.builder;

import java.lang.annotation.Annotation;

import javax.enterprise.inject.spi.AnnotatedField;
import javax.enterprise.util.Nonbinding;

/**
 * This interface is part of the {@link AnnotatedTypeConfigurator} spi and helps defining an {@link AnnotatedField}
 * 
 * @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 to add
     * @return self
     */
    AnnotatedFieldConfigurator add(Annotation annotation);
    
    /**
     * Remove annotations with (a) the same type and (b) the same annotation member value for each member which is not
     * annotated {@link Nonbinding}. The container calls the {@link Object#equals(Object)} method of the annotation member value
     * to compare values.
     * 
     * @param annotation to remove
     * @return self
     */
    AnnotatedFieldConfigurator remove(Annotation annotation);
    
    /**
     * Removes all annotations with the same type. Annotation members are ignored.
     * 
     * @param annotationType annotation class to remove
     * @return self
     */
    AnnotatedFieldConfigurator remove(Class annotationType);
    
    /**
     * Remove all annotations from the field.
     * 
     * @return self
     */
    AnnotatedFieldConfigurator removeAll();

}