Corrected Javadoc typo ('writen' -> 'written')

This commit is contained in:
Rick Evans
2007-05-28 14:23:24 +00:00
parent 8b2f33d549
commit d069a7fdaf

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2005 the original author or authors.
* Copyright 2005-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,8 +23,8 @@ import javax.xml.transform.Source;
/**
* Represents a protocol-agnostic XML message.
* <p/>
* Contains methods that provide access to the payload of the message.
*
* <p>Contains methods that provide access to the payload of the message.
*
* @author Arjen Poutsma
* @see org.springframework.ws.soap.SoapMessage
@@ -34,8 +34,8 @@ public interface WebServiceMessage {
/**
* Returns the contents of the message as a {@link Source}.
* <p/>
* Depending on the implementation, this can be retrieved multiple times, or just a single time.
* <p> Depending on the implementation, this can be retrieved multiple times,
* or just a single time.
*
* @return the message contents
*/
@@ -43,8 +43,7 @@ public interface WebServiceMessage {
/**
* Returns the contents of the message as a {@link Result}.
* <p/>
* Implementations that are read-only will throw an {@link UnsupportedOperationException}.
* <p>Implementations that are read-only will throw an {@link UnsupportedOperationException}.
*
* @return the message contents
* @throws UnsupportedOperationException if the message is read-only
@@ -52,8 +51,10 @@ public interface WebServiceMessage {
Result getPayloadResult();
/**
* Writes the entire message to the given output stream. If the given stream is an instance of {@link
* org.springframework.ws.transport.TransportOutputStream}, the corresponding headers will be writen as well.
* Writes the entire message to the given output stream.
* <p>If the given stream is an instance of
* {@link org.springframework.ws.transport.TransportOutputStream}, the
* corresponding headers will be written as well.
*
* @param outputStream the stream to write to
* @throws IOException if an I/O exception occurs
@@ -63,14 +64,15 @@ public interface WebServiceMessage {
/**
* Does this message have a fault?
*
* @return <code>true</code> if the message has a fault; <code>false</code> otherwise
* @return <code>true</code> if the message has a fault.
* @see #getFaultReason()
*/
boolean hasFault();
/**
* Returns the fault reason message, if any. Returns <code>null</code> when no fault is present.
* Returns the fault reason message.
*
* @return the fault reason message, if any; returns <code>null</code> when no fault is present.
* @see #hasFault()
*/
String getFaultReason();