1 /* 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, 13 * software distributed under the License is distributed on an 14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 * KIND, either express or implied. See the License for the 16 * specific language governing permissions and limitations 17 * under the License. 18 * 19 */ 20 package org.apache.directory.mavibot.btree.serializer; 21 22 23 import java.io.IOException; 24 import java.nio.ByteBuffer; 25 import java.util.Comparator; 26 27 28 /** 29 * This interface is used by implementations of serializer, deserializer and comparator. 30 * 31 * @param <T> The type for the element to serialize and compare 32 * 33 * @author <a href="mailto:labs@labs.apache.org">Mavibot labs Project</a> 34 */ 35 public interface ElementSerializer<T> 36 { 37 /** 38 * Produce the byte[] representation of the element 39 * 40 * @param key The element to serialize 41 * @return The byte[] containing the serialized element 42 */ 43 byte[] serialize( T key ); 44 45 46 /** 47 * Deserialize an element from a BufferHandler 48 * 49 * @param bufferHandler The incoming bufferHandler 50 * @return The deserialized element 51 * @throws IOException If the deserialization failed 52 */ 53 T deserialize( BufferHandler bufferHandler ) throws IOException; 54 55 56 /** 57 * Deserialize an element from a ByteBuffer 58 * 59 * @param buffer The incoming ByteBuffer 60 * @return The deserialized element 61 * @throws IOException If the deserialization failed 62 */ 63 T deserialize( ByteBuffer buffer ) throws IOException; 64 65 66 /** 67 * Returns the comparison of two types. <br/> 68 * <ul> 69 * <li>If type1 < type2, return -1</li> 70 * <li>If type1 > type2, return 1</li> 71 * <li>If type1 == type2, return 0</li> 72 * </ul> 73 * 74 * @param type1 The first type to compare 75 * @param type2 The second type to compare 76 * @return The comparison result 77 */ 78 int compare( T type1, T type2 ); 79 80 81 /** 82 * @return the comparator for the used type 83 */ 84 Comparator<T> getComparator(); 85 }