net.openhft.chronicle.wire

Interface RollbackIfNotCompleteNotifier

All Known Subinterfaces:

MarshallableOut, Wire, WireOut

All Known Implementing Classes:

AbstractAnyWire, AbstractWire, BinaryWire, CSVWire, HashWire, JSONWire, QueryWire, RawWire, ReadAnyWire, TextWire, YamlWire, YamlWireOut

public interface RollbackIfNotCompleteNotifier

The RollbackIfNotCompleteNotifier interface defines methods to handle rollback scenarios in the event of incomplete operations or messages. Implementations of this interface can ensure data integrity and consistency by rolling back changes if an operation does not complete successfully. This is typically implemented by DocumentContext objects, particularly WriteDocumentContext, to allow writers to discard partially written messages.

Method Summary

Modifier and Type	Method and Description
default void	rollbackIfNotComplete() Rolls back the current operation if it is not complete.
default boolean	writingIsComplete() Checks if the current writing operation is complete.

Method Detail

rollbackIfNotComplete

default void rollbackIfNotComplete()

Rolls back the current operation if it is not complete. If the current document or operation managed by this notifier is in an incomplete state (for example as indicated by DocumentContext.isNotComplete()), this method should attempt to roll back any changes made within the current context, effectively discarding them. If rollback is not supported or not applicable, an UnsupportedOperationException may be thrown.

Throws:

UnsupportedOperationException - if the rollback operation is not supported

writingIsComplete

default boolean writingIsComplete()

Checks if the current writing operation is complete. Returns true by default, indicating completion. Implementations should override this to reflect the actual completion status of their write operation (for example, the inverse of DocumentContext.isNotComplete()).

Returns:

true if the current operation is complete, false otherwise