phoenix-core/src/main/java/org/apache/phoenix/cache/HashCache.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 */
package org.apache.phoenix.cache;

import java.io.Closeable;
import java.io.IOException;
import java.util.List;

import org.apache.http.annotation.Immutable;
import org.apache.phoenix.hbase.index.util.ImmutableBytesPtr;
import org.apache.phoenix.schema.tuple.Tuple;


/**
 * Encapsulate deserialized hash cache from bytes into Map.
 * The Map uses the row key as the key and the row as the value.
 * 
 * @since 0.1
 */
@Immutable
public interface HashCache extends Closeable {
    public List<Tuple> get(ImmutableBytesPtr hashKey) throws IOException;
}