Skip to content

Commit 0f2c3bc

Browse files
committed
Javadoc
1 parent 5035e97 commit 0f2c3bc

63 files changed

Lines changed: 141 additions & 136 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/main/java/org/apache/commons/io/IOExceptionList.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ private static String toMessage(final List<? extends Throwable> causeList) {
6565
private final List<? extends Throwable> causeList;
6666

6767
/**
68-
* Creates a new exception caused by a list of exceptions.
68+
* Constructs a new exception caused by a list of exceptions.
6969
*
7070
* @param causeList a list of cause exceptions.
7171
*/
@@ -74,7 +74,7 @@ public IOExceptionList(final List<? extends Throwable> causeList) {
7474
}
7575

7676
/**
77-
* Creates a new exception caused by a list of exceptions.
77+
* Constructs a new exception caused by a list of exceptions.
7878
*
7979
* @param message The detail message, see {@link #getMessage()}.
8080
* @param causeList a list of cause exceptions.

src/main/java/org/apache/commons/io/IOIndexedException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ protected static String toMessage(final int index, final Throwable cause) {
4545
private final int index;
4646

4747
/**
48-
* Creates a new exception.
48+
* Constructs a new exception.
4949
*
5050
* @param index index of this exception.
5151
* @param cause cause exceptions.

src/main/java/org/apache/commons/io/RandomAccessFileMode.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public enum RandomAccessFileMode {
5757
}
5858

5959
/**
60-
* Creates a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
60+
* Constructs a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
6161
* argument.
6262
*
6363
* @param file the file object
@@ -69,7 +69,7 @@ public RandomAccessFile create(final File file) throws FileNotFoundException {
6969
}
7070

7171
/**
72-
* Creates a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
72+
* Constructs a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
7373
* argument.
7474
*
7575
* @param file the file object
@@ -81,7 +81,7 @@ public RandomAccessFile create(final Path file) throws FileNotFoundException {
8181
}
8282

8383
/**
84-
* Creates a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
84+
* Constructs a random access file stream to read from, and optionally to write to, the file specified by the {@link File}
8585
* argument.
8686
*
8787
* @param file the file object

src/main/java/org/apache/commons/io/TaggedIOException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public static void throwCauseIfTaggedWith(final Throwable throwable, final Objec
103103
private final Serializable tag;
104104

105105
/**
106-
* Creates a tagged wrapper for the given exception.
106+
* Constructs a tagged wrapper for the given exception.
107107
*
108108
* @param original the exception to be tagged
109109
* @param tag tag of this exception

src/main/java/org/apache/commons/io/UncheckedIOExceptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
final class UncheckedIOExceptions {
3030

3131
/**
32-
* Creates a new UncheckedIOException for the given detail message.
32+
* Constructs a new UncheckedIOException for the given detail message.
3333
* <p>
3434
* This method exists because there is no String constructor in {@link UncheckedIOException}.
3535
* </p>
@@ -43,7 +43,7 @@ public static UncheckedIOException create(final Object message) {
4343
}
4444

4545
/**
46-
* Creates a new UncheckedIOException for the given detail message.
46+
* Constructs a new UncheckedIOException for the given detail message.
4747
* <p>
4848
* This method exists because there is no String constructor in {@link UncheckedIOException}.
4949
* </p>

src/main/java/org/apache/commons/io/build/AbstractOriginSupplier.java

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
public abstract class AbstractOriginSupplier<T, B extends AbstractOriginSupplier<T, B>> extends AbstractSupplier<T, B> {
4747

4848
/**
49-
* Creates a new byte array origin for a byte array.
49+
* Constructs a new byte array origin for a byte array.
5050
*
5151
* @param origin the byte array.
5252
* @return a new byte array origin.
@@ -56,7 +56,7 @@ protected static ByteArrayOrigin newByteArrayOrigin(final byte[] origin) {
5656
}
5757

5858
/**
59-
* Creates a new CharSequence origin for a CharSequence.
59+
* Constructs a new CharSequence origin for a CharSequence.
6060
*
6161
* @param origin the CharSequence.
6262
* @return a new file origin.
@@ -67,7 +67,7 @@ protected static CharSequenceOrigin newCharSequenceOrigin(final CharSequence ori
6767
}
6868

6969
/**
70-
* Creates a new file origin for a file.
70+
* Constructs a new file origin for a file.
7171
*
7272
* @param origin the file.
7373
* @return a new file origin.
@@ -77,7 +77,7 @@ protected static FileOrigin newFileOrigin(final File origin) {
7777
}
7878

7979
/**
80-
* Creates a new file origin for a file path.
80+
* Constructs a new file origin for a file path.
8181
*
8282
* @param origin the file path.
8383
* @return a new file origin.
@@ -87,7 +87,7 @@ protected static FileOrigin newFileOrigin(final String origin) {
8787
}
8888

8989
/**
90-
* Creates a new input stream origin for a file.
90+
* Constructs a new input stream origin for a file.
9191
*
9292
* @param origin the input stream.
9393
* @return a new input stream origin.
@@ -97,7 +97,7 @@ protected static InputStreamOrigin newInputStreamOrigin(final InputStream origin
9797
}
9898

9999
/**
100-
* Creates a new output stream origin for a file.
100+
* Constructs a new output stream origin for a file.
101101
*
102102
* @param origin the output stream.
103103
* @return a new output stream origin.
@@ -107,7 +107,7 @@ protected static OutputStreamOrigin newOutputStreamOrigin(final OutputStream ori
107107
}
108108

109109
/**
110-
* Creates a new path origin for a file.
110+
* Constructs a new path origin for a file.
111111
*
112112
* @param origin the path.
113113
* @return a new path origin.
@@ -117,7 +117,7 @@ protected static PathOrigin newPathOrigin(final Path origin) {
117117
}
118118

119119
/**
120-
* Creates a new path name origin for a path name.
120+
* Constructs a new path name origin for a path name.
121121
*
122122
* @param origin the path name.
123123
* @return a new path name origin.
@@ -127,7 +127,7 @@ protected static PathOrigin newPathOrigin(final String origin) {
127127
}
128128

129129
/**
130-
* Creates a new reader origin for a reader.
130+
* Constructs a new reader origin for a reader.
131131
*
132132
* @param origin the reader.
133133
* @return a new reader origin.
@@ -137,7 +137,7 @@ protected static ReaderOrigin newReaderOrigin(final Reader origin) {
137137
}
138138

139139
/**
140-
* Creates a new reader origin for a URI.
140+
* Constructs a new reader origin for a URI.
141141
*
142142
* @param origin the URI.
143143
* @return a new URI origin.
@@ -147,7 +147,7 @@ protected static URIOrigin newURIOrigin(final URI origin) {
147147
}
148148

149149
/**
150-
* Creates a new writer origin for a file.
150+
* Constructs a new writer origin for a file.
151151
*
152152
* @param origin the writer.
153153
* @return a new writer .

src/main/java/org/apache/commons/io/file/AccumulatorPathVisitor.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
public class AccumulatorPathVisitor extends CountingPathVisitor {
6262

6363
/**
64-
* Creates a new instance configured with a BigInteger {@link PathCounters}.
64+
* Constructs a new instance configured with a BigInteger {@link PathCounters}.
6565
*
6666
* @return a new instance configured with a BigInteger {@link PathCounters}.
6767
*/
@@ -70,7 +70,7 @@ public static AccumulatorPathVisitor withBigIntegerCounters() {
7070
}
7171

7272
/**
73-
* Creates a new instance configured with a BigInteger {@link PathCounters}.
73+
* Constructs a new instance configured with a BigInteger {@link PathCounters}.
7474
*
7575
* @param fileFilter Filters files to accumulate and count.
7676
* @param dirFilter Filters directories to accumulate and count.
@@ -83,7 +83,7 @@ public static AccumulatorPathVisitor withBigIntegerCounters(final PathFilter fil
8383
}
8484

8585
/**
86-
* Creates a new instance configured with a long {@link PathCounters}.
86+
* Constructs a new instance configured with a long {@link PathCounters}.
8787
*
8888
* @return a new instance configured with a long {@link PathCounters}.
8989
*/
@@ -92,7 +92,7 @@ public static AccumulatorPathVisitor withLongCounters() {
9292
}
9393

9494
/**
95-
* Creates a new instance configured with a long {@link PathCounters}.
95+
* Constructs a new instance configured with a long {@link PathCounters}.
9696
*
9797
* @param fileFilter Filters files to accumulate and count.
9898
* @param dirFilter Filters directories to accumulate and count.

src/main/java/org/apache/commons/io/file/CleaningPathVisitor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
public class CleaningPathVisitor extends CountingPathVisitor {
3737

3838
/**
39-
* Creates a new instance configured with a BigInteger {@link PathCounters}.
39+
* Constructs a new instance configured with a BigInteger {@link PathCounters}.
4040
*
4141
* @return a new instance configured with a BigInteger {@link PathCounters}.
4242
*/
@@ -45,7 +45,7 @@ public static CountingPathVisitor withBigIntegerCounters() {
4545
}
4646

4747
/**
48-
* Creates a new instance configured with a long {@link PathCounters}.
48+
* Constructs a new instance configured with a long {@link PathCounters}.
4949
*
5050
* @return a new instance configured with a long {@link PathCounters}.
5151
*/

src/main/java/org/apache/commons/io/file/CountingPathVisitor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ static IOFileFilter defaultFileFilter() {
4949
}
5050

5151
/**
52-
* Creates a new instance configured with a {@link BigInteger} {@link PathCounters}.
52+
* Constructs a new instance configured with a {@link BigInteger} {@link PathCounters}.
5353
*
5454
* @return a new instance configured with a {@link BigInteger} {@link PathCounters}.
5555
*/
@@ -58,7 +58,7 @@ public static CountingPathVisitor withBigIntegerCounters() {
5858
}
5959

6060
/**
61-
* Creates a new instance configured with a {@code long} {@link PathCounters}.
61+
* Constructs a new instance configured with a {@code long} {@link PathCounters}.
6262
*
6363
* @return a new instance configured with a {@code long} {@link PathCounters}.
6464
*/

src/main/java/org/apache/commons/io/file/DeletingPathVisitor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
public class DeletingPathVisitor extends CountingPathVisitor {
3838

3939
/**
40-
* Creates a new instance configured with a BigInteger {@link PathCounters}.
40+
* Constructs a new instance configured with a BigInteger {@link PathCounters}.
4141
*
4242
* @return a new instance configured with a BigInteger {@link PathCounters}.
4343
*/
@@ -46,7 +46,7 @@ public static DeletingPathVisitor withBigIntegerCounters() {
4646
}
4747

4848
/**
49-
* Creates a new instance configured with a long {@link PathCounters}.
49+
* Constructs a new instance configured with a long {@link PathCounters}.
5050
*
5151
* @return a new instance configured with a long {@link PathCounters}.
5252
*/

0 commit comments

Comments
 (0)