|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.io.Writer org.apache.commons.io.output.LockableFileWriter
public class LockableFileWriter
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.
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.
Field Summary |
---|
Fields inherited from class java.io.Writer |
---|
lock |
Constructor Summary | |
---|---|
LockableFileWriter(File file)
Constructs a LockableFileWriter. |
|
LockableFileWriter(File file,
boolean append)
Constructs a LockableFileWriter. |
|
LockableFileWriter(File file,
boolean append,
String lockDir)
Constructs a LockableFileWriter. |
|
LockableFileWriter(File file,
String encoding)
Constructs a LockableFileWriter with a file encoding. |
|
LockableFileWriter(File file,
String encoding,
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. |
Method Summary | |
---|---|
void |
close()
Closes the file writer. |
void |
flush()
Flush the stream. |
void |
write(char[] chr)
Write the characters from an array. |
void |
write(char[] chr,
int st,
int end)
Write the specified characters from an array. |
void |
write(int idx)
Write a character. |
void |
write(String str)
Write the characters from a string. |
void |
write(String str,
int st,
int end)
Write the specified characters from a string. |
Methods inherited from class java.io.Writer |
---|
append, append, append, append, append, append |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LockableFileWriter(String fileName) throws IOException
fileName
- the file to write to, not null
NullPointerException
- if the file is null
IOException
- in case of an I/O errorpublic LockableFileWriter(String fileName, boolean append) throws IOException
fileName
- file to write to, not nullappend
- true if content should be appended, false to overwrite
NullPointerException
- if the file is null
IOException
- in case of an I/O errorpublic LockableFileWriter(String fileName, boolean append, String lockDir) throws IOException
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 null
IOException
- in case of an I/O errorpublic LockableFileWriter(File file) throws IOException
file
- the file to write to, not null
NullPointerException
- if the file is null
IOException
- in case of an I/O errorpublic LockableFileWriter(File file, boolean append) throws IOException
file
- the file to write to, not nullappend
- true if content should be appended, false to overwrite
NullPointerException
- if the file is null
IOException
- in case of an I/O errorpublic LockableFileWriter(File file, boolean append, String lockDir) throws IOException
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 null
IOException
- in case of an I/O errorpublic LockableFileWriter(File file, String encoding) throws IOException
file
- the file to write to, not nullencoding
- the encoding to use, null means platform default
NullPointerException
- if the file is null
IOException
- in case of an I/O errorpublic LockableFileWriter(File file, String encoding, boolean append, String lockDir) throws IOException
file
- the file to write to, not nullencoding
- 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 null
IOException
- in case of an I/O errorMethod Detail |
---|
public void close() throws IOException
close
in interface Closeable
close
in class Writer
IOException
- if an I/O error occurspublic void write(int idx) throws IOException
write
in class Writer
idx
- the character to write
IOException
- if an I/O error occurspublic void write(char[] chr) throws IOException
write
in class Writer
chr
- the characters to write
IOException
- if an I/O error occurspublic void write(char[] chr, int st, int end) throws IOException
write
in class Writer
chr
- the characters to writest
- The start offsetend
- The number of characters to write
IOException
- if an I/O error occurspublic void write(String str) throws IOException
write
in class Writer
str
- the string to write
IOException
- if an I/O error occurspublic void write(String str, int st, int end) throws IOException
write
in class Writer
str
- the string to writest
- The start offsetend
- The number of characters to write
IOException
- if an I/O error occurspublic void flush() throws IOException
flush
in interface Flushable
flush
in class Writer
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |