org.neo4j.causalclustering.core.state.storage

Class SafeChannelMarshal<STATE>

java.lang.Object

org.neo4j.causalclustering.core.state.storage.SafeChannelMarshal<STATE>

Type Parameters:

STATE - The type of state marshalled.

All Implemented Interfaces:

ChannelMarshal<STATE>

Direct Known Subclasses:

ClusterId.Marshal, CoreReplicatedContentMarshal, CoreSnapshot.Marshal, SafeStateMarshal, StoreIdMarshal

public abstract class SafeChannelMarshal<STATE>
extends Object
implements ChannelMarshal<STATE>

Wrapper class to handle ReadPastEndExceptions in a safe manner transforming it to the checked EndOfStreamException which does not inherit from an IOException.

Constructor Summary

Constructors

Constructor and Description
SafeChannelMarshal()

Method Summary

Modifier and Type	Method and Description
STATE	unmarshal(org.neo4j.storageengine.api.ReadableChannel channel) Unmarshals an instance of STATE from channel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.neo4j.causalclustering.messaging.marshalling.ChannelMarshal

marshal

Constructor Detail

SafeChannelMarshal

public SafeChannelMarshal()

Method Detail

unmarshal

public final STATE unmarshal(org.neo4j.storageengine.api.ReadableChannel channel)
                      throws IOException,
                             EndOfStreamException

Description copied from interface: ChannelMarshal

Unmarshals an instance of STATE from channel. If the channel does not have enough bytes to fully read an instance then an EndOfStreamException must be thrown. N.B: The ReadableChannel is sort of broken in its implementation and throws ReadPastEndException which is a subclass of IOException and that is problematic since usually the case of reaching the end of a stream actually requires handling distinct from that of arbitrary IOExceptions. Although it was possible to catch that particular exception explicitly, you would not get compiler/IDE support for making that apparent.

Specified by:

unmarshal in interface ChannelMarshal<STATE>

Throws:

IOException

EndOfStreamException