com.gemstone.gemfire.cache.snapshot.SnapshotReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation

SnappyData store based off Pivotal GemFireXD

There is a newer version: 2.0-BETA

/*
 * Copyright (c) 2010-2015 Pivotal Software, Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you
 * may not use this file except in compliance with the License. You
 * may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * permissions and limitations under the License. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.cache.snapshot;

import java.io.File;
import java.io.IOException;

import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.Instantiator;
import com.gemstone.gemfire.internal.cache.snapshot.GFSnapshot;
import com.gemstone.gemfire.pdx.PdxSerializer;

/**
 * Provides utilities for reading cache data.
 * 
 * @author bakera
 * @since 7.0
 */
public class SnapshotReader {
  private SnapshotReader() {
  }
  
  /**
   * Reads a snapshot file and passes the entries to the application.
   * 
   * Prior to invoking read all necessary serializers 
   * (either {@link DataSerializer} or {@link PdxSerializer}) and any
   * {@link Instantiator} should have been registered.
   * 
   * @param  the key type
   * @param  the value type
   * 
   * @param snapshot the snapshot file
   * @return the snapshot iterator
   * 
   * @throws IOException error reading the snapshot file
   * @throws ClassNotFoundException unable deserialize entry
   */
  public static  SnapshotIterator read(File snapshot) 
      throws IOException, ClassNotFoundException {
    return GFSnapshot.read(snapshot);
  }
}