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.List;
035
036import org.openimaj.io.WriteableBinary;
037
038/**
039 * A wrapper for {@link List} that is writeable.
040 * 
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 *
043 * @param <V> The type of the elements of the list.
044 */
045public abstract class WriteableListBinary<V> implements WriteableBinary {
046        /**
047         * The underlying list.
048         */
049        public List<V> value;
050        
051        /**
052         * Construct with the given list. The list is retained,
053         * so changes are reflected internally.
054         * @param list The list.
055         */
056        public WriteableListBinary(List<V> list) {
057                this.value = list;
058        }
059        
060        @Override
061        public void writeBinary(DataOutput out) throws IOException {
062                out.writeInt(value.size());
063                
064                for (V v : value) {
065                        writeValue(v, out);
066                }
067        }
068
069        protected abstract void writeValue(V v, DataOutput out) throws IOException;
070
071        @Override
072        public byte[] binaryHeader() {
073                return value.getClass().getName().getBytes();
074        }
075}