/*
 *  Copyright (c) 2012 Jan Kotek
 *
 *  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.mapdb;


import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.io.Serializable;
import java.util.zip.CRC32;

/**
 * Provides serialization and deserialization
 *
 * @author Jan Kotek
 */
public interface Serializer<A> {

    /**
     * Serialize the content of an object into a ObjectOutput
     *
     * @param out ObjectOutput to save object into
     * @param value Object to serialize
     */
    public void serialize( DataOutput out, A value)
            throws IOException;


    /**
     * Deserialize the content of an object from a DataInput.
     *
     * @param in to read serialized data from
     * @param available how many bytes are available in DataInput for reading, may be -1 (in streams) or 0 (null).
     * @return deserialized object
     * @throws java.io.IOException
     */
    public A deserialize( DataInput in, int available)
            throws IOException;

    /**
     * Serializes strings using UTF8 encoding.
     * Used mainly for testing.
     * Does not handle null values.
     */
    
    Serializer<String> STRING_SERIALIZER = new Serializer<String>() {

        @Override
		public void serialize(DataOutput out, String value) throws IOException {
            final byte[] bytes = value.getBytes(Utils.UTF8);
            out.write(bytes);
        }


        @Override
		public String deserialize(DataInput in, int available) throws IOException {
            byte[] bytes = new byte[available];
            in.readFully(bytes);
            return new String(bytes, Utils.UTF8);
        }
    };




    /** Serializes Long into 8 bytes, used mainly for testing.
     * Does not handle null values.*/
     
     Serializer<Long> LONG_SERIALIZER = new Serializer<Long>() {
        @Override
        public void serialize(DataOutput out, Long value) throws IOException {
            out.writeLong(value);
        }

        @Override
        public Long deserialize(DataInput in, int available) throws IOException {
            return in.readLong();
        }
    };

    /** Serializes Integer into 4 bytes, used mainly for testing.
     * Does not handle null values.*/
    
    Serializer<Integer> INTEGER_SERIALIZER = new Serializer<Integer>() {
        @Override
        public void serialize(DataOutput out, Integer value) throws IOException {
            out.writeInt(value);
        }

        @Override
        public Integer deserialize(DataInput in, int available) throws IOException {
            return in.readInt();
        }
    };

    
    Serializer<Boolean> BOOLEAN_SERIALIZER = new Serializer<Boolean>() {
        @Override
        public void serialize(DataOutput out, Boolean value) throws IOException {
            out.writeBoolean(value);
        }

        @Override
        public Boolean deserialize(DataInput in, int available) throws IOException {
            if(available==0) return null;
            return in.readBoolean();
        }
    };

    


    /** always writes zero length data, and always deserializes it as an empty String */
    Serializer<Object> EMPTY_SERIALIZER = new Serializer<Object>() {
        @Override
        public void serialize(DataOutput out, Object value) throws IOException {
            if(value!=Utils.EMPTY_STRING) throw new IllegalArgumentException();
        }

        @Override
        public Object deserialize(DataInput in, int available) throws IOException {
            if(available!=0) throw new InternalError();
            return Utils.EMPTY_STRING;
        }
    };

    /** basic serializer for most classes in 'java.lang' and 'java.util' packages*/
    @SuppressWarnings("unchecked")
    Serializer<Object> BASIC_SERIALIZER = new SerializerBase();



    /**
     * Adds CRC32 checksum at end of each record to check data integrity.
     * It throws 'IOException("CRC32 does not match, data broken")' on de-serialization if data are corrupted
     */
    
    Serializer<byte[]> CRC32_CHECKSUM = new Serializer<byte[]>() {
        @Override
        public void serialize(DataOutput out, byte[] value) throws IOException {
            if(value == null || value.length==0) return;
            CRC32 crc = new CRC32();
            crc.update(value);
            out.write(value);
            out.writeInt((int) crc.getValue());
        }

        @Override
        public byte[] deserialize(DataInput in, int available) throws IOException {
            if(available==0) return null;
            byte[] value = new byte[available-4];
            in.readFully(value);
            CRC32 crc = new CRC32();
            crc.update(value);
            int checksum = in.readInt();
            if(checksum!=(int)crc.getValue()){
                throw new IOException("CRC32 does not match, data broken");
            }
            return value;
        }
    };


    Serializer<byte[] > BYTE_ARRAY_SERIALIZER = new Serializer<byte[]>() {

        @Override
        public void serialize(DataOutput out, byte[] value) throws IOException {
            if(value==null||value.length==0) return;
            out.write(value);
        }

        @Override
        public byte[] deserialize(DataInput in, int available) throws IOException {
            if(available==0) return null;
            byte[] ret = new byte[available];
            in.readFully(ret);
            return ret;
        }
    } ;


    class CompressSerializerWrapper<E> implements Serializer<E>, Serializable {
        protected final Serializer<E> serializer;
        public CompressSerializerWrapper(Serializer<E> serializer) {
            this.serializer = serializer;
        }

        @Override
        public void serialize(DataOutput out, E value) throws IOException {
            //serialize to byte[]
            DataOutput2 out2 = new DataOutput2();
            serializer.serialize(out2, value);
            byte[] b = out2.copyBytes();
            CompressLZF.SERIALIZER.serialize(out, b);
        }

        @Override
        public E deserialize(DataInput in, int available) throws IOException {
            byte[] b = CompressLZF.SERIALIZER.deserialize(in, available);
            DataInput2 in2 = new DataInput2(b);
            return serializer.deserialize(in2, b.length);
        }
    }
}


@@ -1659,37 +1659,32 @@
 values.%0A     */%0A
-    %0A
     Serializer%3CS
@@ -1733,24 +1733,24 @@
 String%3E() %7B%0A
+
 %0A        @Ov
@@ -2022,32 +2022,151 @@
 s IOException %7B%0A
+            if(available==-1) throw new IllegalArgumentException(%22STRING_SERIALIZER does not work with collections.%22);%0A
             byte
@@ -2299,16 +2299,17 @@
    %7D;%0A%0A%0A
+%0A
 %0A%0A    /*
@@ -4155,18 +4155,17 @@
 vailable
-!=
+%3E
 0) throw
@@ -5108,32 +5108,148 @@
 s IOException %7B%0A
+            if(available==-1) throw new IllegalArgumentException(%22CRC32_CHECKSUM does not work with collections.%22);%0A
             if(a
@@ -6011,32 +6011,155 @@
 s IOException %7B%0A
+            if(available==-1) throw new IllegalArgumentException(%22BYTE_ARRAY_SERIALIZER does not work with collections.%22);%0A
             if(a
@@ -6898,32 +6898,32 @@
       @Override%0A
-
         public E
@@ -6977,32 +6977,156 @@
 s IOException %7B%0A
+            if(available==-1) throw new IllegalArgumentException(%22Compression Serializer does not work with collections.%22);%0A
             byte

Add warning about Serializers which are not meant to be used as top level serializers. Issue #134