org.codehaus.enunciate.contract.jaxws
Class ResponseWrapper

java.lang.Object
  org.codehaus.enunciate.contract.jaxws.ResponseWrapper

All Implemented Interfaces:

ImplicitRootElement, ImplicitSchemaElement, WebMessage, WebMessagePart

public class ResponseWrapper
extends java.lang.Object
implements WebMessage, WebMessagePart, ImplicitRootElement

A response wrapper for a web method in document/literal wrapped style.

Author:

Ryan Heaton

Nested Class Summary

Nested classes/interfaces inherited from interface org.codehaus.enunciate.contract.jaxws.WebMessagePart

WebMessagePart.ParticleType

Constructor Summary

ResponseWrapper(WebMethod webMethod)

Method Summary

java.util.Collection<ImplicitChildElement>	getChildElements() The collection of output parameters for this response.
java.lang.String	getElementDocs() Documentation explaining this is a response wrapper for its method.
java.lang.String	getElementName() The local name of the output.
java.lang.String	getElementNamespace() The local namespace of the output.
java.lang.String	getMessageDocs() Documentation explaining this is a response message for its method.
java.lang.String	getMessageName() The simple name of the method appended with "Response".
java.lang.String	getPartDocs() The documentation for this web message part.
javax.xml.namespace.QName	getParticleQName() The qname of the response element.
WebMessagePart.ParticleType	getParticleType() The particle type for this part.
java.lang.String	getPartName() The simple name of the method appended with "Response".
java.util.Collection<WebMessagePart>	getParts() There's only one part to a doc/lit response wrapper.
com.sun.mirror.util.SourcePosition	getPosition() The source position for this element, or null if none.
java.lang.String	getResponseBeanName() The name of the JAXWS response bean.
java.lang.String	getTargetNamespace() The target namespace;
javax.xml.namespace.QName	getTypeQName() The schema type for a response wrapper is always anonymous.
WebMethod	getWebMethod() Get the web method to which this response is associated.
boolean	isFault() Whether this message is a web fault.
boolean	isHeader() Whether this message is a header parameter.
boolean	isImplicitSchemaElement() Whether this web message part defines an implicit schema element.
boolean	isInput() Whether this is an input message.
boolean	isOutput() Whether this is an output message.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseWrapper

public ResponseWrapper(WebMethod webMethod)

Parameters:

webMethod - The web method to wrap.

Method Detail

getWebMethod

public WebMethod getWebMethod()

Get the web method to which this response is associated.

Specified by:

getWebMethod in interface WebMessagePart

Returns:

The web method to which this response is associated.

getResponseBeanName

public java.lang.String getResponseBeanName()

The name of the JAXWS response bean.

Returns:

The name of the JAXWS response bean.

getElementName

public java.lang.String getElementName()

The local name of the output.

Specified by:

getElementName in interface ImplicitSchemaElement

Returns:

The local name of the output.

getTargetNamespace

public java.lang.String getTargetNamespace()

Description copied from interface: ImplicitSchemaElement

The target namespace;

Specified by:

getTargetNamespace in interface ImplicitSchemaElement

Returns:

The target namespace;

getElementNamespace

public java.lang.String getElementNamespace()

The local namespace of the output.

Returns:

The local namespace of the output.

getElementDocs

public java.lang.String getElementDocs()

Documentation explaining this is a response wrapper for its method.

Specified by:

getElementDocs in interface ImplicitSchemaElement

Returns:

Documentation explaining this is a response wrapper for its method.

getParticleType

public WebMessagePart.ParticleType getParticleType()

Description copied from interface: WebMessagePart

The particle type for this part.

Specified by:

getParticleType in interface WebMessagePart

Returns:

WebMessagePart.ParticleType.ELEMENT

getParticleQName

public javax.xml.namespace.QName getParticleQName()

The qname of the response element.

Specified by:

getParticleQName in interface WebMessagePart

Returns:

The qname of the response element.

isImplicitSchemaElement

public boolean isImplicitSchemaElement()

Description copied from interface: WebMessagePart

Whether this web message part defines an implicit schema element.

Specified by:

isImplicitSchemaElement in interface WebMessagePart

Returns:

true.

getTypeQName

public javax.xml.namespace.QName getTypeQName()

The schema type for a response wrapper is always anonymous.

Specified by:

getTypeQName in interface ImplicitSchemaElement

Returns:

null

getChildElements

public java.util.Collection<ImplicitChildElement> getChildElements()

The collection of output parameters for this response.

Specified by:

getChildElements in interface ImplicitRootElement

Returns:

The collection of output parameters for this response.

getParts

public java.util.Collection<WebMessagePart> getParts()

There's only one part to a doc/lit response wrapper.

Specified by:

getParts in interface WebMessage

Returns:

this.

isInput

public boolean isInput()

Description copied from interface: WebMessage

Whether this is an input message.

Specified by:

isInput in interface WebMessage

Returns:

false

isOutput

public boolean isOutput()

Description copied from interface: WebMessage

Whether this is an output message.

Specified by:

isOutput in interface WebMessage

Returns:

true

isHeader

public boolean isHeader()

Description copied from interface: WebMessage

Whether this message is a header parameter.

Specified by:

isHeader in interface WebMessage

Returns:

false

isFault

public boolean isFault()

Description copied from interface: WebMessage

Whether this message is a web fault.

Specified by:

isFault in interface WebMessage

Returns:

false

getMessageName

public java.lang.String getMessageName()

The simple name of the method appended with "Response".

Specified by:

getMessageName in interface WebMessage

Returns:

The simple name of the method appended with "Response".

getMessageDocs

public java.lang.String getMessageDocs()

Documentation explaining this is a response message for its method.

Specified by:

getMessageDocs in interface WebMessage

Returns:

Documentation explaining this is a response message for its method.

getPartDocs

public java.lang.String getPartDocs()

Description copied from interface: WebMessagePart

The documentation for this web message part.

Specified by:

getPartDocs in interface WebMessagePart

Returns:

null

getPartName

public java.lang.String getPartName()

The simple name of the method appended with "Response".

Specified by:

getPartName in interface WebMessagePart

Returns:

The simple name of the method appended with "Response".

getPosition

public com.sun.mirror.util.SourcePosition getPosition()

Description copied from interface: ImplicitSchemaElement

The source position for this element, or null if none.

Specified by:

getPosition in interface ImplicitSchemaElement

Returns:

The source position for this element, or null if none.