org.atteo.classindex

Class ClassIndex

java.lang.Object

org.atteo.classindex.ClassIndex

public class ClassIndex
extends Object

Access to the compile-time generated index of classes.

Use @IndexAnnotated and @IndexSubclasses annotations to force the classes to be indexed.

Keep in mind that the class is indexed only when it is compiled with classindex.jar file in classpath.

Also to preserve class-index data when creating shaded jar you should use the following Maven configuration:

 
 <build>
   <plugins>
     <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-shade-plugin</artifactId>
       <version>1.4</version>
       <executions>
         <execution>
           <phase>package</phase>
           <goals>
             <goal>shade</goal>
           </goals>
           <configuration>
             <transformers>
               <transformer implementation="org.atteo.classindex.ClassIndexTransformer"/>
             </transformers>
           </configuration>
         </execution>
       </executions>
       <dependencies>
         <groupId>org.atteo.classindex</groupId>
         <artifactId>classindex-transformer</artifactId>
       </dependencies>
     </plugin>
   </plugins>
 </build>
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATED_INDEX_PREFIX
static String	JAVADOC_PREFIX
static String	PACKAGE_INDEX_NAME
static String	SUBCLASS_INDEX_PREFIX

Method Summary

Modifier and Type	Method and Description
static Iterable<Class<?>>	getAnnotated(Class<? extends Annotation> annotation) Retrieves a list of classes annotated by given annotation.
static Iterable<Class<?>>	getAnnotated(Class<? extends Annotation> annotation, ClassLoader classLoader) Retrieves a list of classes annotated by given annotation.
static String	getClassSummary(Class<?> klass) Returns the Javadoc summary for given class.
static String	getClassSummary(Class<?> klass, ClassLoader classLoader) Returns the Javadoc summary for given class.
static Iterable<Class<?>>	getPackageClasses(String packageName) Retrieves a list of classes from given package.
static Iterable<Class<?>>	getPackageClasses(String packageName, ClassLoader classLoader) Retrieves a list of classes from given package.
static <T> Iterable<Class<? extends T>>	getSubclasses(Class<T> superClass) Retrieves a list of subclasses of the given class.
static <T> Iterable<Class<? extends T>>	getSubclasses(Class<T> superClass, ClassLoader classLoader) Retrieves a list of subclasses of the given class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUBCLASS_INDEX_PREFIX

public static final String SUBCLASS_INDEX_PREFIX

See Also:

Constant Field Values

ANNOTATED_INDEX_PREFIX

public static final String ANNOTATED_INDEX_PREFIX

See Also:

Constant Field Values

PACKAGE_INDEX_NAME

public static final String PACKAGE_INDEX_NAME

See Also:

Constant Field Values

JAVADOC_PREFIX

public static final String JAVADOC_PREFIX

See Also:

Constant Field Values

Method Detail

getSubclasses

public static <T> Iterable<Class<? extends T>> getSubclasses(Class<T> superClass)

Retrieves a list of subclasses of the given class.

The class must be annotated with IndexSubclasses for it's subclasses to be indexed at compile-time by ClassIndexProcessor.

Parameters:

superClass - class to find subclasses for

Returns:

list of subclasses

getSubclasses

public static <T> Iterable<Class<? extends T>> getSubclasses(Class<T> superClass,
                                                             ClassLoader classLoader)

Retrieves a list of subclasses of the given class.

The class must be annotated with IndexSubclasses for it's subclasses to be indexed at compile-time by ClassIndexProcessor.

Parameters:

superClass - class to find subclasses for

classLoader - classloader for loading classes

Returns:

list of subclasses

getPackageClasses

public static Iterable<Class<?>> getPackageClasses(String packageName)

Retrieves a list of classes from given package.

The package must be annotated with IndexSubclasses for the classes inside to be indexed at compile-time by ClassIndexProcessor.

Parameters:

packageName - name of the package to search classes for

Returns:

list of classes from package

getPackageClasses

public static Iterable<Class<?>> getPackageClasses(String packageName,
                                                   ClassLoader classLoader)

Retrieves a list of classes from given package.

The package must be annotated with IndexSubclasses for the classes inside to be indexed at compile-time by ClassIndexProcessor.

Parameters:

packageName - name of the package to search classes for

classLoader - classloader for loading classes

Returns:

list of classes from package

getAnnotated

public static Iterable<Class<?>> getAnnotated(Class<? extends Annotation> annotation)

Retrieves a list of classes annotated by given annotation.

The annotation must be annotated with IndexAnnotated for annotated classes to be indexed at compile-time by ClassIndexProcessor.

Parameters:

annotation - annotation to search class for

Returns:

list of annotated classes

getAnnotated

public static Iterable<Class<?>> getAnnotated(Class<? extends Annotation> annotation,
                                              ClassLoader classLoader)

Retrieves a list of classes annotated by given annotation.

The annotation must be annotated with IndexAnnotated for annotated classes to be indexed at compile-time by ClassIndexProcessor.

Parameters:

annotation - annotation to search class for

classLoader - classloader for loading classes

Returns:

list of annotated classes

getClassSummary

public static String getClassSummary(Class<?> klass)

Returns the Javadoc summary for given class.

Javadoc summary is the first sentence of a Javadoc.

You need to use IndexSubclasses or IndexAnnotated with IndexAnnotated.storeJavadoc() set to true.

Parameters:

klass - class to retrieve summary for

Returns:

summary for given class, or null if it does not exists

See Also:

Writing doc comments

getClassSummary

public static String getClassSummary(Class<?> klass,
                                     ClassLoader classLoader)

Returns the Javadoc summary for given class.

Javadoc summary is the first sentence of a Javadoc.

You need to use IndexSubclasses or IndexAnnotated with IndexAnnotated.storeJavadoc() set to true.

Parameters:

klass - class to retrieve summary for

classLoader - classloader for loading classes

Returns:

summary for given class, or null if it does not exists

See Also:

Writing doc comments