AnnotationUtil.java

/*
 * Copyright (c) 2002-2022, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.util.annotation;

import fr.paris.lutece.portal.service.spring.SpringContextService;
import fr.paris.lutece.portal.service.util.AppException;

import java.lang.annotation.Annotation;

import java.util.Set;

/**
 *
 * Allow classpath scanning for annotations
 *
 */
public final class AnnotationUtil
{
    private static final IAnnotationDB ANNOTATION_DB = SpringContextService.getBean( "annotationDB" );

    static
    {
        // check annotation db
        if ( ANNOTATION_DB == null )
        {
            throw new AppException( "Bean annotationDB is not correctly set. Please check you core_context.xml configuration." );
        }

        ANNOTATION_DB.init( );
    }

    /**
     * Empty constructor
     */
    private AnnotationUtil( )
    {
        // nothing
    }

    /**
     * Finds all classes with the given annotation
     * 
     * @param annotationType
     *            the annotation class
     * @return all classes founds
     */
    public static Set<String> find( Class<? extends Annotation> annotationType )
    {
        return ANNOTATION_DB.getClassesName( annotationType );
    }

    /**
     * Finds all classes with the given annotation
     * 
     * @param strAnnotation
     *            the annotation class name
     * @return all classes founds
     */
    public static Set<String> find( String strAnnotation )
    {
        return ANNOTATION_DB.getClassesName( strAnnotation );
    }
}