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

Go to download

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

The newest version!

/*
 * 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;

/**
 * 
 * Instances of this interface are responsible for scanning a Class for a specific annotation types.
 * 
 *
 * 
 * Scanner implementations must be thread safe.
 * 
 */
interface Scanner {

    /**
     * @return the {@link java.lang.annotation.Annotation} this Scanner is responsible for handling.
     * NOTE: while a particular Scanner instance may handle a plural version of an
     * Annotation in additional to a singular, this method must return the singular version only.
     */
    Class getAnnotation();

    /**
     * Scan the target class for the {@link java.lang.annotation.Annotation}s this scanner handles.
     *
     * @param clazz the target class
     * @return a new {@link RuntimeAnnotationHandler} instance capable of processing the annotations defined on this class.
     * If no relevant {@link java.lang.annotation.Annotation}s are found, return null.
     */
    RuntimeAnnotationHandler scan(Class clazz);

}