svn commit: r733292 - /webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/Attachments.java

[ve...@apache.org]

Author: veithen
Date: Sat Jan 10 07:58:00 2009
New Revision: 733292

URL: http://svn.apache.org/viewvc?rev=733292&view=rev
Log:
Improved Javadoc.

Modified:
    webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/Attachments.java

Modified: webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/Attachments.java
URL: http://svn.apache.org/viewvc/webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/Attachments.java?rev=733292&r1=733291&r2=733292&view=diff
==============================================================================
--- webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/Attachments.java (original)
+++ webservices/commons/trunk/modules/axiom/modules/axiom-api/src/main/java/org/apache/axiom/attachments/Attachments.java Sat Jan 10 07:58:00 2009
@@ -306,8 +306,13 @@
     }
 
     /**
-     * @return whether Message Type is SOAP with Attachments or MTOM optimized, by checking the
-     *         application type parameter in the Content Type.
+     * Identify the type of message (MTOM or SOAP with attachments) represented by this
+     * object.
+     * 
+     * @return One of the {@link MTOMConstants#MTOM_TYPE}, {@link MTOMConstants#SWA_TYPE}
+     *         or {@link MTOMConstants#SWA_TYPE_12} constants.
+     * @throws OMException if the message doesn't have one of the supported types, i.e. is
+     *         neither MTOM nor SOAP with attachments
      */
     public String getAttachmentSpecType() {
         if (this.applicationType == null) {