Skip to content

Commit 7b6b6d8

Browse files
author
Gary Gregory
committed
Javadoc: Sentences end in a period.
1 parent 35a7340 commit 7b6b6d8

23 files changed

Lines changed: 133 additions & 133 deletions

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1852,7 +1852,7 @@ public static List<String> readLines(final Reader reader) throws IOException {
18521852
*
18531853
* @param name name of the desired resource
18541854
* @return the requested byte array
1855-
* @throws IOException if an I/O error occurs
1855+
* @throws IOException if an I/O error occurs.
18561856
*
18571857
* @since 2.6
18581858
*/
@@ -1871,7 +1871,7 @@ public static byte[] resourceToByteArray(final String name) throws IOException {
18711871
* @param name name of the desired resource
18721872
* @param classLoader the class loader that the resolution of the resource is delegated to
18731873
* @return the requested byte array
1874-
* @throws IOException if an I/O error occurs
1874+
* @throws IOException if an I/O error occurs.
18751875
*
18761876
* @since 2.6
18771877
*/
@@ -1891,7 +1891,7 @@ public static byte[] resourceToByteArray(final String name, final ClassLoader cl
18911891
* @param name name of the desired resource
18921892
* @param charset the charset to use, null means platform default
18931893
* @return the requested String
1894-
* @throws IOException if an I/O error occurs
1894+
* @throws IOException if an I/O error occurs.
18951895
*
18961896
* @since 2.6
18971897
*/
@@ -1912,7 +1912,7 @@ public static String resourceToString(final String name, final Charset charset)
19121912
* @param charset the charset to use, null means platform default
19131913
* @param classLoader the class loader that the resolution of the resource is delegated to
19141914
* @return the requested String
1915-
* @throws IOException if an I/O error occurs
1915+
* @throws IOException if an I/O error occurs.
19161916
*
19171917
* @since 2.6
19181918
*/
@@ -1930,7 +1930,7 @@ public static String resourceToString(final String name, final Charset charset,
19301930
*
19311931
* @param name name of the desired resource
19321932
* @return the requested URL
1933-
* @throws IOException if an I/O error occurs
1933+
* @throws IOException if an I/O error occurs.
19341934
*
19351935
* @since 2.6
19361936
*/
@@ -1949,7 +1949,7 @@ public static URL resourceToURL(final String name) throws IOException {
19491949
* @param name name of the desired resource
19501950
* @param classLoader the class loader that the resolution of the resource is delegated to
19511951
* @return the requested URL
1952-
* @throws IOException if an I/O error occurs
1952+
* @throws IOException if an I/O error occurs.
19531953
*
19541954
* @since 2.6
19551955
*/
@@ -2176,7 +2176,7 @@ public static void skipFully(final Reader reader, final long toSkip) throws IOEx
21762176
*
21772177
* @param input Stream to be fully buffered.
21782178
* @return A fully buffered stream.
2179-
* @throws IOException if an I/O error occurs
2179+
* @throws IOException if an I/O error occurs.
21802180
* @since 2.0
21812181
*/
21822182
public static InputStream toBufferedInputStream(final InputStream input) throws IOException {
@@ -2202,7 +2202,7 @@ public static InputStream toBufferedInputStream(final InputStream input) throws
22022202
* @param input Stream to be fully buffered.
22032203
* @param size the initial buffer size
22042204
* @return A fully buffered stream.
2205-
* @throws IOException if an I/O error occurs
2205+
* @throws IOException if an I/O error occurs.
22062206
* @since 2.5
22072207
*/
22082208
public static InputStream toBufferedInputStream(final InputStream input, final int size) throws IOException {

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ public static PathCounters copyDirectory(final Path sourceDirectory, final Path
236236
* @param targetFile The target file.
237237
* @param copyOptions Specifies how the copying should be done.
238238
* @return The target file
239-
* @throws IOException if an I/O error occurs
239+
* @throws IOException if an I/O error occurs.
240240
* @see Files#copy(InputStream, Path, CopyOption...)
241241
*/
242242
public static Path copyFile(final URL sourceFile, final Path targetFile, final CopyOption... copyOptions)
@@ -254,7 +254,7 @@ public static Path copyFile(final URL sourceFile, final Path targetFile, final C
254254
* @param targetDirectory The target directory.
255255
* @param copyOptions Specifies how the copying should be done.
256256
* @return The target file
257-
* @throws IOException if an I/O error occurs
257+
* @throws IOException if an I/O error occurs.
258258
* @see Files#copy(Path, Path, CopyOption...)
259259
*/
260260
public static Path copyFileToDirectory(final Path sourceFile, final Path targetDirectory,
@@ -269,7 +269,7 @@ public static Path copyFileToDirectory(final Path sourceFile, final Path targetD
269269
* @param targetDirectory The target directory.
270270
* @param copyOptions Specifies how the copying should be done.
271271
* @return The target file
272-
* @throws IOException if an I/O error occurs
272+
* @throws IOException if an I/O error occurs.
273273
* @see Files#copy(InputStream, Path, CopyOption...)
274274
*/
275275
public static Path copyFileToDirectory(final URL sourceFile, final Path targetDirectory,
@@ -300,7 +300,7 @@ public static PathCounters countDirectory(final Path directory) throws IOExcepti
300300
* @param path The path to a file (or directory).
301301
* @param attrs An optional list of file attributes to set atomically when creating the directories.
302302
* @return The Path for the {@code path}'s parent directory or null if the given path has no parent.
303-
* @throws IOException if an I/O error occurs
303+
* @throws IOException if an I/O error occurs.
304304
* @since 2.9.0
305305
*/
306306
public static Path createParentDirectories(final Path path, final FileAttribute<?>... attrs) throws IOException {
@@ -727,7 +727,7 @@ public static List<AclEntry> getAclEntryList(final Path sourcePath) throws IOExc
727727
*
728728
* @param path the file or directory to query.
729729
* @return whether the file or directory is empty.
730-
* @throws IOException if an I/O error occurs
730+
* @throws IOException if an I/O error occurs.
731731
*/
732732
public static boolean isEmpty(final Path path) throws IOException {
733733
return Files.isDirectory(path) ? isEmptyDirectory(path) : isEmptyFile(path);
@@ -738,7 +738,7 @@ public static boolean isEmpty(final Path path) throws IOException {
738738
*
739739
* @param directory the directory to query.
740740
* @return whether the directory is empty.
741-
* @throws IOException if an I/O error occurs
741+
* @throws IOException if an I/O error occurs.
742742
*/
743743
public static boolean isEmptyDirectory(final Path directory) throws IOException {
744744
try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(directory)) {
@@ -751,7 +751,7 @@ public static boolean isEmptyDirectory(final Path directory) throws IOException
751751
*
752752
* @param file the file to query.
753753
* @return whether the file is empty.
754-
* @throws IOException if an I/O error occurs
754+
* @throws IOException if an I/O error occurs.
755755
*/
756756
public static boolean isEmptyFile(final Path file) throws IOException {
757757
return Files.size(file) <= 0;
@@ -765,7 +765,7 @@ public static boolean isEmptyFile(final Path file) throws IOException {
765765
* @param options options indicating how symbolic links are handled * @return true if the {@code Path} exists and
766766
* has been modified after the given time reference.
767767
* @return true if the {@code Path} exists and has been modified after the given time reference.
768-
* @throws IOException if an I/O error occurs
768+
* @throws IOException if an I/O error occurs.
769769
* @throws NullPointerException if the file is {@code null}
770770
* @since 2.9.0
771771
*/
@@ -814,7 +814,7 @@ private static boolean overrideReadOnly(final DeleteOption... deleteOptions) {
814814
*
815815
* @param path the path to read.
816816
* @return the path attributes.
817-
* @throws IOException if an I/O error occurs
817+
* @throws IOException if an I/O error occurs.
818818
* @since 2.9.0
819819
*/
820820
public static BasicFileAttributes readBasicFileAttributes(final Path path) throws IOException {

src/main/java/org/apache/commons/io/input/BoundedInputStream.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ public BoundedInputStream(final InputStream in) {
8080
* the current position is less than the limit.
8181
* @return the byte read or -1 if the end of stream or
8282
* the limit has been reached.
83-
* @throws IOException if an I/O error occurs
83+
* @throws IOException if an I/O error occurs.
8484
*/
8585
@Override
8686
public int read() throws IOException {
@@ -97,7 +97,7 @@ public int read() throws IOException {
9797
* @param b the buffer to read the bytes into
9898
* @return the number of bytes read or -1 if the end of stream or
9999
* the limit has been reached.
100-
* @throws IOException if an I/O error occurs
100+
* @throws IOException if an I/O error occurs.
101101
*/
102102
@Override
103103
public int read(final byte[] b) throws IOException {
@@ -111,7 +111,7 @@ public int read(final byte[] b) throws IOException {
111111
* @param len The number of bytes to read
112112
* @return the number of bytes read or -1 if the end of stream or
113113
* the limit has been reached.
114-
* @throws IOException if an I/O error occurs
114+
* @throws IOException if an I/O error occurs.
115115
*/
116116
@Override
117117
public int read(final byte[] b, final int off, final int len) throws IOException {
@@ -133,7 +133,7 @@ public int read(final byte[] b, final int off, final int len) throws IOException
133133
* Invokes the delegate's {@code skip(long)} method.
134134
* @param n the number of bytes to skip
135135
* @return the actual number of bytes skipped
136-
* @throws IOException if an I/O error occurs
136+
* @throws IOException if an I/O error occurs.
137137
*/
138138
@Override
139139
public long skip(final long n) throws IOException {
@@ -166,7 +166,7 @@ public String toString() {
166166
/**
167167
* Invokes the delegate's {@code close()} method
168168
* if {@link #isPropagateClose()} is {@code true}.
169-
* @throws IOException if an I/O error occurs
169+
* @throws IOException if an I/O error occurs.
170170
*/
171171
@Override
172172
public void close() throws IOException {
@@ -177,7 +177,7 @@ public void close() throws IOException {
177177

178178
/**
179179
* Invokes the delegate's {@code reset()} method.
180-
* @throws IOException if an I/O error occurs
180+
* @throws IOException if an I/O error occurs.
181181
*/
182182
@Override
183183
public synchronized void reset() throws IOException {

src/main/java/org/apache/commons/io/input/CountingInputStream.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public CountingInputStream(final InputStream in) {
5151
*
5252
* @param length the number of bytes to skip
5353
* @return the actual number of bytes skipped
54-
* @throws IOException if an I/O error occurs
54+
* @throws IOException if an I/O error occurs.
5555
* @see java.io.InputStream#skip(long)
5656
*/
5757
@Override

src/main/java/org/apache/commons/io/input/ProxyInputStream.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public ProxyInputStream(final InputStream proxy) {
5353
/**
5454
* Invokes the delegate's {@code read()} method.
5555
* @return the byte read or -1 if the end of stream
56-
* @throws IOException if an I/O error occurs
56+
* @throws IOException if an I/O error occurs.
5757
*/
5858
@Override
5959
public int read() throws IOException {
@@ -72,7 +72,7 @@ public int read() throws IOException {
7272
* Invokes the delegate's {@code read(byte[])} method.
7373
* @param bts the buffer to read the bytes into
7474
* @return the number of bytes read or EOF if the end of stream
75-
* @throws IOException if an I/O error occurs
75+
* @throws IOException if an I/O error occurs.
7676
*/
7777
@Override
7878
public int read(final byte[] bts) throws IOException {
@@ -93,7 +93,7 @@ public int read(final byte[] bts) throws IOException {
9393
* @param off The start offset
9494
* @param len The number of bytes to read
9595
* @return the number of bytes read or -1 if the end of stream
96-
* @throws IOException if an I/O error occurs
96+
* @throws IOException if an I/O error occurs.
9797
*/
9898
@Override
9999
public int read(final byte[] bts, final int off, final int len) throws IOException {
@@ -112,7 +112,7 @@ public int read(final byte[] bts, final int off, final int len) throws IOExcepti
112112
* Invokes the delegate's {@code skip(long)} method.
113113
* @param ln the number of bytes to skip
114114
* @return the actual number of bytes skipped
115-
* @throws IOException if an I/O error occurs
115+
* @throws IOException if an I/O error occurs.
116116
*/
117117
@Override
118118
public long skip(final long ln) throws IOException {
@@ -127,7 +127,7 @@ public long skip(final long ln) throws IOException {
127127
/**
128128
* Invokes the delegate's {@code available()} method.
129129
* @return the number of available bytes
130-
* @throws IOException if an I/O error occurs
130+
* @throws IOException if an I/O error occurs.
131131
*/
132132
@Override
133133
public int available() throws IOException {
@@ -141,7 +141,7 @@ public int available() throws IOException {
141141

142142
/**
143143
* Invokes the delegate's {@code close()} method.
144-
* @throws IOException if an I/O error occurs
144+
* @throws IOException if an I/O error occurs.
145145
*/
146146
@Override
147147
public void close() throws IOException {
@@ -159,7 +159,7 @@ public synchronized void mark(final int readlimit) {
159159

160160
/**
161161
* Invokes the delegate's {@code reset()} method.
162-
* @throws IOException if an I/O error occurs
162+
* @throws IOException if an I/O error occurs.
163163
*/
164164
@Override
165165
public synchronized void reset() throws IOException {
@@ -228,7 +228,7 @@ protected void afterRead(final int n) throws IOException {
228228
* This method provides a point to implement custom exception
229229
* handling. The default behavior is to re-throw the exception.
230230
* @param e The IOException thrown
231-
* @throws IOException if an I/O error occurs
231+
* @throws IOException if an I/O error occurs.
232232
* @since 2.0
233233
*/
234234
protected void handleIOException(final IOException e) throws IOException {

src/main/java/org/apache/commons/io/input/ProxyReader.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public ProxyReader(final Reader proxy) {
5050
/**
5151
* Invokes the delegate's {@code read()} method.
5252
* @return the character read or -1 if the end of stream
53-
* @throws IOException if an I/O error occurs
53+
* @throws IOException if an I/O error occurs.
5454
*/
5555
@Override
5656
public int read() throws IOException {
@@ -69,7 +69,7 @@ public int read() throws IOException {
6969
* Invokes the delegate's {@code read(char[])} method.
7070
* @param chr the buffer to read the characters into
7171
* @return the number of characters read or -1 if the end of stream
72-
* @throws IOException if an I/O error occurs
72+
* @throws IOException if an I/O error occurs.
7373
*/
7474
@Override
7575
public int read(final char[] chr) throws IOException {
@@ -90,7 +90,7 @@ public int read(final char[] chr) throws IOException {
9090
* @param st The start offset
9191
* @param len The number of bytes to read
9292
* @return the number of characters read or -1 if the end of stream
93-
* @throws IOException if an I/O error occurs
93+
* @throws IOException if an I/O error occurs.
9494
*/
9595
@Override
9696
public int read(final char[] chr, final int st, final int len) throws IOException {
@@ -109,7 +109,7 @@ public int read(final char[] chr, final int st, final int len) throws IOExceptio
109109
* Invokes the delegate's {@code read(CharBuffer)} method.
110110
* @param target the char buffer to read the characters into
111111
* @return the number of characters read or -1 if the end of stream
112-
* @throws IOException if an I/O error occurs
112+
* @throws IOException if an I/O error occurs.
113113
* @since 2.0
114114
*/
115115
@Override
@@ -129,7 +129,7 @@ public int read(final CharBuffer target) throws IOException {
129129
* Invokes the delegate's {@code skip(long)} method.
130130
* @param ln the number of bytes to skip
131131
* @return the number of bytes to skipped or EOF if the end of stream
132-
* @throws IOException if an I/O error occurs
132+
* @throws IOException if an I/O error occurs.
133133
*/
134134
@Override
135135
public long skip(final long ln) throws IOException {
@@ -144,7 +144,7 @@ public long skip(final long ln) throws IOException {
144144
/**
145145
* Invokes the delegate's {@code ready()} method.
146146
* @return true if the stream is ready to be read
147-
* @throws IOException if an I/O error occurs
147+
* @throws IOException if an I/O error occurs.
148148
*/
149149
@Override
150150
public boolean ready() throws IOException {
@@ -158,7 +158,7 @@ public boolean ready() throws IOException {
158158

159159
/**
160160
* Invokes the delegate's {@code close()} method.
161-
* @throws IOException if an I/O error occurs
161+
* @throws IOException if an I/O error occurs.
162162
*/
163163
@Override
164164
public void close() throws IOException {
@@ -172,7 +172,7 @@ public void close() throws IOException {
172172
/**
173173
* Invokes the delegate's {@code mark(int)} method.
174174
* @param idx read ahead limit
175-
* @throws IOException if an I/O error occurs
175+
* @throws IOException if an I/O error occurs.
176176
*/
177177
@Override
178178
public synchronized void mark(final int idx) throws IOException {
@@ -185,7 +185,7 @@ public synchronized void mark(final int idx) throws IOException {
185185

186186
/**
187187
* Invokes the delegate's {@code reset()} method.
188-
* @throws IOException if an I/O error occurs
188+
* @throws IOException if an I/O error occurs.
189189
*/
190190
@Override
191191
public synchronized void reset() throws IOException {
@@ -254,7 +254,7 @@ protected void afterRead(final int n) throws IOException {
254254
* This method provides a point to implement custom exception
255255
* handling. The default behavior is to re-throw the exception.
256256
* @param e The IOException thrown
257-
* @throws IOException if an I/O error occurs
257+
* @throws IOException if an I/O error occurs.
258258
* @since 2.0
259259
*/
260260
protected void handleIOException(final IOException e) throws IOException {

0 commit comments

Comments
 (0)