org.codehaus.enunciate.contract.jaxws
Class WebResult

java.lang.Object
  net.sf.jelly.apt.decorations.type.DecoratedTypeMirror
      org.codehaus.enunciate.contract.jaxws.WebResult

All Implemented Interfaces:

com.sun.mirror.type.TypeMirror, Adaptable, ImplicitChildElement, ImplicitSchemaElement, WebMessage, WebMessagePart

public class WebResult
extends net.sf.jelly.apt.decorations.type.DecoratedTypeMirror
implements Adaptable, WebMessage, WebMessagePart, ImplicitChildElement

A decorated type mirror that is a web result.

Author:

Ryan Heaton

Nested Class Summary

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

WebMessagePart.ParticleType

Field Summary

Fields inherited from class net.sf.jelly.apt.decorations.type.DecoratedTypeMirror

delegate

Constructor Summary

protected

WebResult(com.sun.mirror.type.TypeMirror delegate, WebMethod method)

Method Summary

void	accept(com.sun.mirror.util.TypeVisitor typeVisitor)
AdapterType	getAdapterType() The class type of the adaptor.
java.lang.String	getElementDocs() The element docs.
java.lang.String	getElementName() The element name.
java.lang.String	getMaxOccurs() The max occurs of the web result.
java.lang.String	getMessageDocs() There is only message documentation if this web result is BARE.
java.lang.String	getMessageName() The message name in the case of a document/bare service.
java.lang.String	getMimeType() The mime type for this child element (for binary data), or null if not applicable.
int	getMinOccurs() The min occurs of a web result.
javax.jws.WebParam.Mode	getMode() The mode of this web result.
java.lang.String	getName() The name of the web result.
java.lang.String	getPartDocs() If this web result is a part, the comments for the result.
javax.xml.namespace.QName	getParticleQName() The qname of the particle for this web result.
WebMessagePart.ParticleType	getParticleType() If the web method style is RPC, the particle type is TYPE.
java.lang.String	getPartName() The part name.
java.util.Collection<WebMessagePart>	getParts() The parts of this complex input/output.
com.sun.mirror.util.SourcePosition	getPosition() The source position for this element, or null if none.
java.lang.String	getTargetNamespace() The namespace of the web result.
com.sun.mirror.type.TypeMirror	getType() Used when treating this as a parameter.
javax.xml.namespace.QName	getTypeQName() The qname of the type of this result as an implicit schema element.
WebMethod	getWebMethod() The web method.
XmlType	getXmlType() Gets the xml type of this result.
boolean	isAdapted() Whether this element is adapted according to the JAXB spec.
boolean	isBare() Whether this is a bare web result.
boolean	isFault() Whether this message is a web fault.
boolean	isHeader() Whether this message is a header parameter.
boolean	isImplicitSchemaElement() This web result defines an implicit schema element if it is of DOCUMENT binding style and it is either BARE or a header.
boolean	isInput() Whether this is an input message.
boolean	isOutput() Whether this is an output message.
boolean	isSwaRef() Whether this child element is an attachment ref.
boolean	isVoid()

Methods inherited from class net.sf.jelly.apt.decorations.type.DecoratedTypeMirror

equals, getDelegate, getDocComment, getDocValue, isAnnotation, isArray, isClass, isCollection, isDeclared, isEnum, isInstanceOf, isInterface, isPrimitive, isReferenceType, isTypeVariable, isWildcard, setDocComment, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WebResult

protected WebResult(com.sun.mirror.type.TypeMirror delegate,
                    WebMethod method)

Method Detail

accept

public void accept(com.sun.mirror.util.TypeVisitor typeVisitor)

Specified by:

accept in interface com.sun.mirror.type.TypeMirror

Overrides:

accept in class net.sf.jelly.apt.decorations.type.DecoratedTypeMirror

getName

public java.lang.String getName()

The name of the web result.

Returns:

The name of the web result.

getTargetNamespace

public java.lang.String getTargetNamespace()

The namespace of the web result.

Specified by:

getTargetNamespace in interface ImplicitSchemaElement

Returns:

The namespace of the web result.

getPartName

public java.lang.String getPartName()

The part name.

Specified by:

getPartName in interface WebMessagePart

Returns:

The part name.

getWebMethod

public WebMethod getWebMethod()

The web method.

Specified by:

getWebMethod in interface WebMessagePart

Returns:

The web method.

isBare

public boolean isBare()

Whether this is a bare web result.

Returns:

Whether this is a bare web result.

getMode

public javax.jws.WebParam.Mode getMode()

The mode of this web result.

Returns:

The mode of this web result.

getMessageName

public java.lang.String getMessageName()

The message name in the case of a document/bare service.

Specified by:

getMessageName in interface WebMessage

Returns:

The message name in the case of a document/bare service.

getMessageDocs

public java.lang.String getMessageDocs()

There is only message documentation if this web result is BARE.

Specified by:

getMessageDocs in interface WebMessage

Returns:

The documentation if BARE, null otherwise.

isInput

public boolean isInput()

Description copied from interface: WebMessage

Whether this is an input message.

Specified by:

isInput in interface WebMessage

Returns:

Whether this is an input message.

isOutput

public boolean isOutput()

Description copied from interface: WebMessage

Whether this is an output message.

Specified by:

isOutput in interface WebMessage

Returns:

Whether this is an output message.

isHeader

public boolean isHeader()

Description copied from interface: WebMessage

Whether this message is a header parameter.

Specified by:

isHeader in interface WebMessage

Returns:

Whether this message is a header parameter.

isFault

public boolean isFault()

Description copied from interface: WebMessage

Whether this message is a web fault.

Specified by:

isFault in interface WebMessage

Returns:

Whether this message is a web fault.

getPartDocs

public java.lang.String getPartDocs()

If this web result is a part, the comments for the result.

Specified by:

getPartDocs in interface WebMessagePart

Returns:

The part docs.

getParticleType

public WebMessagePart.ParticleType getParticleType()

If the web method style is RPC, the particle type is TYPE. Otherwise, it's ELEMENT.

Specified by:

getParticleType in interface WebMessagePart

Returns:

The particle type.

getParticleQName

public javax.xml.namespace.QName getParticleQName()

The qname of the particle for this web result. If the particle type is TYPE then it's the qname of the xml type. Otherwise, it's the qname of the implicit schema element.

Specified by:

getParticleQName in interface WebMessagePart

Returns:

The qname of the particle for this web result as a part.

isImplicitSchemaElement

public boolean isImplicitSchemaElement()

This web result defines an implicit schema element if it is of DOCUMENT binding style and it is either BARE or a header.

Specified by:

isImplicitSchemaElement in interface WebMessagePart

Returns:

Whether this web result is an implicit schema element.

getParts

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

Description copied from interface: WebMessage

The parts of this complex input/output.

Specified by:

getParts in interface WebMessage

Returns:

The parts of this complex input/output.

getTypeQName

public javax.xml.namespace.QName getTypeQName()

The qname of the type of this result as an implicit schema element.

Specified by:

getTypeQName in interface ImplicitChildElement

Specified by:

getTypeQName in interface ImplicitSchemaElement

Returns:

The qname of the type of this result.

Throws:

ValidationException - If the type is anonymous or otherwise problematic.

getXmlType

public XmlType getXmlType()

Gets the xml type of this result.

Specified by:

getXmlType in interface ImplicitChildElement

Returns:

The xml type of this result.

getMimeType

public java.lang.String getMimeType()

Description copied from interface: ImplicitChildElement

The mime type for this child element (for binary data), or null if not applicable.

Specified by:

getMimeType in interface ImplicitChildElement

Returns:

The mime type or null.

isSwaRef

public boolean isSwaRef()

Description copied from interface: ImplicitChildElement

Whether this child element is an attachment ref.

Specified by:

isSwaRef in interface ImplicitChildElement

Returns:

Whether this child element is an attachment ref.

getMinOccurs

public int getMinOccurs()

The min occurs of a web result.

Specified by:

getMinOccurs in interface ImplicitChildElement

Returns:

1 if primitive. 0 otherwise.

getMaxOccurs

public java.lang.String getMaxOccurs()

The max occurs of the web result.

Specified by:

getMaxOccurs in interface ImplicitChildElement

Returns:

The max occurs.

getElementName

public java.lang.String getElementName()

The element name.

Specified by:

getElementName in interface ImplicitSchemaElement

Returns:

The element name.

getElementDocs

public java.lang.String getElementDocs()

The element docs.

Specified by:

getElementDocs in interface ImplicitSchemaElement

Returns:

The element docs.

getType

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

Used when treating this as a parameter.

Specified by:

getType in interface ImplicitChildElement

Returns:

The delegate.

isAdapted

public boolean isAdapted()

Description copied from interface: Adaptable

Whether this element is adapted according to the JAXB spec.

Specified by:

isAdapted in interface Adaptable

Returns:

Whether the element is adapted.

getAdapterType

public AdapterType getAdapterType()

Description copied from interface: Adaptable

The class type of the adaptor.

Specified by:

getAdapterType in interface Adaptable

Returns:

The class type of the adaptor.

isVoid

public boolean isVoid()

Overrides:

isVoid in class net.sf.jelly.apt.decorations.type.DecoratedTypeMirror

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.