SnapshotReader (Apache Geode 2.0.2)
Description: declaration: package: org.apache.geode.cache.snapshot, class: SnapshotReader

Package org.apache.geode.cache.snapshot

# Class SnapshotReader

java.lang.Object
org.apache.geode.cache.snapshot.SnapshotReader

public class SnapshotReader extends Object
Provides utilities for reading cache data.

Since:
  GemFire 7.0

- ## Method Summary

  Modifier and Type
  Method
  Description
  `static <K, V> SnapshotIterator<K,V>`
  `read(File snapshot)`
  Reads a snapshot file and passes the entries to the application.

  ### Methods inherited from class java.lang.Object

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

- ## Method Details

  - ### read

    public static <K, V> SnapshotIterator<K,V> read(File snapshot) throws IOException, ClassNotFoundException
    Reads a snapshot file and passes the entries to the application.

    Prior to invoking `read` all necessary serializers (either `DataSerializer` or `PdxSerializer`) and any `Instantiator` should have been registered.

    Type Parameters:
      `K` - the key type
      `V` - the value type
    Parameters:
      `snapshot` - the snapshot file
    Returns:
      the snapshot iterator
    Throws:
      `IOException` - error reading the snapshot file
      `ClassNotFoundException` - unable deserialize entry