--- old/src/java.xml.ws/share/classes/javax/xml/soap/AttachmentPart.java 2015-04-21 17:20:14.756098477 +0400
+++ new/src/java.xml.ws/share/classes/javax/xml/soap/AttachmentPart.java 2015-04-21 17:20:14.612098477 +0400
@@ -32,54 +32,53 @@
import javax.activation.DataHandler;
/**
- * A single attachment to a SOAPMessage
object. A SOAPMessage
- * object may contain zero, one, or many AttachmentPart
objects.
- * Each AttachmentPart
object consists of two parts,
+ * A single attachment to a {@code SOAPMessage} object. A {@code SOAPMessage}
+ * object may contain zero, one, or many {@code AttachmentPart} objects.
+ * Each {@code AttachmentPart} object consists of two parts,
* application-specific content and associated MIME headers. The
* MIME headers consists of name/value pairs that can be used to
* identify and describe the content.
*
- * An AttachmentPart
object must conform to certain standards.
+ * An {@code AttachmentPart} object must conform to certain standards.
*
Content-Type
AttachmentPart
object and MUST conform to [RFC2045].
+ * {@code AttachmentPart} object and MUST conform to [RFC2045].
* The following is an example of a Content-Type header:
* * Content-Type: application/xml *- * The following line of code, in which
ap
is an
- * AttachmentPart
object, sets the header shown in
+ * The following line of code, in which {@code ap} is an
+ * {@code AttachmentPart} object, sets the header shown in
* the previous example.
* * ap.setMimeHeader("Content-Type", "application/xml"); *- *
*
- * There are no restrictions on the content portion of an
- * AttachmentPart
object. The content may be anything from a
+ * There are no restrictions on the content portion of an {@code
+ * AttachmentPart} object. The content may be anything from a
* simple plain text object to a complex XML document or image file.
*
*
- * An AttachmentPart
object is created with the method
- * SOAPMessage.createAttachmentPart
. After setting its MIME headers,
- * the AttachmentPart
object is added to the message
- * that created it with the method SOAPMessage.addAttachmentPart
.
+ * An {@code AttachmentPart} object is created with the method
+ * {@code SOAPMessage.createAttachmentPart}. After setting its MIME headers,
+ * the {@code AttachmentPart} object is added to the message
+ * that created it with the method {@code SOAPMessage.addAttachmentPart}.
*
*
- * The following code fragment, in which m
is a
- * SOAPMessage
object and contentStringl
is a
- * String
, creates an instance of AttachmentPart
,
- * sets the AttachmentPart
object with some content and
- * header information, and adds the AttachmentPart
object to
- * the SOAPMessage
object.
+ * The following code fragment, in which {@code m} is a
+ * {@code SOAPMessage} object and {@code contentStringl} is a
+ * {@code String}, creates an instance of {@code AttachmentPart},
+ * sets the {@code AttachmentPart} object with some content and
+ * header information, and adds the {@code AttachmentPart} object to
+ * the {@code SOAPMessage} object.
*
* AttachmentPart ap1 = m.createAttachmentPart(); * ap1.setContent(contentString1, "text/plain"); @@ -89,7 +88,7 @@ * ** The following code fragment creates and adds a second - *
AttachmentPart
instance to the same message.jpegData
+ * {@code AttachmentPart} instance to the same message. {@code jpegData} * is a binary byte buffer representing the jpeg file. ** AttachmentPart ap2 = m.createAttachmentPart(); @@ -98,19 +97,19 @@ * m.addAttachmentPart(ap2); **- * The
getContent
method retrieves the contents and header from - * anAttachmentPart
object. Depending on the - *DataContentHandler
objects present, the returned - *Object
can either be a typed Java object corresponding - * to the MIME type or anInputStream
object that contains the + * The {@code getContent} method retrieves the contents and header from + * an {@code AttachmentPart} object. Depending on the + * {@code DataContentHandler} objects present, the returned + * {@code Object} can either be a typed Java object corresponding + * to the MIME type or an {@code InputStream} object that contains the * content as bytes. ** String content1 = ap1.getContent(); * java.io.InputStream content2 = ap2.getContent(); ** - * The methodclearContent
removes all the content from an - *AttachmentPart
object but does not affect its header information. + * The method {@code clearContent} removes all the content from an + * {@code AttachmentPart} object but does not affect its header information. ** ap1.clearContent(); *@@ -120,10 +119,10 @@ public abstract class AttachmentPart { /** - * Returns the number of bytes in thisAttachmentPart
+ * Returns the number of bytes in this {@code AttachmentPart} * object. * - * @return the size of thisAttachmentPart
object in bytes + * @return the size of this {@code AttachmentPart} object in bytes * or -1 if the size cannot be determined * @exception SOAPException if the content of this attachment is * corrupted of if there was an exception while trying @@ -132,52 +131,52 @@ public abstract int getSize() throws SOAPException; /** - * Clears out the content of thisAttachmentPart
object. + * Clears out the content of this {@code AttachmentPart} object. * The MIME header portion is left untouched. */ public abstract void clearContent(); /** - * Gets the content of thisAttachmentPart
object as a Java + * Gets the content of this {@code AttachmentPart} object as a Java * object. The type of the returned Java object depends on (1) the - *DataContentHandler
object that is used to interpret the bytes - * and (2) theContent-Type
given in the header. + * {@code DataContentHandler} object that is used to interpret the bytes + * and (2) the {@code Content-Type} given in the header. ** For the MIME content types "text/plain", "text/html" and "text/xml", the - *
DataContentHandler
object does the conversions to and + * {@code DataContentHandler} object does the conversions to and * from the Java types corresponding to the MIME types. - * For other MIME types,theDataContentHandler
object - * can return anInputStream
object that contains the content data + * For other MIME types,the {@code DataContentHandler} object + * can return an {@code InputStream} object that contains the content data * as raw bytes. ** A SAAJ-compliant implementation must, as a minimum, return a - *
java.lang.String
object corresponding to any content - * stream with aContent-Type
value of - *text/plain
, a - *javax.xml.transform.stream.StreamSource
object corresponding to a - * content stream with aContent-Type
value of - *text/xml
, ajava.awt.Image
object + * {@code java.lang.String} object corresponding to any content + * stream with a {@code Content-Type} value of + * {@code text/plain}, a + * {@code javax.xml.transform.stream.StreamSource} object corresponding to a + * content stream with a {@code Content-Type} value of + * {@code text/xml}, a {@code java.awt.Image} object * corresponding to a content stream with a - *Content-Type
value ofimage/gif
or - *image/jpeg
. For those content types that an - * installedDataContentHandler
object does not understand, the - *DataContentHandler
object is required to return a - *java.io.InputStream
object with the raw bytes. + * {@code Content-Type} value of {@code image/gif} or + * {@code image/jpeg}. For those content types that an + * installed {@code DataContentHandler} object does not understand, the + * {@code DataContentHandler} object is required to return a + * {@code java.io.InputStream} object with the raw bytes. * - * @return a Java object with the content of thisAttachmentPart
+ * @return a Java object with the content of this {@code AttachmentPart} * object * * @exception SOAPException if there is no content set into this - *AttachmentPart
object or if there was a data + * {@code AttachmentPart} object or if there was a data * transformation error */ public abstract Object getContent() throws SOAPException; /** - * Gets the content of thisAttachmentPart
object as an - * InputStream as if a call had been made togetContent
and no - *DataContentHandler
had been registered for the - *content-type
of thisAttachmentPart
. + * Gets the content of this {@code AttachmentPart} object as an + * InputStream as if a call had been made to {@code getContent} and no + * {@code DataContentHandler} had been registered for the + * {@code content-type} of this {@code AttachmentPart}. ** Note that reading from the returned InputStream would result in consuming * the data in the stream. It is the responsibility of the caller to reset @@ -185,11 +184,11 @@ * of the raw attachment content is required then the {@link #getRawContentBytes} API * should be used instead. * - * @return an
InputStream
from which the raw data contained by - * theAttachmentPart
can be accessed. + * @return an {@code InputStream} from which the raw data contained by + * the {@code AttachmentPart} can be accessed. * * @throws SOAPException if there is no content set into this - *AttachmentPart
object or if there was a data + * {@code AttachmentPart} object or if there was a data * transformation error. * * @since 1.6, SAAJ 1.3 @@ -198,16 +197,16 @@ public abstract InputStream getRawContent() throws SOAPException; /** - * Gets the content of thisAttachmentPart
object as a - * byte[] array as if a call had been made togetContent
and no - *DataContentHandler
had been registered for the - *content-type
of thisAttachmentPart
. + * Gets the content of this {@code AttachmentPart} object as a + * byte[] array as if a call had been made to {@code getContent} and no + * {@code DataContentHandler} had been registered for the + * {@code content-type} of this {@code AttachmentPart}. * - * @return abyte[]
array containing the raw data of the - *AttachmentPart
. + * @return a {@code byte[]} array containing the raw data of the + * {@code AttachmentPart}. * * @throws SOAPException if there is no content set into this - *AttachmentPart
object or if there was a data + * {@code AttachmentPart} object or if there was a data * transformation error. * * @since 1.6, SAAJ 1.3 @@ -215,16 +214,16 @@ public abstract byte[] getRawContentBytes() throws SOAPException; /** - * Returns anInputStream
which can be used to obtain the - * content ofAttachmentPart
as Base64 encoded + * Returns an {@code InputStream} which can be used to obtain the + * content of {@code AttachmentPart} as Base64 encoded * character data, this method would base64 encode the raw bytes * of the attachment and return. * - * @return anInputStream
from which the Base64 encoded - *AttachmentPart
can be read. + * @return an {@code InputStream} from which the Base64 encoded + * {@code AttachmentPart} can be read. * * @throws SOAPException if there is no content set into this - *AttachmentPart
object or if there was a data + * {@code AttachmentPart} object or if there was a data * transformation error. * * @since 1.6, SAAJ 1.3 @@ -233,11 +232,11 @@ /** * Sets the content of this attachment part to that of the given - *Object
and sets the value of theContent-Type
+ * {@code Object} and sets the value of the {@code Content-Type} * header to the given type. The type of the - *Object
should correspond to the value given for the - *Content-Type
. This depends on the particular - * set ofDataContentHandler
objects in use. + * {@code Object} should correspond to the value given for the + * {@code Content-Type}. This depends on the particular + * set of {@code DataContentHandler} objects in use. * * * @param object the Java object that makes up the content for @@ -247,7 +246,7 @@ * * @exception IllegalArgumentException may be thrown if the contentType * does not match the type of the content object, or if there - * was noDataContentHandler
object for this + * was no {@code DataContentHandler} object for this * content object * * @see #getContent @@ -256,31 +255,31 @@ /** * Sets the content of this attachment part to that contained by the - *InputStream
content
and sets the value of the - *Content-Type
header to the value contained in - *contentType
. + * {@code InputStream} {@code content} and sets the value of the + * {@code Content-Type} header to the value contained in + * {@code contentType}. ** A subsequent call to getSize() may not be an exact measure * of the content size. * * @param content the raw data to add to the attachment part - * @param contentType the value to set into the
Content-Type
+ * @param contentType the value to set into the {@code Content-Type} * header * * @exception SOAPException if an there is an error in setting the content - * @exception NullPointerException ifcontent
is null + * @exception NullPointerException if {@code content} is null * @since 1.6, SAAJ 1.3 */ public abstract void setRawContent(InputStream content, String contentType) throws SOAPException; /** * Sets the content of this attachment part to that contained by the - *byte[]
arraycontent
and sets the value of the - *Content-Type
header to the value contained in - *contentType
. + * {@code byte[]} array {@code content} and sets the value of the + * {@code Content-Type} header to the value contained in + * {@code contentType}. * * @param content the raw data to add to the attachment part - * @param contentType the value to set into theContent-Type
+ * @param contentType the value to set into the {@code Content-Type} * header * @param offset the offset in the byte array of the content * @param len the number of bytes that form the content @@ -296,20 +295,20 @@ /** * Sets the content of this attachment part from the Base64 source - *InputStream
and sets the value of the - *Content-Type
header to the value contained in - *contentType
, This method would first decode the base64 + * {@code InputStream} and sets the value of the + * {@code Content-Type} header to the value contained in + * {@code contentType}, This method would first decode the base64 * input and write the resulting raw bytes to the attachment. ** A subsequent call to getSize() may not be an exact measure * of the content size. * * @param content the base64 encoded data to add to the attachment part - * @param contentType the value to set into the
Content-Type
+ * @param contentType the value to set into the {@code Content-Type} * header * * @exception SOAPException if an there is an error in setting the content - * @exception NullPointerException ifcontent
is null + * @exception NullPointerException if {@code content} is null * * @since 1.6, SAAJ 1.3 */ @@ -318,30 +317,30 @@ /** - * Gets theDataHandler
object for thisAttachmentPart
+ * Gets the {@code DataHandler} object for this {@code AttachmentPart} * object. * - * @return theDataHandler
object associated with this - *AttachmentPart
object + * @return the {@code DataHandler} object associated with this + * {@code AttachmentPart} object * * @exception SOAPException if there is no data in - * thisAttachmentPart
object + * this {@code AttachmentPart} object */ public abstract DataHandler getDataHandler() throws SOAPException; /** - * Sets the givenDataHandler
object as the data handler - * for thisAttachmentPart
object. Typically, on an incoming + * Sets the given {@code DataHandler} object as the data handler + * for this {@code AttachmentPart} object. Typically, on an incoming * message, the data handler is automatically set. When * a message is being created and populated with content, the - *setDataHandler
method can be used to get data from + * {@code setDataHandler} method can be used to get data from * various data sources into the message. * - * @param dataHandler theDataHandler
object to be set + * @param dataHandler the {@code DataHandler} object to be set * * @exception IllegalArgumentException if there was a problem with - * the specifiedDataHandler
object + * the specified {@code DataHandler} object */ public abstract void setDataHandler(DataHandler dataHandler); @@ -349,8 +348,8 @@ /** * Gets the value of the MIME header whose name is "Content-ID". * - * @return aString
giving the value of the - * "Content-ID" header ornull
if there + * @return a {@code String} giving the value of the + * "Content-ID" header or {@code null} if there * is none * @see #setContentId */ @@ -364,8 +363,8 @@ /** * Gets the value of the MIME header whose name is "Content-Location". * - * @return aString
giving the value of the - * "Content-Location" header ornull
if there + * @return a {@code String} giving the value of the + * "Content-Location" header or {@code null} if there * is none */ public String getContentLocation() { @@ -378,8 +377,8 @@ /** * Gets the value of the MIME header whose name is "Content-Type". * - * @return aString
giving the value of the - * "Content-Type" header ornull
if there + * @return a {@code String} giving the value of the + * "Content-Type" header or {@code null} if there * is none */ public String getContentType() { @@ -392,11 +391,11 @@ /** * Sets the MIME header whose name is "Content-ID" with the given value. * - * @param contentId aString
giving the value of the + * @param contentId a {@code String} giving the value of the * "Content-ID" header * * @exception IllegalArgumentException if there was a problem with - * the specifiedcontentId
value + * the specified {@code contentId} value * @see #getContentId */ public void setContentId(String contentId) @@ -409,7 +408,7 @@ * Sets the MIME header whose name is "Content-Location" with the given value. * * - * @param contentLocation aString
giving the value of the + * @param contentLocation a {@code String} giving the value of the * "Content-Location" header * @exception IllegalArgumentException if there was a problem with * the specified content location @@ -422,7 +421,7 @@ /** * Sets the MIME header whose name is "Content-Type" with the given value. * - * @param contentType aString
giving the value of the + * @param contentType a {@code String} giving the value of the * "Content-Type" header * * @exception IllegalArgumentException if there was a problem with @@ -449,10 +448,10 @@ /** * Gets all the values of the header identified by the given - *String
. + * {@code String}. * * @param name the name of the header; example: "Content-Type" - * @return aString
array giving the value for the + * @return a {@code String} array giving the value for the * specified header * @see #setMimeHeader */ @@ -466,9 +465,9 @@ * * Note that RFC822 headers can only contain US-ASCII characters. * - * @param name aString
giving the name of the header + * @param name a {@code String} giving the name of the header * for which to search - * @param value aString
giving the value to be set for + * @param value a {@code String} giving the value to be set for * the header whose name matches the given name * * @exception IllegalArgumentException if there was a problem with @@ -479,13 +478,13 @@ /** * Adds a MIME header with the specified name and value to this - *AttachmentPart
object. + * {@code AttachmentPart} object. ** Note that RFC822 headers can contain only US-ASCII characters. * - * @param name a
String
giving the name of the header + * @param name a {@code String} giving the name of the header * to be added - * @param value aString
giving the value of the header + * @param value a {@code String} giving the value of the header * to be added * * @exception IllegalArgumentException if there was a problem with @@ -494,35 +493,35 @@ public abstract void addMimeHeader(String name, String value); /** - * Retrieves all the headers for thisAttachmentPart
object - * as an iterator over theMimeHeader
objects. + * Retrieves all the headers for this {@code AttachmentPart} object + * as an iterator over the {@code MimeHeader} objects. * - * @return anIterator
object with all of the Mime - * headers for thisAttachmentPart
object + * @return an {@code Iterator} object with all of the Mime + * headers for this {@code AttachmentPart} object */ public abstract Iterator getAllMimeHeaders(); /** - * Retrieves allMimeHeader
objects that match a name in + * Retrieves all {@code MimeHeader} objects that match a name in * the given array. * - * @param names aString
array with the name(s) of the + * @param names a {@code String} array with the name(s) of the * MIME headers to be returned * @return all of the MIME headers that match one of the names in the - * given array as anIterator
object + * given array as an {@code Iterator} object */ public abstract Iterator getMatchingMimeHeaders(String[] names); /** - * Retrieves allMimeHeader
objects whose name does + * Retrieves all {@code MimeHeader} objects whose name does * not match a name in the given array. * - * @param names aString
array with the name(s) of the + * @param names a {@code String} array with the name(s) of the * MIME headers not to be returned - * @return all of the MIME headers in thisAttachmentPart
object + * @return all of the MIME headers in this {@code AttachmentPart} object * except those that match one of the names in the * given array. The nonmatching MIME headers are returned as an - *Iterator
object. + * {@code Iterator} object. */ public abstract Iterator getNonMatchingMimeHeaders(String[] names); }