com.sun.xml.bind.api

Class Bridge<T>

java.lang.Object

com.sun.xml.bind.api.Bridge<T>

public abstract class Bridge<T>
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected JAXBContextImpl	context

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Bridge(JAXBContextImpl context)

Method Summary

Modifier and Type	Method and Description
JAXBRIContext	getContext() Gets the JAXBRIContext to which this object belongs.
abstract TypeReference	getTypeReference() Gets the TypeReference from which this bridge was created.
void	marshal(BridgeContext context, T object, ContentHandler contentHandler)
void	marshal(BridgeContext context, T object, Node output)
void	marshal(BridgeContext context, T object, OutputStream output, NamespaceContext nsContext)
void	marshal(BridgeContext context, T object, Result result)
void	marshal(BridgeContext context, T object, XMLStreamWriter output)
abstract void	marshal(Marshaller m, T object, ContentHandler contentHandler)
abstract void	marshal(Marshaller m, T object, Node output)
abstract void	marshal(Marshaller m, T object, OutputStream output, NamespaceContext nsContext)
abstract void	marshal(Marshaller m, T object, Result result)
abstract void	marshal(Marshaller m, T object, XMLStreamWriter output)
void	marshal(T object, ContentHandler contentHandler)
void	marshal(T object, ContentHandler contentHandler, AttachmentMarshaller am)
void	marshal(T object, Node output)
void	marshal(T object, OutputStream output, NamespaceContext nsContext) Marshals the specified type object with the implicit element name associated with this instance of Bridge.
void	marshal(T object, OutputStream output, NamespaceContext nsContext, AttachmentMarshaller am)
void	marshal(T object, Result result)
void	marshal(T object, XMLStreamWriter output)
void	marshal(T object, XMLStreamWriter output, AttachmentMarshaller am)
T	unmarshal(BridgeContext context, InputStream in)
T	unmarshal(BridgeContext context, Node n)
T	unmarshal(BridgeContext context, Source in)
T	unmarshal(BridgeContext context, XMLStreamReader in)
T	unmarshal(InputStream in) Unmarshals the specified type object.
T	unmarshal(Node n) Unmarshals the specified type object.
T	unmarshal(Node n, AttachmentUnmarshaller au)
T	unmarshal(Source in) Unmarshals the specified type object.
T	unmarshal(Source in, AttachmentUnmarshaller au)
abstract T	unmarshal(Unmarshaller u, InputStream in)
abstract T	unmarshal(Unmarshaller context, Node n)
abstract T	unmarshal(Unmarshaller u, Source in)
abstract T	unmarshal(Unmarshaller u, XMLStreamReader in)
T	unmarshal(XMLStreamReader in) Unmarshals the specified type object.
T	unmarshal(XMLStreamReader in, AttachmentUnmarshaller au)

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final JAXBContextImpl context

Constructor Detail

Bridge

protected Bridge(JAXBContextImpl context)

Method Detail

getContext

@NotNull
public JAXBRIContext getContext()

Gets the JAXBRIContext to which this object belongs.

Since:

2.1

marshal

public final void marshal(T object,
                          XMLStreamWriter output)
                   throws JAXBException

Throws:

JAXBException - if there was an error while marshalling.

Since:

2.0 EA1

marshal

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

Throws:

JAXBException

marshal

public final void marshal(@NotNull
                          BridgeContext context,
                          T object,
                          XMLStreamWriter output)
                   throws JAXBException

Throws:

JAXBException

marshal

public abstract void marshal(@NotNull
                             Marshaller m,
                             T object,
                             XMLStreamWriter output)
                      throws JAXBException

Throws:

JAXBException

marshal

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

Marshals the specified type object with the implicit element name associated with this instance of Bridge.

Parameters:

nsContext - if this marshalling is done to marshal a subelement, this NamespaceContext represents in-scope namespace bindings available for that element. Can be null, in which case JAXB assumes no in-scope namespaces.

Throws:

JAXBException - if there was an error while marshalling.

Since:

2.0 EA1

marshal

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

Throws:

JAXBException

Since:

2.0.2

marshal

public final void marshal(@NotNull
                          BridgeContext context,
                          T object,
                          OutputStream output,
                          NamespaceContext nsContext)
                   throws JAXBException

Throws:

JAXBException

marshal

public abstract void marshal(@NotNull
                             Marshaller m,
                             T object,
                             OutputStream output,
                             NamespaceContext nsContext)
                      throws JAXBException

Throws:

JAXBException

marshal

public final void marshal(T object,
                          Node output)
                   throws JAXBException

Throws:

JAXBException

marshal

public final void marshal(@NotNull
                          BridgeContext context,
                          T object,
                          Node output)
                   throws JAXBException

Throws:

JAXBException

marshal

public abstract void marshal(@NotNull
                             Marshaller m,
                             T object,
                             Node output)
                      throws JAXBException

Throws:

JAXBException

marshal

public final void marshal(T object,
                          ContentHandler contentHandler)
                   throws JAXBException

Throws:

JAXBException

Since:

2.0 EA4

marshal

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

Throws:

JAXBException

Since:

2.0.2

marshal

public final void marshal(@NotNull
                          BridgeContext context,
                          T object,
                          ContentHandler contentHandler)
                   throws JAXBException

Throws:

JAXBException

marshal

public abstract void marshal(@NotNull
                             Marshaller m,
                             T object,
                             ContentHandler contentHandler)
                      throws JAXBException

Throws:

JAXBException

marshal

public final void marshal(T object,
                          Result result)
                   throws JAXBException

Throws:

JAXBException

Since:

2.0 EA4

marshal

public final void marshal(@NotNull
                          BridgeContext context,
                          T object,
                          Result result)
                   throws JAXBException

Throws:

JAXBException

marshal

public abstract void marshal(@NotNull
                             Marshaller m,
                             T object,
                             Result result)
                      throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  XMLStreamReader 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 Bridge is instanciated for.

Returns:

never null.

Throws:

JAXBException - if there was an error while unmarshalling.

Since:

2.0 EA1

unmarshal

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

Throws:

JAXBException

Since:

2.0.3

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  BridgeContext context,
                                  @NotNull
                                  XMLStreamReader in)
                           throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public abstract T unmarshal(@NotNull
                                     Unmarshaller u,
                                     @NotNull
                                     XMLStreamReader in)
                              throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  Source 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 Bridge is instanciated for.

Returns:

never null.

Throws:

JAXBException - if there was an error while unmarshalling.

Since:

2.0 EA1

unmarshal

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

Throws:

JAXBException

Since:

2.0.3

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  BridgeContext context,
                                  @NotNull
                                  Source in)
                           throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public abstract T unmarshal(@NotNull
                                     Unmarshaller u,
                                     @NotNull
                                     Source in)
                              throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public final 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 Bridge is instanciated for.

Returns:

never null.

Throws:

JAXBException - if there was an error while unmarshalling.

Since:

2.0 EA1

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  BridgeContext context,
                                  @NotNull
                                  InputStream in)
                           throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public abstract T unmarshal(@NotNull
                                     Unmarshaller u,
                                     @NotNull
                                     InputStream in)
                              throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  Node n)
                           throws JAXBException

Unmarshals the specified type object.

Parameters:

n - Node to be unmarshalled.

Returns:

never null.

Throws:

JAXBException - if there was an error while unmarshalling.

Since:

2.0 FCS

unmarshal

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

Throws:

JAXBException

Since:

2.0.3

unmarshal

@NotNull
public final T unmarshal(@NotNull
                                  BridgeContext context,
                                  @NotNull
                                  Node n)
                           throws JAXBException

Throws:

JAXBException

unmarshal

@NotNull
public abstract T unmarshal(@NotNull
                                     Unmarshaller context,
                                     @NotNull
                                     Node n)
                              throws JAXBException

Throws:

JAXBException

getTypeReference

public abstract TypeReference getTypeReference()

Gets the TypeReference from which this bridge was created.