Package io.milton.http.annotated

Class AbstractAnnotationHandler

java.lang.Object

io.milton.http.annotated.AbstractAnnotationHandler

All Implemented Interfaces:

AnnotationHandler

Direct Known Subclasses:

AccessControlListAnnotationHandler, AddressBooksAnnotationHandler, AuthenticateAnnotationHandler, CalendarDateRangeQueryAnnotationHandler, CalendarInvitationsAnnotationHandler, CalendarInvitationsCTagAnnotationHandler, CalendarsAnnotationHandler, ChildOfAnnotationHandler, ChildrenOfAnnotationHandler, CommonPropertyAnnotationHandler, ContactDataAnnotationHandler, ContentTypeAnnotationHandler, CopyAnnotationHandler, CTagAnnotationHandler, DeleteAnnotationHandler, DisplayNameAnnotationHandler, DisplayNameSetterAnnotationHandler, FreeBusyQueryAnnotationHandler, GetAnnotationHandler, ICalDataAnnotationHandler, MakeCalendarAnnotationHandler, MakeCollectionAnnotationHandler, MoveAnnotationHandler, PostAnnotationHandler, PrincipalSearchAnnotationHandler, PutChildAnnotationHandler, UsersAnnotationHandler

public abstract class AbstractAnnotationHandler
extends Object
implements AnnotationHandler

Author:

brad

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class	annoClass
protected final AnnotationResourceFactory	annoResourceFactory
protected final Request.Method[]	methods

Constructor Summary

Constructors

Constructor	Description
AbstractAnnotationHandler(AnnotationResourceFactory outer, Class annoClass, Request.Method... methods)

Method Summary

Modifier and Type	Method	Description
protected Object	attemptToReadProperty(Object source, String... propNames)
protected boolean	attemptToSetProperty(Object source, Object value, String... propNames)	Returns true if it was able to set the property
Class	getAnnoClass()	Get the annotation class that this handler handles
List<ControllerMethod>	getControllerMethods()	List the methods found when parsing annotations on the controller
ControllerMethod	getMethodForType(AnnoCollectionResource parent, String type)	Locate a ControllerMethod which can create an object of the given type (may be null) in the given parent
Request.Method[]	getSupportedMethods()	Return any HTTP methods which this annotation handler supports
protected Object	invoke(ControllerMethod cm, AnnoResource sourceRes, Object... values)
boolean	isCompatible(Object source)	Determine if this handler is able to support the given source object, ie if there is a controller method registered in this handler that supports the given source type
void	parseController(Object controller)	Called on initialisation, the handler should look for annotations on the controller object and prepare itself to use them

Methods inherited from class java.lang.Object

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

Field Details

annoResourceFactory

protected final AnnotationResourceFactory annoResourceFactory

annoClass

protected final Class annoClass

methods

protected final Request.Method[] methods

Constructor Details

AbstractAnnotationHandler

public AbstractAnnotationHandler(AnnotationResourceFactory outer,
 Class annoClass,
 Request.Method... methods)

Method Details

getAnnoClass

public Class getAnnoClass()

Description copied from interface: AnnotationHandler

Get the annotation class that this handler handles

Specified by:

getAnnoClass in interface AnnotationHandler

Returns:

parseController

public void parseController(Object controller)

Description copied from interface: AnnotationHandler

Called on initialisation, the handler should look for annotations on the controller object and prepare itself to use them

Specified by:

parseController in interface AnnotationHandler

getMethodForType

public ControllerMethod getMethodForType(AnnoCollectionResource parent,
 String type)

Locate a ControllerMethod which can create an object of the given type (may be null) in the given parent

Parameters:

parent -

type - - final segment of the class name to be created, or null. Eg to create com.mycompany.Customer use "Customer"

Returns:

null, if none found, otherwise a method which can create the given resource

getSupportedMethods

public Request.Method[] getSupportedMethods()

Description copied from interface: AnnotationHandler

Return any HTTP methods which this annotation handler supports

Specified by:

getSupportedMethods in interface AnnotationHandler

Returns:

isCompatible

public boolean isCompatible(Object source)

Description copied from interface: AnnotationHandler

Determine if this handler is able to support the given source object, ie if there is a controller method registered in this handler that supports the given source type

Specified by:

isCompatible in interface AnnotationHandler

Returns:

attemptToReadProperty

protected Object attemptToReadProperty(Object source,
 String... propNames)
                                throws IllegalAccessException,
InvocationTargetException,
NoSuchMethodException

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

attemptToSetProperty

protected boolean attemptToSetProperty(Object source,
 Object value,
 String... propNames)
                                throws IllegalAccessException,
InvocationTargetException,
NoSuchMethodException

Returns true if it was able to set the property

Parameters:

source -

value -

propNames -

Returns:

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

invoke

protected Object invoke(ControllerMethod cm,
 AnnoResource sourceRes,
 Object... values)
                 throws Exception

Throws:

Exception

getControllerMethods

public List<ControllerMethod> getControllerMethods()

Description copied from interface: AnnotationHandler

List the methods found when parsing annotations on the controller

Specified by:

getControllerMethods in interface AnnotationHandler

Returns: