org.atmosphere.util

Class VoidAnnotationProcessor

java.lang.Object

org.atmosphere.util.VoidAnnotationProcessor

All Implemented Interfaces:

AnnotationProcessor

public class VoidAnnotationProcessor
extends java.lang.Object
implements AnnotationProcessor

An AnnotationProcessor that does nothing.

Author:

Jeanfrancois Arcand

Constructor Summary

Constructors

Constructor and Description
VoidAnnotationProcessor()

Method Summary

Modifier and Type	Method and Description
AnnotationProcessor	configure(AtmosphereFramework framework) Configure this class with an instance of AtmosphereFramework
void	destroy() Destroy all resources associated with this object.
AnnotationProcessor	scan(java.io.File rootDir) Scan the File looking for classes annotated with Atmosphere's Service annotation.
AnnotationProcessor	scan(java.lang.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.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoidAnnotationProcessor

public VoidAnnotationProcessor()

Method Detail

configure

public AnnotationProcessor configure(AtmosphereFramework framework)

Description copied from interface: AnnotationProcessor

Configure this class with an instance of AtmosphereFramework

Specified by:

configure in interface AnnotationProcessor

Parameters:

framework - the AtmosphereFramework

Returns:

this

scan

public AnnotationProcessor scan(java.io.File rootDir)
                         throws java.io.IOException

Description copied from interface: AnnotationProcessor

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

Specified by:

scan in interface AnnotationProcessor

Parameters:

rootDir - a directory where annotation can possibly be defined

Returns:

this

Throws:

java.io.IOException

scan

public AnnotationProcessor scan(java.lang.String packageName)
                         throws java.io.IOException

Description copied from interface: AnnotationProcessor

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

Specified by:

scan in interface AnnotationProcessor

Parameters:

packageName - package name

Returns:

this

Throws:

java.io.IOException

scanAll

public AnnotationProcessor scanAll()
                            throws java.io.IOException

Description copied from interface: AnnotationProcessor

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

Specified by:

scanAll in interface AnnotationProcessor

Returns:

this

Throws:

java.io.IOException

destroy

public void destroy()

Description copied from interface: AnnotationProcessor

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

Specified by:

destroy in interface AnnotationProcessor