001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.io.hfile;
019
020import java.io.IOException;
021import org.apache.hadoop.hbase.io.ByteBuffAllocator;
022import org.apache.hadoop.hbase.nio.ByteBuff;
023import org.apache.yetus.audience.InterfaceAudience;
024
025/**
026 * Interface for a deserializer. Throws an IOException if the serialized data is incomplete or
027 * wrong.
028 */
029@InterfaceAudience.Private
030public interface CacheableDeserializer<T extends Cacheable> {
031  /**
032   * @param b         ByteBuff to deserialize the Cacheable.
033   * @param allocator to manage NIO ByteBuffers for future allocation or de-allocation.
034   * @return T the deserialized object. n
035   */
036  T deserialize(ByteBuff b, ByteBuffAllocator allocator) throws IOException;
037
038  /**
039   * Get the identifier of this deserializer. Identifier is unique for each deserializer and
040   * generated by {@link CacheableDeserializerIdManager}
041   * @return identifier number of this cacheable deserializer
042   */
043  int getDeserializerIdentifier();
044}