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.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035import java.util.List;
036
037import org.openimaj.io.ReadableBinary;
038import org.openimaj.io.WriteableBinary;
039
040/**
041 * A wrapper for {@link List}s that is both {@link ReadableBinary} 
042 * and {@link WriteableBinary}.
043 * 
044 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
045 *
046 * @param <V> The type of the elements of the list.
047 */
048public abstract class ReadWriteableListBinary<V> implements ReadableBinary, WriteableBinary {
049        /**
050         * The underlying list 
051         */
052        public List<V> value;
053        
054        /**
055         * Construct with the given list. The list is retained,
056         * so changes are reflected internally.
057         * @param list The list.
058         */
059        public ReadWriteableListBinary(List<V> list) {
060                this.value = list;
061        }
062        
063        @Override
064        public void writeBinary(DataOutput out) throws IOException {
065                out.writeInt(value.size());
066                
067                for (V v : value) {
068                        writeValue(v, out);
069                }
070        }
071
072        protected abstract void writeValue(V v, DataOutput out) throws IOException;
073
074        @Override
075        public void readBinary(DataInput in) throws IOException {
076                int sz = in.readInt();
077                
078                for (int i=0; i<sz; i++) {
079                        value.add( readValue(in) );
080                }
081        }
082
083        protected abstract V readValue(DataInput in) throws IOException;
084
085        @Override
086        public byte[] binaryHeader() {
087                return value.getClass().getName().getBytes();
088        }
089}