jakarta.enterprise.inject.spi.Decorator Maven / Gradle / Ivy

Go to download

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

APIs for CDI (Contexts and Dependency Injection for Java)

There is a newer version: 4.1.0

Show newest version

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010, 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;

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Set;

import jakarta.decorator.Delegate;

/**
 * 
 * Represents an enabled {@linkplain jakarta.decorator decorator}.
 * 
 * 
 * Since CDI 2.0, an implementation of this interface may implement {@link Prioritized} in order to enable the decorator with
 * given priority value for entire application.
 * 
 *
 * CDI Lite implementations are not required to provide support for decorators.
 *
 * @author Gavin King
 * @author Pete Muir
 * 
 * @param  the decorator bean class
 */
public interface Decorator extends Bean {

    /**
     * 
     * Obtains the {@linkplain Type type} of the {@linkplain Delegate delegate injection point}.
     * 
     * 
     * @return the delegate {@linkplain Type type}
     */
    public Type getDelegateType();

    /**
     * 
     * Obtains the {@linkplain jakarta.inject.Qualifier qualifiers} of the {@linkplain Delegate delegate injection
     * point}.
     * 
     * 
     * @return the delegate {@linkplain jakarta.inject.Qualifier qualifiers}
     */
    public Set getDelegateQualifiers();

    /**
     * 
     * Obtains the {@linkplain jakarta.decorator decorated types}.
     * 
     * 
     * @return the set of decorated {@linkplain Type types}
     */
    public Set getDecoratedTypes();

}