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.io.PrintWriter;
036import java.util.Scanner;
037
038import org.openimaj.io.ReadWriteable;
039
040/**
041 * A wrapper around a String that can be read and written.
042 * 
043 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
044 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
045 *
046 */
047public class ReadWriteableString implements ReadWriteable {
048        /**
049         * The underlying value
050         */
051        public String value;
052        
053        /**
054         * Construct a ReadWriteableString with the given value
055         * @param value the value
056         */
057        public ReadWriteableString(String value) {
058                this.value = value;
059        }
060        
061        /**
062         * Construct a ReadWriteableString with an empty string
063         */
064        public ReadWriteableString() {
065                this.value = "";
066        }
067
068        /* (non-Javadoc)
069         * @see org.openimaj.utils.Readable#readBinary(java.io.DataInput)
070         */
071        @Override
072        public void readBinary(DataInput in) throws IOException {
073                value = in.readUTF();
074        }
075
076        /* (non-Javadoc)
077         * @see org.openimaj.utils.Readable#readASCII(java.util.Scanner)
078         */
079        @Override
080        public void readASCII(Scanner in) throws IOException {
081                int len = in.nextInt();
082                value = in.next(".{"+len+"}");
083        }
084
085        /* (non-Javadoc)
086         * @see org.openimaj.utils.Readable#binaryHeader()
087         */
088        @Override
089        public byte[] binaryHeader() {
090                return new byte[0];
091        }
092
093        /* (non-Javadoc)
094         * @see org.openimaj.utils.Readable#asciiHeader()
095         */
096        @Override
097        public String asciiHeader() {
098                return "";
099        }
100
101        /* (non-Javadoc)
102         * @see org.openimaj.utils.Writeable#writeBinary(java.io.DataOutput)
103         */
104        @Override
105        public void writeBinary(DataOutput out) throws IOException {
106                out.writeUTF(value);
107        }
108
109        /* (non-Javadoc)
110         * @see org.openimaj.utils.Writeable#writeASCII(java.io.PrintWriter)
111         */
112        @Override
113        public void writeASCII(PrintWriter out) throws IOException {
114                out.format("%d %s\n", value.length(), value);
115        }
116        
117        /* (non-Javadoc)
118         * @see java.lang.Object#equals(java.lang.Object)
119         */
120        @Override
121        public boolean equals(Object o){
122                return o instanceof ReadWriteableString && ((ReadWriteableString)o).value.equals(this.value);
123        }
124        
125        /* (non-Javadoc)
126         * @see java.lang.Object#hashCode()
127         */
128        @Override
129        public int hashCode(){
130                return this.value.hashCode();
131        }
132}