src/share/jaxws_classes/javax/xml/bind/Marshaller.java
Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:
*** 309,319 ****
*
* @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul>
* @see JAXBContext
* @see Validator
* @see Unmarshaller
! * @since JAXB1.0
*/
public interface Marshaller {
/**
* The name of the property used to specify the output encoding in
--- 309,319 ----
*
* @author <ul><li>Kohsuke Kawaguchi, Sun Microsystems, Inc.</li><li>Ryan Shoemaker, Sun Microsystems, Inc.</li><li>Joe Fialli, Sun Microsystems, Inc.</li></ul>
* @see JAXBContext
* @see Validator
* @see Unmarshaller
! * @since 1.6, JAXB 1.0
*/
public interface Marshaller {
/**
* The name of the property used to specify the output encoding in
*** 419,429 ****
* <tt>Marshaller</tt> is unable to marshal <tt>obj</tt> (or any
* object reachable from <tt>obj</tt>). See <a href="#elementMarshalling">
* Marshalling a JAXB element</a>.
* @throws IllegalArgumentException
* If any of the method parameters are null
! * @since JAXB2.1
*/
public void marshal( Object jaxbElement, File output )
throws JAXBException;
/**
--- 419,429 ----
* <tt>Marshaller</tt> is unable to marshal <tt>obj</tt> (or any
* object reachable from <tt>obj</tt>). See <a href="#elementMarshalling">
* Marshalling a JAXB element</a>.
* @throws IllegalArgumentException
* If any of the method parameters are null
! * @since 1.6, JAXB 2.1
*/
public void marshal( Object jaxbElement, File output )
throws JAXBException;
/**
*** 513,523 ****
* <tt>Marshaller</tt> is unable to marshal <tt>obj</tt> (or any
* object reachable from <tt>obj</tt>). See <a href="#elementMarshalling">
* Marshalling a JAXB element</a>.
* @throws IllegalArgumentException
* If any of the method parameters are null
! * @since JAXB 2.0
*/
public void marshal( Object jaxbElement, javax.xml.stream.XMLStreamWriter writer )
throws JAXBException;
/**
--- 513,523 ----
* <tt>Marshaller</tt> is unable to marshal <tt>obj</tt> (or any
* object reachable from <tt>obj</tt>). See <a href="#elementMarshalling">
* Marshalling a JAXB element</a>.
* @throws IllegalArgumentException
* If any of the method parameters are null
! * @since 1.6, JAXB 2.0
*/
public void marshal( Object jaxbElement, javax.xml.stream.XMLStreamWriter writer )
throws JAXBException;
/**
*** 537,547 ****
* <tt>Marshaller</tt> is unable to marshal <tt>obj</tt> (or any
* object reachable from <tt>obj</tt>). See <a href="#elementMarshalling">
* Marshalling a JAXB element</a>.
* @throws IllegalArgumentException
* If any of the method parameters are null
! * @since JAXB 2.0
*/
public void marshal( Object jaxbElement, javax.xml.stream.XMLEventWriter writer )
throws JAXBException;
/**
--- 537,547 ----
* <tt>Marshaller</tt> is unable to marshal <tt>obj</tt> (or any
* object reachable from <tt>obj</tt>). See <a href="#elementMarshalling">
* Marshalling a JAXB element</a>.
* @throws IllegalArgumentException
* If any of the method parameters are null
! * @since 1.6, JAXB 2.0
*/
public void marshal( Object jaxbElement, javax.xml.stream.XMLEventWriter writer )
throws JAXBException;
/**
*** 653,663 ****
* @see #setAdapter(Class,XmlAdapter)
* @throws IllegalArgumentException
* if the adapter parameter is null.
* @throws UnsupportedOperationException
* if invoked agains a JAXB 1.0 implementation.
! * @since JAXB 2.0
*/
public void setAdapter( XmlAdapter adapter );
/**
* Associates a configured instance of {@link XmlAdapter} with this marshaller.
--- 653,663 ----
* @see #setAdapter(Class,XmlAdapter)
* @throws IllegalArgumentException
* if the adapter parameter is null.
* @throws UnsupportedOperationException
* if invoked agains a JAXB 1.0 implementation.
! * @since 1.6, JAXB 2.0
*/
public void setAdapter( XmlAdapter adapter );
/**
* Associates a configured instance of {@link XmlAdapter} with this marshaller.
*** 682,692 ****
* the current adapter set for this type.
* @throws IllegalArgumentException
* if the type parameter is null.
* @throws UnsupportedOperationException
* if invoked agains a JAXB 1.0 implementation.
! * @since JAXB 2.0
*/
public <A extends XmlAdapter> void setAdapter( Class<A> type, A adapter );
/**
* Gets the adapter associated with the specified type.
--- 682,692 ----
* the current adapter set for this type.
* @throws IllegalArgumentException
* if the type parameter is null.
* @throws UnsupportedOperationException
* if invoked agains a JAXB 1.0 implementation.
! * @since 1.6, JAXB 2.0
*/
public <A extends XmlAdapter> void setAdapter( Class<A> type, A adapter );
/**
* Gets the adapter associated with the specified type.
*** 695,705 ****
*
* @throws IllegalArgumentException
* if the type parameter is null.
* @throws UnsupportedOperationException
* if invoked agains a JAXB 1.0 implementation.
! * @since JAXB 2.0
*/
public <A extends XmlAdapter> A getAdapter( Class<A> type );
/**
--- 695,705 ----
*
* @throws IllegalArgumentException
* if the type parameter is null.
* @throws UnsupportedOperationException
* if invoked agains a JAXB 1.0 implementation.
! * @since 1.6, JAXB 2.0
*/
public <A extends XmlAdapter> A getAdapter( Class<A> type );
/**
*** 728,738 ****
*
* @param schema Schema object to validate marshal operations against or null to disable validation
* @throws UnsupportedOperationException could be thrown if this method is
* invoked on an Marshaller created from a JAXBContext referencing
* JAXB 1.0 mapped classes
! * @since JAXB2.0
*/
public void setSchema( Schema schema );
/**
* Get the JAXP 1.3 {@link javax.xml.validation.Schema Schema} object
--- 728,738 ----
*
* @param schema Schema object to validate marshal operations against or null to disable validation
* @throws UnsupportedOperationException could be thrown if this method is
* invoked on an Marshaller created from a JAXBContext referencing
* JAXB 1.0 mapped classes
! * @since 1.6, JAXB 2.0
*/
public void setSchema( Schema schema );
/**
* Get the JAXP 1.3 {@link javax.xml.validation.Schema Schema} object
*** 743,753 ****
* @return the Schema object being used to perform marshal-time
* validation or null if not present.
* @throws UnsupportedOperationException could be thrown if this method is
* invoked on an Marshaller created from a JAXBContext referencing
* JAXB 1.0 mapped classes
! * @since JAXB2.0
*/
public Schema getSchema();
/**
* <p/>
--- 743,753 ----
* @return the Schema object being used to perform marshal-time
* validation or null if not present.
* @throws UnsupportedOperationException could be thrown if this method is
* invoked on an Marshaller created from a JAXBContext referencing
* JAXB 1.0 mapped classes
! * @since 1.6, JAXB 2.0
*/
public Schema getSchema();
/**
* <p/>
*** 764,774 ****
* External listener is one of two different mechanisms for defining marshal event callbacks.
* See <a href="Marshaller.html#marshalEventCallback">Marshal Event Callbacks</a> for an overview.
*
* @see Marshaller#setListener(Listener)
* @see Marshaller#getListener()
! * @since JAXB2.0
*/
public static abstract class Listener {
/**
* <p/>
* Callback method invoked before marshalling from <tt>source</tt> to XML.
--- 764,774 ----
* External listener is one of two different mechanisms for defining marshal event callbacks.
* See <a href="Marshaller.html#marshalEventCallback">Marshal Event Callbacks</a> for an overview.
*
* @see Marshaller#setListener(Listener)
* @see Marshaller#getListener()
! * @since 1.6, JAXB 2.0
*/
public static abstract class Listener {
/**
* <p/>
* Callback method invoked before marshalling from <tt>source</tt> to XML.
*** 805,821 ****
* <p>
* There is only one Listener per Marshaller. Setting a Listener replaces the previous set Listener.
* One can unregister current Listener by setting listener to <tt>null</tt>.
*
* @param listener an instance of a class that implements {@link Listener}
! * @since JAXB2.0
*/
public void setListener(Listener listener);
/**
* <p>Return {@link Listener} registered with this {@link Marshaller}.
*
* @return registered {@link Listener} or <code>null</code> if no Listener is registered with this Marshaller.
! * @since JAXB2.0
*/
public Listener getListener();
}
--- 805,821 ----
* <p>
* There is only one Listener per Marshaller. Setting a Listener replaces the previous set Listener.
* One can unregister current Listener by setting listener to <tt>null</tt>.
*
* @param listener an instance of a class that implements {@link Listener}
! * @since 1.6, JAXB 2.0
*/
public void setListener(Listener listener);
/**
* <p>Return {@link Listener} registered with this {@link Marshaller}.
*
* @return registered {@link Listener} or <code>null</code> if no Listener is registered with this Marshaller.
! * @since 1.6, JAXB 2.0
*/
public Listener getListener();
}