org.codehaus.xfire.annotations
Interface WebAnnotations

All Known Implementing Classes:

CommonsWebAttributes

public interface WebAnnotations

Defines the contract for accessing annotations at runtime. This is a facade, which can accommodate any annotations API such as Commons Attributes, backport175, Java 5, or any other annotations implementation.

Author:

Arjen Poutsma

Method Summary

java.util.Collection	getFaultHandlers(java.lang.Class clazz)
HandlerChainAnnotation	getHandlerChainAnnotation(java.lang.Class aClass) Gets the HandlerChainAnnotation annotation from the given class, if found.
java.util.Collection	getInHandlers(java.lang.Class clazz)
java.util.Collection	getOutHandlers(java.lang.Class clazz)
java.util.Map	getServiceProperties(java.lang.Class clazz)
SOAPBindingAnnotation	getSOAPBindingAnnotation(java.lang.Class aClass) Gets the SOAPBindingAnnotation annotation from the given class, if found.
WebMethodAnnotation	getWebMethodAnnotation(java.lang.reflect.Method method) Gets the WebServiceAnnotation annotation from the given class, if found.
WebParamAnnotation	getWebParamAnnotation(java.lang.reflect.Method method, int parameter) Gets the WebParamAnnotation annotation from the indicated parameter of the given method, if found.
WebResultAnnotation	getWebResultAnnotation(java.lang.reflect.Method method) Gets the WebResultAnnotation annotation from the given method, if found.
WebServiceAnnotation	getWebServiceAnnotation(java.lang.Class aClass) Gets the WebServiceAnnotation annotation from the given class, if found.
boolean	hasHandlerChainAnnotation(java.lang.Class aClass) Tests whether the given class has the HandlerChainAnnotation annotation.
boolean	hasOnewayAnnotation(java.lang.reflect.Method method) Tests whether the given method has the one way annotation.
boolean	hasSOAPBindingAnnotation(java.lang.Class aClass) Tests whether the given class has the SOAPBindingAnnotation annotation.
boolean	hasWebMethodAnnotation(java.lang.reflect.Method method) Tests whether the given method has the WebMethodAnnotation annotation.
boolean	hasWebParamAnnotation(java.lang.reflect.Method method, int parameter) Tests whether the indicated parameter of the given method has the WebResultAnnotation annotation.
boolean	hasWebResultAnnotation(java.lang.reflect.Method method) Tests whether the given method has the WebResultAnnotation annotation.
boolean	hasWebServiceAnnotation(java.lang.Class aClass) Tests whether the given class has the WebServiceAnnotation annotation.

Method Detail

hasWebServiceAnnotation

boolean hasWebServiceAnnotation(java.lang.Class aClass)

Tests whether the given class has the WebServiceAnnotation annotation.

Parameters:

aClass - the class.

Returns:

true if present; false otherwise.

getWebServiceAnnotation

WebServiceAnnotation getWebServiceAnnotation(java.lang.Class aClass)

Gets the WebServiceAnnotation annotation from the given class, if found.

Parameters:

aClass - the class.

Returns:

the annotation; or null if it could not be found.

hasWebMethodAnnotation

boolean hasWebMethodAnnotation(java.lang.reflect.Method method)

Tests whether the given method has the WebMethodAnnotation annotation.

Parameters:

method - the method.

Returns:

true if present; false otherwise.

getWebMethodAnnotation

WebMethodAnnotation getWebMethodAnnotation(java.lang.reflect.Method method)

Gets the WebServiceAnnotation annotation from the given class, if found.

Parameters:

method - the method.

Returns:

the annotation; or null if it could not be found.

hasWebResultAnnotation

boolean hasWebResultAnnotation(java.lang.reflect.Method method)

Tests whether the given method has the WebResultAnnotation annotation.

Parameters:

method - the method.

Returns:

true if present; false otherwise.

getWebResultAnnotation

WebResultAnnotation getWebResultAnnotation(java.lang.reflect.Method method)

Gets the WebResultAnnotation annotation from the given method, if found.

Parameters:

method - the method.

Returns:

the annotation; or null if it could not be found.

hasWebParamAnnotation

boolean hasWebParamAnnotation(java.lang.reflect.Method method,
                              int parameter)

Tests whether the indicated parameter of the given method has the WebResultAnnotation annotation.

Parameters:

method - the method.

parameter - the index of the parameter in the method's parameter list.

Returns:

true> if present; false otherwise.

getWebParamAnnotation

WebParamAnnotation getWebParamAnnotation(java.lang.reflect.Method method,
                                         int parameter)

Gets the WebParamAnnotation annotation from the indicated parameter of the given method, if found.

Parameters:

method - the method.

parameter - the parameter index.

Returns:

the annotation; or null if it could not be found.

hasOnewayAnnotation

boolean hasOnewayAnnotation(java.lang.reflect.Method method)

Tests whether the given method has the one way annotation.

Parameters:

method - the method.

Returns:

true if present; false otherwise.

hasSOAPBindingAnnotation

boolean hasSOAPBindingAnnotation(java.lang.Class aClass)

Tests whether the given class has the SOAPBindingAnnotation annotation.

Parameters:

aClass - the class.

Returns:

true> if present; false otherwise.

getSOAPBindingAnnotation

SOAPBindingAnnotation getSOAPBindingAnnotation(java.lang.Class aClass)

Gets the SOAPBindingAnnotation annotation from the given class, if found.

Parameters:

aClass - the class.

Returns:

the annotation; or null if it could not be found.

hasHandlerChainAnnotation

boolean hasHandlerChainAnnotation(java.lang.Class aClass)

Tests whether the given class has the HandlerChainAnnotation annotation.

Parameters:

aClass - the class.

Returns:

true> if present; false otherwise.

getHandlerChainAnnotation

HandlerChainAnnotation getHandlerChainAnnotation(java.lang.Class aClass)

Gets the HandlerChainAnnotation annotation from the given class, if found.

Parameters:

aClass - the class.

Returns:

the annotation; or null if it could not be found.

getServiceProperties

java.util.Map getServiceProperties(java.lang.Class clazz)

getInHandlers

java.util.Collection getInHandlers(java.lang.Class clazz)

getOutHandlers

java.util.Collection getOutHandlers(java.lang.Class clazz)

getFaultHandlers

java.util.Collection getFaultHandlers(java.lang.Class clazz)