net.java.sezpoz

Class Index<A extends Annotation,I>

java.lang.Object

net.java.sezpoz.Index<A,I>

All Implemented Interfaces:

Iterable<IndexItem<A,I>>

public final class Index<A extends Annotation,I>
extends Object
implements Iterable<IndexItem<A,I>>

Represents an index of a single annotation. Indices are not automatically cached (but reading them should be pretty cheap anyway).

Method Summary

Modifier and Type	Method and Description
Iterator<IndexItem<A,I>>	iterator() Find all items in the index.
static <A extends Annotation,I> Index<A,I>	load(Class<A> annotation, Class<I> instanceType) Load an index for a given annotation type.
static <A extends Annotation,I> Index<A,I>	load(Class<A> annotation, Class<I> instanceType, ClassLoader loader) Load an index for a given annotation type.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

load

public static <A extends Annotation,I> Index<A,I> load(Class<A> annotation,
                                                       Class<I> instanceType)
                                                throws IllegalArgumentException

Load an index for a given annotation type. Uses the thread's context class loader to find the index and load annotated classes.

Parameters:

annotation - the type of annotation to find

instanceType - the type of instance to be created (use Void if all instances will be null)

Returns:

an index of all elements known to be annotated with it

Throws:

IllegalArgumentException - if the annotation type is not marked with Indexable or the instance type is not equal to or a supertype of the annotation's actual Indexable.type()

load

public static <A extends Annotation,I> Index<A,I> load(Class<A> annotation,
                                                       Class<I> instanceType,
                                                       ClassLoader loader)
                                                throws IllegalArgumentException

Load an index for a given annotation type.

Parameters:

annotation - the type of annotation to find

instanceType - the type of instance to be created (use Void if all instances will be null)

loader - a class loader in which to find the index and any annotated classes

Returns:

an index of all elements known to be annotated with it

Throws:

IllegalArgumentException - if the annotation type is not marked with Indexable or the instance type is not equal to or a supertype of the annotation's actual Indexable.type()

iterator

public Iterator<IndexItem<A,I>> iterator()

Find all items in the index. Calls to iterator methods may fail with IndexError as the index is parsed lazily.

Specified by:

iterator in interface Iterable<IndexItem<A extends Annotation,I>>

Returns:

an iterator over items in the index