io.magus.methodmap

Class AbstractBoundMethodCollectionFactory

java.lang.Object

io.magus.methodmap.AbstractBoundMethodCollectionFactory

All Implemented Interfaces:

MethodCollectionFactory

Direct Known Subclasses:

BoundAnnotatedMethodCollectionFactory

public abstract class AbstractBoundMethodCollectionFactory
extends java.lang.Object
implements MethodCollectionFactory

Base class for implementations of a BoundMethodCollectionFactory. Instances of this class produce method collections containing methods that belong strictly to the class of a provided object. This factory is used mainly for the production of method collections for implementations of BoundMethodMap.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBoundMethodCollectionFactory(java.lang.Object target)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getTarget() Retrieves the underlying object of this BoundMethodCollectionFactory.
protected abstract boolean	include(java.lang.reflect.Method method) Determines whether or not a candidate method should be included in the method collection produced by this BoundMethodCollectionFactory.
java.util.Collection<java.lang.reflect.Method>	produceMethodCollection()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBoundMethodCollectionFactory

protected AbstractBoundMethodCollectionFactory(java.lang.Object target)

Parameters:

target - the target object whose class's methods are candidates to be included in the output of a call to produceMethodCollection()

Method Detail

produceMethodCollection

public final java.util.Collection<java.lang.reflect.Method> produceMethodCollection()
                                                                             throws MethodCollectionProductionException

Specified by:

produceMethodCollection in interface MethodCollectionFactory

Returns:

the collection of methods

Throws:

MethodCollectionProductionException - If production of the method collection fails.

getTarget

public final java.lang.Object getTarget()

Retrieves the underlying object of this BoundMethodCollectionFactory.

Returns:

the underlying object of this BoundMethodCollectionFactory

include

protected abstract boolean include(java.lang.reflect.Method method)

Determines whether or not a candidate method should be included in the method collection produced by this BoundMethodCollectionFactory.

Parameters:

method - method to be evaluated for inclusion in the output of produceMethodCollection()

Returns:

true if the method should be included in the produced method collection, false otherwise