org.apache.geode.cache.snapshot

## Class SnapshotReader

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

-     public class SnapshotReader
      extends java.lang.Object

  Provides utilities for reading cache data.
  Since:
    GemFire 7.0

- - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static <K,V> SnapshotIterator<K,V>` | `read(java.io.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 Detail

    - #### read

          public static <K,V> SnapshotIterator<K,V> read(java.io.File snapshot)
                                                  throws java.io.IOException,
                                                         java.lang.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:
        `java.io.IOException` - error reading the snapshot file
        `java.lang.ClassNotFoundException` - unable deserialize entry