Module com.sun.xml.ws.jaxws

Package com.sun.xml.ws.spi.db

Interface XMLBridge<T>

All Known Implementing Classes:

RepeatedElementBridge, WrapperBridge

public interface XMLBridge<T>

The XMLBridge is a Glassfish JAXWS side of Glassfish JAXB Bridge. Mini-marshaller/unmarshaller that is specialized for a particular element name and a type.

Instances of this class is stateless and multi-thread safe. They are reentrant.

All the marshal operation generates fragments.

Subject to change without notice.

Since:

JAXB 2.0 EA1

Author:

Kohsuke Kawaguchi, shih-chang.chen@oracle.com

Method Summary

Modifier and Type	Method	Description
BindingContext	context()	Gets the BindingContext to which this object belongs.
TypeInfo	getTypeInfo()	Gets the TypeInfo from which this bridge was created.
void	marshal(T object, OutputStream output, NamespaceContext nsContext, AttachmentMarshaller am)
void	marshal(T object, XMLStreamWriter output, AttachmentMarshaller am)
void	marshal(T object, Result result)
void	marshal(T object, Node output)
void	marshal(T object, ContentHandler contentHandler, AttachmentMarshaller am)
boolean	supportOutputStream()	This can be used to determine whether XMLStreamWriter or OutputStream is prefered by the implementation.
T	unmarshal(InputStream in)	Unmarshals the specified type object.
T	unmarshal(XMLStreamReader in, AttachmentUnmarshaller au)
T	unmarshal(Source in, AttachmentUnmarshaller au)
T	unmarshal(Node n, AttachmentUnmarshaller au)

Method Detail

context

@NotNull
BindingContext context()

Gets the BindingContext to which this object belongs.

Since:

2.1

marshal

void marshal(T object,
             XMLStreamWriter output,
             AttachmentMarshaller am)
      throws JAXBException

Throws:

JAXBException - if there was an error while marshalling.

Since:

2.0 EA1

marshal

void marshal(T object,
             OutputStream output,
             NamespaceContext nsContext,
             AttachmentMarshaller am)
      throws JAXBException

Throws:

JAXBException

Since:

2.0.2

marshal

void marshal(T object,
             Node output)
      throws JAXBException

Throws:

JAXBException

marshal

void marshal(T object,
             ContentHandler contentHandler,
             AttachmentMarshaller am)
      throws JAXBException

Throws:

JAXBException

Since:

2.0.2

marshal

void marshal(T object,
             Result result)
      throws JAXBException

Throws:

JAXBException

Since:

2.0 EA4

unmarshal

@NotNull
T unmarshal(@NotNull
            XMLStreamReader in,
            @Nullable
            AttachmentUnmarshaller au)
     throws JAXBException

Throws:

JAXBException

Since:

2.0.3

unmarshal

@NotNull
T unmarshal(@NotNull
            Source in,
            @Nullable
            AttachmentUnmarshaller au)
     throws JAXBException

Throws:

JAXBException

Since:

2.0.3

unmarshal

@NotNull
T unmarshal(@NotNull
            InputStream in)
     throws JAXBException

Unmarshals the specified type object.

Parameters:

in - the parser must be pointing at a start tag that encloses the XML type that this XMLBridge is instanciated for.

Returns:

never null.

Throws:

JAXBException - if there was an error while unmarshalling.

Since:

2.0 EA1

unmarshal

@NotNull
T unmarshal(@NotNull
            Node n,
            @Nullable
            AttachmentUnmarshaller au)
     throws JAXBException

Throws:

JAXBException

Since:

2.0.3

getTypeInfo

TypeInfo getTypeInfo()

Gets the TypeInfo from which this bridge was created.

supportOutputStream

boolean supportOutputStream()

This can be used to determine whether XMLStreamWriter or OutputStream is prefered by the implementation.

Returns:

true if marshall to OutputStream is supported in the implementation.