? LockableFileWriter
java.lang.Object
java.io.Writer
org.apache.commons.io.output.LockableFileWriter
- ????????:
Closeable
,Flushable
,Appendable
,AutoCloseable
FileWriter that will create and honor lock files to allow simple
cross thread file lock handling.
This class provides a simple alternative to FileWriter
that will use a lock file to prevent duplicate writes.
Note: The lock file is deleted when close()
is called
- or if the main file cannot be opened initially.
In the (unlikely) event that the lock file cannot be deleted,
an exception is thrown.
By default, the file will be overwritten, but this may be changed to append.
The lock directory may be specified, but defaults to the system property
java.io.tmpdir
.
The encoding may also be specified, and defaults to the platform default.
-
????
-
?????
????????LockableFileWriter
(File file) Constructs a LockableFileWriter.LockableFileWriter
(File file, boolean append) Constructs a LockableFileWriter.LockableFileWriter
(File file, boolean append, String lockDir) ????LockableFileWriter
(File file, String charsetName) Constructs a LockableFileWriter with a file encoding.LockableFileWriter
(File file, String charsetName, boolean append, String lockDir) Constructs a LockableFileWriter with a file encoding.LockableFileWriter
(File file, Charset charset) Constructs a LockableFileWriter with a file encoding.LockableFileWriter
(File file, Charset charset, boolean append, String lockDir) Constructs a LockableFileWriter with a file encoding.LockableFileWriter
(String fileName) Constructs a LockableFileWriter.LockableFileWriter
(String fileName, boolean append) Constructs a LockableFileWriter.LockableFileWriter
(String fileName, boolean append, String lockDir) Constructs a LockableFileWriter. -
????
??????????void
close()
Closes the file writer and deletes the lock file.void
flush()
Flushes the stream.void
write
(char[] cbuf) Writes the characters from an array.void
write
(char[] cbuf, int off, int len) Writes the specified characters from an array.void
write
(int c) Writes a character.void
Writes the characters from a string.void
Writes the specified characters from a string.??????? java.io.Writer
append, append, append, nullWriter
-
???????
-
LockableFileWriter
Constructs a LockableFileWriter. If the file exists, it is overwritten.- ??:
fileName
- the file to write to, not null- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error
-
LockableFileWriter
Constructs a LockableFileWriter.- ??:
fileName
- file to write to, not nullappend
- true if content should be appended, false to overwrite- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error
-
LockableFileWriter
Constructs a LockableFileWriter.- ??:
fileName
- the file to write to, not nullappend
- true if content should be appended, false to overwritelockDir
- the directory in which the lock file should be held- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error
-
LockableFileWriter
Constructs a LockableFileWriter. If the file exists, it is overwritten.- ??:
file
- the file to write to, not null- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error
-
LockableFileWriter
Constructs a LockableFileWriter.- ??:
file
- the file to write to, not nullappend
- true if content should be appended, false to overwrite- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error
-
LockableFileWriter
????2.5 useLockableFileWriter(File, Charset, boolean, String)
insteadConstructs a LockableFileWriter.- ??:
file
- the file to write to, not nullappend
- true if content should be appended, false to overwritelockDir
- the directory in which the lock file should be held- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error
-
LockableFileWriter
Constructs a LockableFileWriter with a file encoding.- ??:
file
- the file to write to, not nullcharset
- the charset to use, null means platform default- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error- ???????:
- 2.3
-
LockableFileWriter
Constructs a LockableFileWriter with a file encoding.- ??:
file
- the file to write to, not nullcharsetName
- the name of the requested charset, null means platform default- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O errorUnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.
-
LockableFileWriter
public LockableFileWriter(File file, Charset charset, boolean append, String lockDir) throws IOException Constructs a LockableFileWriter with a file encoding.- ??:
file
- the file to write to, not nullcharset
- the name of the requested charset, null means platform defaultappend
- true if content should be appended, false to overwritelockDir
- the directory in which the lock file should be held- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O error- ???????:
- 2.3
-
LockableFileWriter
public LockableFileWriter(File file, String charsetName, boolean append, String lockDir) throws IOException Constructs a LockableFileWriter with a file encoding.- ??:
file
- the file to write to, not nullcharsetName
- the encoding to use, null means platform defaultappend
- true if content should be appended, false to overwritelockDir
- the directory in which the lock file should be held- ??:
NullPointerException
- if the file is nullIOException
- in case of an I/O errorUnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.
-
-
??????
-
close
Closes the file writer and deletes the lock file.- ???:
close
????AutoCloseable
- ???:
close
????Closeable
- ???:
close
???Writer
- ??:
IOException
- if an I/O error occurs.
-
write
Writes a character.- ??:
write
???Writer
- ??:
c
- the character to write- ??:
IOException
- if an I/O error occurs.
-
write
Writes the characters from an array.- ??:
write
???Writer
- ??:
cbuf
- the characters to write- ??:
IOException
- if an I/O error occurs.
-
write
Writes the specified characters from an array.- ???:
write
???Writer
- ??:
cbuf
- the characters to writeoff
- The start offsetlen
- The number of characters to write- ??:
IOException
- if an I/O error occurs.
-
write
Writes the characters from a string.- ??:
write
???Writer
- ??:
str
- the string to write- ??:
IOException
- if an I/O error occurs.
-
write
Writes the specified characters from a string.- ??:
write
???Writer
- ??:
str
- the string to writeoff
- The start offsetlen
- The number of characters to write- ??:
IOException
- if an I/O error occurs.
-
flush
Flushes the stream.- ???:
flush
????Flushable
- ???:
flush
???Writer
- ??:
IOException
- if an I/O error occurs.
-
LockableFileWriter(File, Charset, boolean, String)
instead