org.codehaus.enunciate.contract.jaxws
Class WebMethod

java.lang.Object
  net.sf.jelly.apt.decorations.declaration.DecoratedDeclaration
      net.sf.jelly.apt.decorations.declaration.DecoratedMemberDeclaration
          net.sf.jelly.apt.decorations.declaration.DecoratedExecutableDeclaration
              net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration
                  org.codehaus.enunciate.contract.jaxws.WebMethod

All Implemented Interfaces:

com.sun.mirror.declaration.Declaration, com.sun.mirror.declaration.ExecutableDeclaration, com.sun.mirror.declaration.MemberDeclaration, com.sun.mirror.declaration.MethodDeclaration, java.lang.Comparable<WebMethod>

public class WebMethod
extends net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration
implements java.lang.Comparable<WebMethod>

A method invoked on a web service.

Author:

Ryan Heaton

Field Summary

Fields inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration

INHERITDOC_PATTERN

Fields inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedExecutableDeclaration

paramsComments, throwsComments

Fields inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedDeclaration

delegate, javaDoc

Constructor Summary

WebMethod(com.sun.mirror.declaration.MethodDeclaration delegate, EndpointInterface endpointInterface)

Method Summary

int	compareTo(WebMethod webMethod) Web methods must be unique by name.
java.lang.String	getAction() The action of this web method.
java.lang.String	getClientSimpleName() The simple name for client-side code generation.
EndpointInterface	getDeclaringEndpointInterface() The declaring web service for this web method.
java.util.Collection<WebMessage>	getMessages() The messages of this web method.
java.lang.String	getOperationName() The operation name of this web method.
java.util.Set<java.lang.String>	getReferencedNamespaces() A set of the reference namespace for this method.
RequestWrapper	getRequestWrapper() The request wrapper.
ResponseWrapper	getResponseWrapper() The response wrapper, or null if none.
com.sun.mirror.type.TypeMirror	getReturnType()
javax.jws.soap.SOAPBinding.Style	getSoapBindingStyle() The SOAP binding style of this web method.
javax.jws.soap.SOAPBinding.ParameterStyle	getSoapParameterStyle() The SOAP parameter style of this web method.
javax.jws.soap.SOAPBinding.Use	getSoapUse() The SOAP binding use of this web method.
java.util.Collection<WebFault>	getWebFaults() The list of web faults thrown by this method.
java.util.Collection<WebParam>	getWebParameters() The list of web parameters for this method.
WebResult	getWebResult() The web result of this web method.
boolean	isDocLitWrapped() Determine whether this web method is doc/lit wrapped.
boolean	isOneWay() Whether this web method is one-way.

Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration

accept, commentNeedsReplacement, constructJavaDoc, getPropertyName, isGetter, isSetter

Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedExecutableDeclaration

getFormalTypeParameters, getParameters, getThrownTypes, isVarArgs, parseParamComments

Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedMemberDeclaration

getDeclaringType

Methods inherited from class net.sf.jelly.apt.decorations.declaration.DecoratedDeclaration

equals, getAnnotation, getAnnotationMirrors, getAnnotations, getDelegate, getDocComment, getDocValue, getJavaDoc, getModifiers, getPosition, getSimpleName, isAbstract, isFinal, isNative, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sun.mirror.declaration.ExecutableDeclaration

getFormalTypeParameters, getParameters, getThrownTypes, isVarArgs

Methods inherited from interface com.sun.mirror.declaration.MemberDeclaration

getDeclaringType

Methods inherited from interface com.sun.mirror.declaration.Declaration

equals, getAnnotation, getAnnotationMirrors, getDocComment, getModifiers, getPosition, getSimpleName

Constructor Detail

WebMethod

public WebMethod(com.sun.mirror.declaration.MethodDeclaration delegate,
                 EndpointInterface endpointInterface)

Method Detail

getClientSimpleName

public java.lang.String getClientSimpleName()

The simple name for client-side code generation.

Returns:

The simple name for client-side code generation.

getReturnType

public com.sun.mirror.type.TypeMirror getReturnType()

Specified by:

getReturnType in interface com.sun.mirror.declaration.MethodDeclaration

Overrides:

getReturnType in class net.sf.jelly.apt.decorations.declaration.DecoratedMethodDeclaration

getWebResult

public WebResult getWebResult()

The web result of this web method.

Returns:

The web result of this web method.

getWebParameters

public java.util.Collection<WebParam> getWebParameters()

The list of web parameters for this method.

Returns:

The list of web parameters for this method.

getWebFaults

public java.util.Collection<WebFault> getWebFaults()

The list of web faults thrown by this method.

Returns:

The list of web faults thrown by this method.

getMessages

public java.util.Collection<WebMessage> getMessages()

The messages of this web method.

Returns:

The messages of this web method.

getRequestWrapper

public RequestWrapper getRequestWrapper()

The request wrapper.

Returns:

The request wrapper, or null if none.

getResponseWrapper

public ResponseWrapper getResponseWrapper()

The response wrapper, or null if none.

Returns:

The response wrapper, or null if none.

getReferencedNamespaces

public java.util.Set<java.lang.String> getReferencedNamespaces()

A set of the reference namespace for this method.

Returns:

A set of the reference namespace for this method.

getOperationName

public java.lang.String getOperationName()

The operation name of this web method.

Returns:

The operation name of this web method.

getAction

public java.lang.String getAction()

The action of this web method.

Returns:

The action of this web method.

isOneWay

public boolean isOneWay()

Whether this web method is one-way.

Returns:

Whether this web method is one-way.

getSoapBindingStyle

public javax.jws.soap.SOAPBinding.Style getSoapBindingStyle()

The SOAP binding style of this web method.

Returns:

The SOAP binding style of this web method.

getDeclaringEndpointInterface

public EndpointInterface getDeclaringEndpointInterface()

The declaring web service for this web method.

Returns:

The declaring web service for this web method.

getSoapUse

public javax.jws.soap.SOAPBinding.Use getSoapUse()

The SOAP binding use of this web method.

Returns:

The SOAP binding use of this web method.

getSoapParameterStyle

public javax.jws.soap.SOAPBinding.ParameterStyle getSoapParameterStyle()

The SOAP parameter style of this web method.

Returns:

The SOAP parameter style of this web method.

isDocLitWrapped

public boolean isDocLitWrapped()

Determine whether this web method is doc/lit wrapped.

Returns:

Whether this web method is doc/lit wrapped.

compareTo

public int compareTo(WebMethod webMethod)

Web methods must be unique by name. (JSR 181: 3.1.1)

Specified by:

compareTo in interface java.lang.Comparable<WebMethod>

Parameters:

webMethod - The web method to compare this to.

Returns:

The comparison.