org.kitesdk.data.hbase.impl.KeySerDe Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kite-data-hbase Show documentation
Show all versions of kite-data-hbase Show documentation
The Kite Data HBase module provides integration with HBase.
/**
* Copyright 2013 Cloudera Inc.
*
* 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.
*/
package org.kitesdk.data.hbase.impl;
import org.kitesdk.data.spi.PartitionKey;
/**
* This class handles key serialization and deserialization.
*
*/
public interface KeySerDe {
/**
* Serialize the key to bytes.
*
* @param key
* The key to serialize
* @return The byte array
*/
public byte[] serialize(PartitionKey partitionKey);
/**
* Serialize the key parts to bytes
*
* @param keyPartValues
* The array of key parts.
* @return The byte array
*/
public byte[] serialize(Object... keyPartValues);
/**
* Deserialize the key from a byte array.
*
* @param keyBytes
* The byte array to deserialize the key from.
* @return The key
*/
public PartitionKey deserialize(byte[] keyBytes);
}