org.jabref.logic.integrity

public abstract Class IntegrityCheckResultWriter

Class Inheritance

extends Object
implements Closeable

java.lang.Object
org.jabref.logic.integrity.IntegrityCheckResultWriter

All Implemented Interfaces

java.io.Closeable, java.lang.AutoCloseable

Known Direct Subclasses

org.jabref.logic.integrity.IntegrityCheckResultCsvWriter, org.jabref.logic.integrity.IntegrityCheckResultErrorFormatWriter, org.jabref.logic.integrity.IntegrityCheckResultGitHubActionsWriter

Imports

java.io.Closeable, .IOException, .Writer, java.util.List

Field Summary

Modifier and Type	Field and Description
protected final List<IntegrityMessage>	messages
protected final Writer	writer

Constructor Summary

Access	Constructor and Description
public	IntegrityCheckResultWriter(Writer writer, List<IntegrityMessage> messages) Writer lifecycle: The caller is responsible for closing the writer at the appropriate time.

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public abstract void	writeFindings()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

messages	back to summary
protected final List<IntegrityMessage> messages

writer	back to summary
protected final Writer writer

Constructor Detail

IntegrityCheckResultWriter	back to summary
public IntegrityCheckResultWriter(Writer writer, List<IntegrityMessage> messages) Writer lifecycle: The caller is responsible for closing the writer at the appropriate time.

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

writeFindings	back to summary
public abstract void writeFindings() throws IOException