org.openimaj.citation

Class ReferenceListener

java.lang.Object

org.openimaj.citation.ReferenceListener

public class ReferenceListener
extends Object

Listener that registers instances of Reference annotations.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
ReferenceListener()

Method Summary

Modifier and Type	Method and Description
static void	addReference(Class<?> clz) Register the any Reference or References from the given class.
static void	addReference(Class<?> clz, String methodName, String signature) Register the any Reference or References from the given method.
static void	addReference(Reference r) Register the given Reference
static void	addReferences(Collection<Reference> refs) Register the given References
static Set<Reference>	getReferences() Get a copy of the references collected by the listener
static Set<Reference>	reset() Reset the references held by the listener, returning the current set of references.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferenceListener

public ReferenceListener()

Method Detail

addReference

public static void addReference(Reference r)

Register the given Reference

Parameters:

r - the Reference

addReference

public static void addReference(Class<?> clz)

Register the any Reference or References from the given class.

Parameters:

clz - the class

addReference

public static void addReference(Class<?> clz,
                                String methodName,
                                String signature)

Register the any Reference or References from the given method.

Parameters:

clz - the class

methodName -

signature -

reset

public static Set<Reference> reset()

Reset the references held by the listener, returning the current set of references.

Returns:

the current set of references.

getReferences

public static Set<Reference> getReferences()

Get a copy of the references collected by the listener

Returns:

the references.

addReferences

public static void addReferences(Collection<Reference> refs)

Register the given References

Parameters:

refs - the References