Skip to content

Commit 896a441

Browse files
garydgregorygarydgregory
committed
Javadoc
1 parent d76a0b2 commit 896a441

File tree

1 file changed

+47
-47
lines changed

1 file changed

+47
-47
lines changed

‎src/main/java/org/apache/commons/io/output/FileWriterWithEncoding.java‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,11 @@ private FileWriterWithEncoding(final Builder builder) throws IOException {
208208
/**
209209
* Constructs a FileWriterWithEncoding with a file encoding.
210210
*
211-
* @param file the file to write to, not null
212-
* @param charset the encoding to use, not null
213-
* @throws NullPointerException if the file or encoding is null
214-
* @throws IOException in case of an I/O error
215-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
211+
* @param file the file to write to, not null.
212+
* @param charset the encoding to use, not null.
213+
* @throws NullPointerException if the file or encoding is null.
214+
* @throws IOException in case of an I/O error.
215+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
216216
*/
217217
@Deprecated
218218
public FileWriterWithEncoding(final File file, final Charset charset) throws IOException {
@@ -227,7 +227,7 @@ public FileWriterWithEncoding(final File file, final Charset charset) throws IOE
227227
* @param append true if content should be appended, false to overwrite.
228228
* @throws NullPointerException if the file is null.
229229
* @throws IOException in case of an I/O error.
230-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
230+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
231231
*/
232232
@Deprecated
233233
@SuppressWarnings("resource") // Call site is responsible for closing a new instance.
@@ -242,7 +242,7 @@ public FileWriterWithEncoding(final File file, final Charset encoding, final boo
242242
* @param charsetEncoder the encoding to use, not null
243243
* @throws NullPointerException if the file or encoding is null
244244
* @throws IOException in case of an I/O error
245-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
245+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
246246
*/
247247
@Deprecated
248248
public FileWriterWithEncoding(final File file, final CharsetEncoder charsetEncoder) throws IOException {
@@ -257,7 +257,7 @@ public FileWriterWithEncoding(final File file, final CharsetEncoder charsetEncod
257257
* @param append true if content should be appended, false to overwrite.
258258
* @throws NullPointerException if the file is null.
259259
* @throws IOException in case of an I/O error.
260-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
260+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
261261
*/
262262
@Deprecated
263263
@SuppressWarnings("resource") // Call site is responsible for closing a new instance.
@@ -268,11 +268,11 @@ public FileWriterWithEncoding(final File file, final CharsetEncoder charsetEncod
268268
/**
269269
* Constructs a FileWriterWithEncoding with a file encoding.
270270
*
271-
* @param file the file to write to, not null
272-
* @param charsetName the name of the requested charset, not null
273-
* @throws NullPointerException if the file or encoding is null
274-
* @throws IOException in case of an I/O error
275-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
271+
* @param file the file to write to, not null.
272+
* @param charsetName the name of the requested charset, not null.
273+
* @throws NullPointerException if the file or encoding is null.
274+
* @throws IOException in case of an I/O error.
275+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
276276
*/
277277
@Deprecated
278278
public FileWriterWithEncoding(final File file, final String charsetName) throws IOException {
@@ -287,7 +287,7 @@ public FileWriterWithEncoding(final File file, final String charsetName) throws
287287
* @param append true if content should be appended, false to overwrite.
288288
* @throws NullPointerException if the file is null.
289289
* @throws IOException in case of an I/O error.
290-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
290+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
291291
*/
292292
@Deprecated
293293
@SuppressWarnings("resource") // Call site is responsible for closing a new instance.
@@ -302,11 +302,11 @@ private FileWriterWithEncoding(final OutputStreamWriter outputStreamWriter) {
302302
/**
303303
* Constructs a FileWriterWithEncoding with a file encoding.
304304
*
305-
* @param fileName the name of the file to write to, not null
306-
* @param charset the charset to use, not null
307-
* @throws NullPointerException if the file name or encoding is null
308-
* @throws IOException in case of an I/O error
309-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
305+
* @param fileName the name of the file to write to, not null.
306+
* @param charset the charset to use, not null.
307+
* @throws NullPointerException if the file name or encoding is null.
308+
* @throws IOException in case of an I/O error.
309+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
310310
*/
311311
@Deprecated
312312
public FileWriterWithEncoding(final String fileName, final Charset charset) throws IOException {
@@ -316,12 +316,12 @@ public FileWriterWithEncoding(final String fileName, final Charset charset) thro
316316
/**
317317
* Constructs a FileWriterWithEncoding with a file encoding.
318318
*
319-
* @param fileName the name of the file to write to, not null
320-
* @param charset the encoding to use, not null
321-
* @param append true if content should be appended, false to overwrite
322-
* @throws NullPointerException if the file name or encoding is null
323-
* @throws IOException in case of an I/O error
324-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
319+
* @param fileName the name of the file to write to, not null.
320+
* @param charset the encoding to use, not null.
321+
* @param append true if content should be appended, false to overwrite.
322+
* @throws NullPointerException if the file name or encoding is null.
323+
* @throws IOException in case of an I/O error.
324+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
325325
*/
326326
@Deprecated
327327
public FileWriterWithEncoding(final String fileName, final Charset charset, final boolean append) throws IOException {
@@ -331,11 +331,11 @@ public FileWriterWithEncoding(final String fileName, final Charset charset, fina
331331
/**
332332
* Constructs a FileWriterWithEncoding with a file encoding.
333333
*
334-
* @param fileName the name of the file to write to, not null
335-
* @param encoding the encoding to use, not null
336-
* @throws NullPointerException if the file name or encoding is null
337-
* @throws IOException in case of an I/O error
338-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
334+
* @param fileName the name of the file to write to, not null.
335+
* @param encoding the encoding to use, not null.
336+
* @throws NullPointerException if the file name or encoding is null.
337+
* @throws IOException in case of an I/O error.
338+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
339339
*/
340340
@Deprecated
341341
public FileWriterWithEncoding(final String fileName, final CharsetEncoder encoding) throws IOException {
@@ -345,12 +345,12 @@ public FileWriterWithEncoding(final String fileName, final CharsetEncoder encodi
345345
/**
346346
* Constructs a FileWriterWithEncoding with a file encoding.
347347
*
348-
* @param fileName the name of the file to write to, not null
349-
* @param charsetEncoder the encoding to use, not null
350-
* @param append true if content should be appended, false to overwrite
351-
* @throws NullPointerException if the file name or encoding is null
352-
* @throws IOException in case of an I/O error
353-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
348+
* @param fileName the name of the file to write to, not null.
349+
* @param charsetEncoder the encoding to use, not null.
350+
* @param append true if content should be appended, false to overwrite.
351+
* @throws NullPointerException if the file name or encoding is null.
352+
* @throws IOException in case of an I/O error.
353+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
354354
*/
355355
@Deprecated
356356
public FileWriterWithEncoding(final String fileName, final CharsetEncoder charsetEncoder, final boolean append) throws IOException {
@@ -360,11 +360,11 @@ public FileWriterWithEncoding(final String fileName, final CharsetEncoder charse
360360
/**
361361
* Constructs a FileWriterWithEncoding with a file encoding.
362362
*
363-
* @param fileName the name of the file to write to, not null
364-
* @param charsetName the name of the requested charset, not null
365-
* @throws NullPointerException if the file name or encoding is null
366-
* @throws IOException in case of an I/O error
367-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
363+
* @param fileName the name of the file to write to, not null.
364+
* @param charsetName the name of the requested charset, not null.
365+
* @throws NullPointerException if the file name or encoding is null.
366+
* @throws IOException in case of an I/O error.
367+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
368368
*/
369369
@Deprecated
370370
public FileWriterWithEncoding(final String fileName, final String charsetName) throws IOException {
@@ -374,12 +374,12 @@ public FileWriterWithEncoding(final String fileName, final String charsetName) t
374374
/**
375375
* Constructs a FileWriterWithEncoding with a file encoding.
376376
*
377-
* @param fileName the name of the file to write to, not null
378-
* @param charsetName the name of the requested charset, not null
379-
* @param append true if content should be appended, false to overwrite
380-
* @throws NullPointerException if the file name or encoding is null
381-
* @throws IOException in case of an I/O error
382-
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}
377+
* @param fileName the name of the file to write to, not null.
378+
* @param charsetName the name of the requested charset, not null.
379+
* @param append true if content should be appended, false to overwrite.
380+
* @throws NullPointerException if the file name or encoding is null.
381+
* @throws IOException in case of an I/O error.
382+
* @deprecated Use {@link #builder()}, {@link Builder}, and {@link Builder#get()}.
383383
*/
384384
@Deprecated
385385
public FileWriterWithEncoding(final String fileName, final String charsetName, final boolean append) throws IOException {

0 commit comments

Comments
 (0)