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