View Javadoc

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  
26  import org.apache.directory.mavibot.btree.comparator.ShortComparator;
27  import org.apache.directory.mavibot.btree.exception.SerializerCreationException;
28  
29  
30  /**
31   * The Short serializer.
32   *
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   */
35  public class ShortSerializer extends AbstractElementSerializer<Short>
36  {
37      /**
38       * Create a new instance of ShortSerializer
39       */
40      public ShortSerializer()
41      {
42          super( new ShortComparator() );
43      }
44  
45  
46      /**
47       * {@inheritDoc}
48       */
49      public byte[] serialize( Short element )
50      {
51          byte[] bytes = new byte[2];
52  
53          return serialize( bytes, 0, element );
54      }
55  
56  
57      /**
58       * Serialize a short
59       *
60       * @param value the value to serialize
61       * @return The byte[] containing the serialized short
62       */
63      public static byte[] serialize( short value )
64      {
65          byte[] bytes = new byte[2];
66  
67          return serialize( bytes, 0, value );
68      }
69  
70  
71      /**
72       * Serialize a short
73       *
74       * @param buffer the Buffer that will contain the serialized value
75       * @param start the position in the buffer we will store the serialized short
76       * @param value the value to serialize
77       * @return The byte[] containing the serialized short
78       */
79      public static byte[] serialize( byte[] buffer, int start, short value )
80      {
81          buffer[start] = ( byte ) ( value >>> 8 );
82          buffer[start + 1] = ( byte ) ( value );
83  
84          return buffer;
85      }
86  
87  
88      /**
89       * A static method used to deserialize a Short from a byte array.
90       * @param in The byte array containing the Short
91       * @return A Short
92       */
93      public static Short deserialize( byte[] in )
94      {
95          return deserialize( in, 0 );
96      }
97  
98  
99      /**
100      * A static method used to deserialize a Short from a byte array.
101      * @param in The byte array containing the Short
102     * @param start the position in the byte[] we will deserialize the short from
103      * @return A Short
104      */
105     public static Short deserialize( byte[] in, int start )
106     {
107         if ( ( in == null ) || ( in.length < 2 + start ) )
108         {
109             throw new SerializerCreationException( "Cannot extract a Short from a buffer with not enough bytes" );
110         }
111 
112         return ( short ) ( ( in[start] << 8 ) + ( in[start + 1] & 0xFF ) );
113     }
114 
115 
116     /**
117      * A method used to deserialize a Short from a byte array.
118      * @param in The byte array containing the Short
119      * @return A Short
120      */
121     public Short fromBytes( byte[] in )
122     {
123         return deserialize( in, 0 );
124     }
125 
126 
127     /**
128      * A method used to deserialize a Short from a byte array.
129      * @param in The byte array containing the Short
130      * @param start the position in the byte[] we will deserialize the short from
131      * @return A Short
132      */
133     public Short fromBytes( byte[] in, int start )
134     {
135         if ( ( in == null ) || ( in.length < 2 + start ) )
136         {
137             throw new SerializerCreationException( "Cannot extract a Short from a buffer with not enough bytes" );
138         }
139 
140         return ( short ) ( ( in[start] << 8 ) + ( in[start + 1] & 0xFF ) );
141     }
142 
143 
144     /**
145      * {@inheritDoc}
146      */
147     public Short deserialize( ByteBuffer buffer ) throws IOException
148     {
149         return buffer.getShort();
150     }
151 
152 
153     /**
154      * {@inheritDoc}
155      */
156     public Short deserialize( BufferHandler bufferHandler ) throws IOException
157     {
158         byte[] in = bufferHandler.read( 2 );
159 
160         return deserialize( in );
161     }
162 }