Skip to content

Commit 33ab3ce

Browse files
committed
Javadoc: follow Niall's suggestion to make the Javadoc not so close to the Sun version.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@606435 13f79535-47bb-0310-9956-ffa450edef68
1 parent 98a3fa2 commit 33ab3ce

1 file changed

Lines changed: 10 additions & 13 deletions

File tree

src/java/org/apache/commons/io/CausedIOException.java

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,36 @@
3131
public class CausedIOException extends IOException {
3232

3333
/**
34-
* Default serial version UID.
34+
* Defines the serial version UID.
3535
*/
3636
private static final long serialVersionUID = 1L;
3737

3838
/**
39-
* Constructs a new instance with the specified detail message and cause.
39+
* Constructs a new instance with the given message and cause.
4040
* <p>
41-
* Note that the detail message associated with <code>cause</code> is <i>not</i> automatically incorporated in
42-
* this throwable's detail message.
41+
* As specified in {@link Throwable}, the message in the given <code>cause</code> is not used in this instance's
42+
* message.
4343
* </p>
4444
*
4545
* @param message
46-
* the detail message (which is saved for later retrieval by the {@link #getMessage()} method).
46+
* the message (see {@link #getMessage()})
4747
* @param cause
48-
* the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <code>null</code>
49-
* value is permitted, and indicates that the cause is nonexistent or unknown.)
48+
* the cause (see {@link #getCause()}). A <code>null</code> value is allowed.
5049
*/
5150
public CausedIOException(String message, Throwable cause) {
5251
super(message);
5352
this.initCause(cause);
5453
}
5554

5655
/**
57-
* Constructs a new exception with the specified cause and a detail message.
56+
* Constructs a new instance with the given cause.
5857
* <p>
59-
* The message is <code>(cause==null ? null : cause.toString())</code> (which typically contains the class and
60-
* detail message of <code>cause</code>). This constructor is useful for exceptions that are little more than
61-
* wrappers for other throwables (for example, {@link java.security.PrivilegedActionException}).
58+
* The message is set to <code>cause==null ? null : cause.toString()</code>, which by default contains the class
59+
* and message of <code>cause</code>. This constructor is useful for call sites that just wrap another throwable.
6260
* </p>
6361
*
6462
* @param cause
65-
* the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <code>null</code>
66-
* value is permitted, and indicates that the cause is nonexistent or unknown.)
63+
* the cause (see {@link #getCause()}). A <code>null</code> value is allowed.
6764
*/
6865
public CausedIOException(Throwable cause) {
6966
super(cause == null ? null : cause.toString());

0 commit comments

Comments
 (0)