xml/bind/Marshaller.java

36  * The {@code Marshaller} class is responsible for governing the process
47  *       Marshaller m = jc.createMarshaller();
156  * {@code Marshaller.marshal(java.lang.Object, ...)} methods must be a
159  * otherwise, a {@code Marshaller.marshal} method must throw a
164  * a {@code Marshaller.marshal} method. For java to schema binding, it
172  * By default, the Marshaller will use UTF-8 encoding when generating XML data
218  *               Marshaller will use "UTF-8" by default if this property is not
221  *   <dd>This property controls whether or not the Marshaller will format
225  *       The Marshaller will default to false (unformatted) if this
247  *       generated by the Marshaller.  If the property is not specified, the
251  *         <li>{@link #marshal(Object,org.xml.sax.ContentHandler) marshal(Object,ContentHandler)} - the Marshaller won't
256  *         <li>{@link #marshal(Object,java.io.OutputStream) marshal(Object,OutputStream)} - the Marshaller won't
258  *         <li>{@link #marshal(Object,java.io.Writer) marshal(Object,Writer)} - the Marshaller won't
263  *             Marshaller will not generate {@link javax.xml.stream.events.XMLEvent#START_DOCUMENT} and
266  *             Marshaller will not generate {@link javax.xml.stream.events.XMLEvent#START_DOCUMENT} and
277  * "The {@link Marshaller} provides two styles of callback mechanisms
289  *   // Invoked by Marshaller after it has created an instance of this object.
290  *   boolean beforeMarshal(Marshaller);
292  *   // Invoked by Marshaller after it has marshalled all properties of this object.
293  *   void afterMarshal(Marshaller);
300  * instance with a {@link Marshaller#setListener(Listener)}. The external listener receives all callback events,
316 public interface Marshaller {
375      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
376      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
397      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
398      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
419      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
420      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
442      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
443      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
464      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
465      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
490      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
491      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
513      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
514      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
537      *      {@code Marshaller} is unable to marshal {@code jaxbElement} (or any
538      *      object reachable from {@code jaxbElement}).  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#elementMarshalling">
575      * {@code Marshaller}.  This method can only be used to set one of
578      * a PropertyException being thrown.  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#supportedProps">
596      * {@code Marshaller}.  This method can only be used to get one of
599      * a PropertyException being thrown.  See <a href="{@docRoot}/javax/xml/bind/Marshaller.html#supportedProps">
623      * Calling this method with a null parameter will cause the Marshaller
731      *         invoked on an Marshaller created from a JAXBContext referencing
746      *         invoked on an Marshaller created from a JAXBContext referencing
754      * Register an instance of an implementation of this class with a {@link Marshaller} to externally listen
765      * See <a href="Marshaller.html#marshalEventCallback">Marshal Event Callbacks</a> for an overview.
767      * @see Marshaller#setListener(Listener)
768      * @see Marshaller#getListener()
803      * Register marshal event callback {@link Listener} with this {@link Marshaller}.
806      * There is only one Listener per Marshaller. Setting a Listener replaces the previous set Listener.
815      * <p>Return {@link Listener} registered with this {@link Marshaller}.
818      *         if no Listener is registered with this Marshaller.