Package org.opendaylight.controller.cluster.datastore.persisted

Class ShardSnapshotState

java.lang.Object

org.opendaylight.controller.cluster.datastore.persisted.ShardSnapshotState

All Implemented Interfaces:

Serializable, Snapshot.State, StateSnapshot, Immutable

public final class ShardSnapshotState
extends Object
implements Snapshot.State

Encapsulates the snapshot State for a Shard.

Author:

Thomas Pantelis

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.controller.cluster.raft.spi.StateSnapshot

StateSnapshot.Reader<T extends StateSnapshot>, StateSnapshot.Support<T extends StateSnapshot>, StateSnapshot.ToStorage<T extends StateSnapshot>, StateSnapshot.Writer<T extends StateSnapshot>

Field Summary

Fields

Modifier and Type	Field	Description
static final StateSnapshot.Support<ShardSnapshotState>	SUPPORT

Constructor Summary

Constructors

Constructor	Description
ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot)
ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot, boolean migrated)

Method Summary

Modifier and Type	Method	Description
@NonNull ShardDataTreeSnapshot	getSnapshot()
boolean	needsMigration()	Indicate whether the snapshot requires migration, i.e. a new snapshot should be created after recovery.

Methods inherited from class java.lang.Object

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

Field Details

SUPPORT

@NonNullByDefault
public static final StateSnapshot.Support<ShardSnapshotState> SUPPORT

Constructor Details

ShardSnapshotState

public ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot,
 boolean migrated)

ShardSnapshotState

public ShardSnapshotState(@NonNull ShardDataTreeSnapshot snapshot)

Method Details

getSnapshot

public @NonNull ShardDataTreeSnapshot getSnapshot()

needsMigration

public boolean needsMigration()

Description copied from interface: StateSnapshot

Indicate whether the snapshot requires migration, i.e. a new snapshot should be created after recovery. Default implementation returns false, i.e. do not re-snapshot.

Specified by:

needsMigration in interface StateSnapshot

Returns:

true if complete recovery based upon this snapshot should trigger a new snapshot.