JabRef 6.0-beta.1 · org.jabref.logic.exporter.AtomicFileWriter

Writer that similar to the built-in java.io.FileWriter but uses the AtomicFileOutputStream as the underlying output stream. In this way, we make sure that the errors during the write process do not destroy the contents of the target file. Moreover, this writer checks if the chosen encoding supports all text that is written. Characters whose encoding was problematic can be retrieved by getEncodingProblems().

Field Summary

Modifier and Type	Field and Description
private final CharsetEncoder	encoder
private final AtomicFileOutputStream	outputStream
private final Set<Character>	problemCharacters

Constructor Summary

Access	Constructor and Description
public	AtomicFileWriter(Path file, Charset encoding)
public	AtomicFileWriter(Path file, Charset encoding, boolean keepBackup)
public	AtomicFileWriter(Path file, Charset encoding, boolean keepBackup, @Nullable FileSnapshot see `AtomicFileOutputStream#AtomicFileOutputStream(Path, boolean, FileSnapshot)` expectedState)
private	AtomicFileWriter(AtomicFileOutputStream outputStream, Charset encoding)

Method Summary

Modifier and Type	Method and Description
public void	abort() Aborts the write without replacing the target file.
public @Nullable FileSnapshot	getCommittedTargetFileState() See `AtomicFileOutputStream#getCommittedTargetFileState()`; remains accessible after `close()`.
public Set<Character>	getEncodingProblems()
public boolean	hasEncodingProblems()
public void	write(String str) Overrides java.io.Writer.write. Writes a string.

Inherited from java.io.OutputStreamWriter:: append append close flush getEncoding write write write

Field Detail

encoder	back to summary
private final CharsetEncoder encoder

outputStream	back to summary
private final AtomicFileOutputStream outputStream

problemCharacters	back to summary
private final Set<Character> problemCharacters

Constructor Detail

AtomicFileWriter	back to summary
public AtomicFileWriter(Path file, Charset encoding) throws IOException

AtomicFileWriter	back to summary
public AtomicFileWriter(Path file, Charset encoding, boolean keepBackup) throws IOException

AtomicFileWriter	back to summary
public AtomicFileWriter(Path file, Charset encoding, boolean keepBackup, @Nullable FileSnapshot expectedState) throws IOException Parameters expectedState:@Nullable FileSnapshot see `AtomicFileOutputStream#AtomicFileOutputStream(Path, boolean, FileSnapshot)`

AtomicFileWriter	back to summary
private AtomicFileWriter(AtomicFileOutputStream outputStream, Charset encoding)

Method Detail

abort	back to summary
public void abort() Aborts the write without replacing the target file.

getCommittedTargetFileState	back to summary
public @Nullable FileSnapshot getCommittedTargetFileState() See `AtomicFileOutputStream#getCommittedTargetFileState()`; remains accessible after `close()`.

getEncodingProblems	back to summary
public Set<Character> getEncodingProblems()

hasEncodingProblems	back to summary
public boolean hasEncodingProblems()

write	back to summary
public void write(String str) throws IOException Overrides java.io.Writer.write. Doc from java.io.Writer.write. Writes a string. Annotations @Override Exceptions IOException: If an I/O error occurs

write

back to summary

public void write(String str) throws IOException

Overrides java.io.Writer.write.

Doc from java.io.Writer.write.

Writes a string.

Annotations

@Override

Exceptions