001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.io.wrappers;
031
032import java.io.DataOutput;
033import java.io.IOException;
034import java.util.Map;
035import java.util.Map.Entry;
036
037import org.openimaj.io.WriteableBinary;
038
039/**
040 * A wrapper for {@link Map} that is writeable.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 *
044 * @param <K> The key type.
045 * @param <V> The value type.
046 */
047public abstract class WriteableMapBinary<K, V> implements WriteableBinary {
048        /**
049         * The underlying map.
050         */
051        public Map<K, V> value;
052        
053        /**
054         * Construct with the given map. The map is retained,
055         * so changes are reflected internally.
056         * @param map The map.
057         */
058        public WriteableMapBinary(Map<K,V> map) {
059                this.value = map;
060        }
061        
062        @Override
063        public void writeBinary(DataOutput out) throws IOException {
064                out.writeInt(value.size());
065                
066                for (Entry<K,V> entry : value.entrySet()) {
067                        writeKey(entry.getKey(), out);
068                        writeValue(entry.getValue(), out);
069                }
070        }
071
072        protected abstract void writeKey(K key, DataOutput out) throws IOException;
073
074        protected abstract void writeValue(V value2, DataOutput out) throws IOException;
075
076        @Override
077        public byte[] binaryHeader() {
078                return value.getClass().getName().getBytes();
079        }
080
081}