src/share/jaxws_classes/javax/xml/bind/attachment/AttachmentMarshaller.java

Print this page
rev 507 : 8047724: @since tag cleanup in jaxws
Reviewed-by:


  33  *
  34  * <p>This API enables an efficient cooperative creation of optimized
  35  * binary data formats between a JAXB marshalling process and a MIME-based package
  36  * processor. A JAXB implementation marshals the root body of a MIME-based package,
  37  * delegating the creation of referenceable MIME parts to
  38  * the MIME-based package processor that implements this abstraction.</p>
  39  *
  40  * <p>XOP processing is enabled when {@link #isXOPPackage()} is true.
  41  *    See {@link #addMtomAttachment(DataHandler, String, String)} for details.
  42  * </p>
  43  *
  44  * <p>WS-I Attachment Profile 1.0 is supported by
  45  * {@link #addSwaRefAttachment(DataHandler)} being called by the
  46  * marshaller for each JAXB property related to
  47  * {http://ws-i.org/profiles/basic/1.1/xsd}swaRef.</p>
  48  *
  49  *
  50  * @author Marc Hadley
  51  * @author Kohsuke Kawaguchi
  52  * @author Joseph Fialli
  53  * @since JAXB 2.0
  54  *
  55  * @see Marshaller#setAttachmentMarshaller(AttachmentMarshaller)
  56  *
  57  * @see <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Packaging</a>
  58  * @see <a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html">WS-I Attachments Profile Version 1.0.</a>
  59  */
  60 public abstract class AttachmentMarshaller {
  61 
  62     /**
  63      * <p>Consider MIME content <code>data</code> for optimized binary storage as an attachment.
  64      *
  65      * <p>
  66      * This method is called by JAXB marshal process when {@link #isXOPPackage()} is
  67      * <code>true</code>, for each element whose datatype is "base64Binary", as described in
  68      * Step 3 in
  69      * <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages">Creating XOP Packages</a>.
  70      *
  71      * <p>
  72      * The method implementor determines whether <code>data</code> shall be attached separately
  73      * or inlined as base64Binary data. If the implementation chooses to optimize the storage




  33  *
  34  * <p>This API enables an efficient cooperative creation of optimized
  35  * binary data formats between a JAXB marshalling process and a MIME-based package
  36  * processor. A JAXB implementation marshals the root body of a MIME-based package,
  37  * delegating the creation of referenceable MIME parts to
  38  * the MIME-based package processor that implements this abstraction.</p>
  39  *
  40  * <p>XOP processing is enabled when {@link #isXOPPackage()} is true.
  41  *    See {@link #addMtomAttachment(DataHandler, String, String)} for details.
  42  * </p>
  43  *
  44  * <p>WS-I Attachment Profile 1.0 is supported by
  45  * {@link #addSwaRefAttachment(DataHandler)} being called by the
  46  * marshaller for each JAXB property related to
  47  * {http://ws-i.org/profiles/basic/1.1/xsd}swaRef.</p>
  48  *
  49  *
  50  * @author Marc Hadley
  51  * @author Kohsuke Kawaguchi
  52  * @author Joseph Fialli
  53  * @since 1.6, JAXB 2.0
  54  *
  55  * @see Marshaller#setAttachmentMarshaller(AttachmentMarshaller)
  56  *
  57  * @see <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/">XML-binary Optimized Packaging</a>
  58  * @see <a href="http://www.ws-i.org/Profiles/AttachmentsProfile-1.0-2004-08-24.html">WS-I Attachments Profile Version 1.0.</a>
  59  */
  60 public abstract class AttachmentMarshaller {
  61 
  62     /**
  63      * <p>Consider MIME content <code>data</code> for optimized binary storage as an attachment.
  64      *
  65      * <p>
  66      * This method is called by JAXB marshal process when {@link #isXOPPackage()} is
  67      * <code>true</code>, for each element whose datatype is "base64Binary", as described in
  68      * Step 3 in
  69      * <a href="http://www.w3.org/TR/2005/REC-xop10-20050125/#creating_xop_packages">Creating XOP Packages</a>.
  70      *
  71      * <p>
  72      * The method implementor determines whether <code>data</code> shall be attached separately
  73      * or inlined as base64Binary data. If the implementation chooses to optimize the storage