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