org.atmosphere.cpr
Interface AnnotationProcessor

All Known Implementing Classes:

DefaultAnnotationProcessor, VoidAnnotationProcessor

public interface AnnotationProcessor

An annotation processor for configuring the AtmosphereFramework.

Author:

Jeanfrancois Arcand

Method Summary

AnnotationProcessor	configure(AtmosphereFramework framework) Configure this class with an instance of AtmosphereFramework
void	destroy() Destroy all resources associated with this object.
AnnotationProcessor	scan(File rootDir) Scan the File looking for classes annotated with Atmosphere's Service annotation.
AnnotationProcessor	scan(String packageName) Scan the package looking for classes annotated with Atmosphere's Service annotation.
AnnotationProcessor	scanAll() Scan all classes on the classpath looking for classes annotated with Atmosphere's Service annotation.

Method Detail

configure

AnnotationProcessor configure(AtmosphereFramework framework)

Configure this class with an instance of AtmosphereFramework

Parameters:

framework - the AtmosphereFramework

Returns:

this

scan

AnnotationProcessor scan(File rootDir)
                         throws IOException

Scan the File looking for classes annotated with Atmosphere's Service annotation.

Parameters:

rootDir - a directory where annotation can possibly be defined

Returns:

this

Throws:

IOException

scan

AnnotationProcessor scan(String packageName)
                         throws IOException

Scan the package looking for classes annotated with Atmosphere's Service annotation.

Parameters:

packageName - package name

Returns:

this

Throws:

IOException

scanAll

AnnotationProcessor scanAll()
                            throws IOException

Scan all classes on the classpath looking for classes annotated with Atmosphere's Service annotation.

Returns:

this

Throws:

IOException

destroy

void destroy()

Destroy all resources associated with this object. Once destroyed, this object can no longer be used.