src/share/jaxws_classes/javax/xml/ws/LogicalMessage.java

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


  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws;
  27 
  28 import javax.xml.transform.Source;
  29 import javax.xml.bind.JAXBContext;
  30 
  31 /** The <code>LogicalMessage</code> interface represents a
  32  *  protocol agnostic XML message and contains methods that
  33  *  provide access to the payload of the message.
  34  *
  35  *  @since JAX-WS 2.0
  36 **/
  37 public interface LogicalMessage {
  38 
  39   /** Gets the message payload as an XML source, may be called
  40    *  multiple times on the same LogicalMessage instance, always
  41    *  returns a new <code>Source</code> that may be used to retrieve the entire
  42    *  message payload.
  43    *
  44    *  <p>If the returned <code>Source</code> is an instance of
  45    *  <code>DOMSource</code>, then
  46    *  modifications to the encapsulated DOM tree change the message
  47    *  payload in-place, there is no need to susequently call
  48    *  <code>setPayload</code>. Other types of <code>Source</code> provide only
  49    *  read access to the message payload.
  50    *
  51    *  @return The contained message payload; returns <code>null</code> if no
  52    *          payload is present in this message.
  53   **/
  54   public Source getPayload();
  55 




  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.ws;
  27 
  28 import javax.xml.transform.Source;
  29 import javax.xml.bind.JAXBContext;
  30 
  31 /** The <code>LogicalMessage</code> interface represents a
  32  *  protocol agnostic XML message and contains methods that
  33  *  provide access to the payload of the message.
  34  *
  35  *  @since 1.6, JAX-WS 2.0
  36 **/
  37 public interface LogicalMessage {
  38 
  39   /** Gets the message payload as an XML source, may be called
  40    *  multiple times on the same LogicalMessage instance, always
  41    *  returns a new <code>Source</code> that may be used to retrieve the entire
  42    *  message payload.
  43    *
  44    *  <p>If the returned <code>Source</code> is an instance of
  45    *  <code>DOMSource</code>, then
  46    *  modifications to the encapsulated DOM tree change the message
  47    *  payload in-place, there is no need to susequently call
  48    *  <code>setPayload</code>. Other types of <code>Source</code> provide only
  49    *  read access to the message payload.
  50    *
  51    *  @return The contained message payload; returns <code>null</code> if no
  52    *          payload is present in this message.
  53   **/
  54   public Source getPayload();
  55