View Javadoc
1   /*
2    * Copyright (c) 2002-2014, Mairie de Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.util.annotation;
35  
36  import fr.paris.lutece.portal.service.spring.SpringContextService;
37  import fr.paris.lutece.portal.service.util.AppException;
38  
39  import java.lang.annotation.Annotation;
40  
41  import java.util.Set;
42  
43  
44  /**
45   *
46   * Allow classpath scanning for annotations
47   *
48   */
49  public final class AnnotationUtil
50  {
51      private static final IAnnotationDB ANNOTATION_DB = (IAnnotationDB) SpringContextService.getBean( "annotationDB" );
52  
53      static
54      {
55          // check annotation db
56          if ( ANNOTATION_DB == null )
57          {
58              throw new AppException( 
59                  "Bean annotationDB is not correctly set. Please check you core_context.xml configuration." );
60          }
61  
62          ANNOTATION_DB.init(  );
63      }
64  
65      /**
66       * Empty constructor
67       */
68      private AnnotationUtil(  )
69      {
70          // nothing
71      }
72  
73      /**
74       * Finds all classes with the given annotation
75       * @param annotationType the annotation class
76       * @return all classes founds
77       */
78      public static Set<String> find( Class<?extends Annotation> annotationType )
79      {
80          return ANNOTATION_DB.getClassesName( annotationType );
81      }
82  
83      /**
84       * Finds all classes with the given annotation
85       * @param strAnnotation the annotation class name
86       * @return all classes founds
87       */
88      public static Set<String> find( String strAnnotation )
89      {
90          return ANNOTATION_DB.getClassesName( strAnnotation );
91      }
92  }