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,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.mavibot.btree.serializer;
021
022
023import java.io.IOException;
024import java.nio.ByteBuffer;
025
026import org.apache.directory.mavibot.btree.comparator.CharComparator;
027import org.apache.directory.mavibot.btree.exception.SerializerCreationException;
028
029
030/**
031 * The Character serializer.
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035public class CharSerializer extends AbstractElementSerializer<Character>
036{
037    /** A static instance of a CharSerializer */
038    public static final CharSerializer INSTANCE = new CharSerializer();
039
040    /**
041     * Create a new instance of CharSerializer
042     */
043    private CharSerializer()
044    {
045        super( CharComparator.INSTANCE );
046    }
047
048
049    /**
050     * {@inheritDoc}
051     */
052    public byte[] serialize( Character element )
053    {
054        byte[] bytes = new byte[2];
055
056        return serialize( bytes, 0, element );
057    }
058
059
060    /**
061     * Serialize a char
062     *
063     * @param value the value to serialize
064     * @return The byte[] containing the serialized char
065     */
066    public static byte[] serialize( char value )
067    {
068        byte[] bytes = new byte[2];
069
070        return serialize( bytes, 0, value );
071    }
072
073
074    /**
075     * Serialize a char
076     *
077     * @param buffer the Buffer that will contain the serialized value
078     * @param start the position in the buffer we will store the serialized char
079     * @param value the value to serialize
080     * @return The byte[] containing the serialized char
081     */
082    public static byte[] serialize( byte[] buffer, int start, char value )
083    {
084        buffer[start] = ( byte ) ( value >>> 8 );
085        buffer[start + 1] = ( byte ) ( value );
086
087        return buffer;
088    }
089
090
091    /**
092     * A static method used to deserialize a Character from a byte array.
093     * @param in The byte array containing the Character
094     * @return A Character
095     */
096    public static Character deserialize( byte[] in )
097    {
098        return deserialize( in, 0 );
099    }
100
101
102    /**
103     * A static method used to deserialize a Character from a byte array.
104     * @param in The byte array containing the Character
105    * @param start the position in the byte[] we will deserialize the char from
106     * @return A Character
107     */
108    public static Character deserialize( byte[] in, int start )
109    {
110        if ( ( in == null ) || ( in.length < 2 + start ) )
111        {
112            throw new SerializerCreationException( "Cannot extract a Character from a buffer with not enough bytes" );
113        }
114
115        return Character.valueOf( ( char ) ( ( in[start] << 8 ) +
116            ( in[start + 1] & 0xFF ) ) );
117    }
118
119
120    /**
121     * A method used to deserialize a Character from a byte array.
122     * @param in The byte array containing the Character
123     * @return A Character
124     */
125    public Character fromBytes( byte[] in )
126    {
127        return deserialize( in, 0 );
128    }
129
130
131    /**
132     * A static method used to deserialize a Character from a byte array.
133     * @param in The byte array containing the Character
134    * @param start the position in the byte[] we will deserialize the char from
135     * @return A Character
136     */
137    public Character fromBytes( byte[] in, int start )
138    {
139        if ( ( in == null ) || ( in.length < 2 + start ) )
140        {
141            throw new SerializerCreationException( "Cannot extract a Character from a buffer with not enough bytes" );
142        }
143
144        return Character.valueOf( ( char ) ( ( in[start] << 8 ) +
145            ( in[start + 1] & 0xFF ) ) );
146    }
147
148
149    /**
150     * {@inheritDoc}
151     */
152    public Character deserialize( ByteBuffer buffer ) throws IOException
153    {
154        return buffer.getChar();
155    }
156
157
158    /**
159     * {@inheritDoc}
160     */
161    public Character deserialize( BufferHandler bufferHandler ) throws IOException
162    {
163        byte[] in = bufferHandler.read( 2 );
164
165        return deserialize( in );
166    }
167}