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
 HandlerChainAnnotation getHandlerChainAnnotation(java.lang.Class aClass)
          Gets the HandlerChainAnnotation annotation from the given class, if found.
 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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.


Copyright © 2004-2006 null. All Rights Reserved.