com.sun.faces.application.annotation.ConfigAnnotationHandler Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

There is a newer version: 4.1.1

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.faces.application.annotation;

import java.lang.annotation.Annotation;
import java.util.Collection;

import jakarta.faces.context.FacesContext;

/**
 * Implementations of the interface will be called during application initialization to process any configuration
 * annotations within the web application.
 */
public interface ConfigAnnotationHandler {

    /**
     * @return a Collection of annotations handled by this ConfigAnnotationHandler implementation
     */
    Collection> getHandledAnnotations();

    /**
     * 
     * Collect metadata based on the provided Class and Annotation to be processed later by
     * {@link #push(jakarta.faces.context.FacesContext)}.
     * 
     *
     * 
     * NOTE: This method may be called more than once.
     * 
     *
     *
     * @param target annotated class
     * @param annotation Annotation to process
     */
    void collect(Class target, Annotation annotation);

    /**
     * Push the configuration based on the collected metadata to the current application.
     * @param ctx the involved faces context
     */
    void push(FacesContext ctx);

}