From 765063ae478d8e72350e4009659437843c4e9bc5 Mon Sep 17 00:00:00 2001 From: Ziver Koc Date: Wed, 6 Jul 2016 17:35:58 +0200 Subject: [PATCH] Renamed Boundary buffer and improved InputStreamCloser --- ....java => BufferedBoundaryInputStream.java} | 482 +++++++++--------- src/zutil/io/InputStreamCloser.java | 11 +- ...a => BufferedBoundaryInputStreamTest.java} | 19 +- 3 files changed, 255 insertions(+), 257 deletions(-) rename src/zutil/io/{BoundaryBufferedInputStream.java => BufferedBoundaryInputStream.java} (92%) mode change 100644 => 100755 mode change 100644 => 100755 src/zutil/io/InputStreamCloser.java rename test/zutil/io/{BoundaryBufferedInputStreamTest.java => BufferedBoundaryInputStreamTest.java} (81%) diff --git a/src/zutil/io/BoundaryBufferedInputStream.java b/src/zutil/io/BufferedBoundaryInputStream.java old mode 100644 new mode 100755 similarity index 92% rename from src/zutil/io/BoundaryBufferedInputStream.java rename to src/zutil/io/BufferedBoundaryInputStream.java index 9d4f682..47cde39 --- a/src/zutil/io/BoundaryBufferedInputStream.java +++ b/src/zutil/io/BufferedBoundaryInputStream.java @@ -1,241 +1,241 @@ -/* - * The MIT License (MIT) - * - * Copyright (c) 2015 Ziver Koc - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN - * THE SOFTWARE. - */ - -package zutil.io; - -import java.io.FilterInputStream; -import java.io.IOException; -import java.io.InputStream; - -/** - * TODO: boundry - * - * @author Ziver - * - */ -public class BoundaryBufferedInputStream extends FilterInputStream{ - /** The size of the buffer in Byte */ - public static final int DEFAULT_BUF_SIZE = 64*1024; - - /** The raw buffer */ - protected byte buffer[]; - /** The end position of the buffer */ - protected int buf_end = 0; - /** The current position in the buffer */ - protected int buf_pos = 0; - /** The boundary (the delimiter) */ - protected byte[] boundary; - /** Boundary position, 0< means no boundary found */ - protected int bound_pos; - - - /** - * Creates a instance of this class with a default buffer size of 64K - * - * @param in is the InputStream that the buffer will use - */ - public BoundaryBufferedInputStream(InputStream in){ - this(in, DEFAULT_BUF_SIZE); - } - - /** - * Creates a instance of this class - * - * @param in is the InputStream that the buffer will use - * @param buf_size speifies the buffer size - */ - public BoundaryBufferedInputStream(InputStream in, int buf_size){ - super(in); - buf_end = 0; - buf_pos = 0; - buffer = new byte[buf_size]; - bound_pos = -1; - } - - /** - * Moves the remaining data to the beginning of the - * buffer and then fills the buffer with data from - * the source stream to the buffer - * - * @return the size of the buffer - */ - protected int fillBuffer() throws IOException { - int leftover = buf_end - buf_pos; - // is there any data available - if(leftover < 0 && super.available() <= 0) - return -1; // EOF - - // Move the end of the buffer to the start to not miss any split boundary - System.arraycopy(buffer, buf_pos, buffer, 0, buf_end); - // Copy in new data from the stream - int n = super.read(buffer, leftover, buffer.length ); - // Reset positions - if(n+leftover >= 0) { - buf_end = leftover + n; - buf_pos = 0; - } - searchNextBoundary(); - return n+leftover; - } - - - /** - * @return the next byte in the buffer - */ - public final int read() throws IOException{ - if(buf_pos >= buf_end-boundary.length) { - if(fillBuffer() <= 0) - return -1; // EOF - } - - if(bound_pos == buf_pos) - return -1; // boundary - return buffer[buf_pos++]; - } - - /** - * Fills the given array with data from the buffer - * - * @param b is the array that will be filled - * @return the amount of bytes read or -1 if EOF - */ - public int read(byte b[]) throws IOException { - return read(b, 0, b.length); - } - - /** - * Reads a given length of bytes from the buffer - * - * @param b is the array that will be filled - * @param off is the offset in the array - * @param len is the amount to read - * @return the amount of bytes read or -1 if EOF - */ - public int read(byte b[], int off, int len) throws IOException { - if(bound_pos == buf_pos) - return -1; // boundary - - if(buf_pos >= buf_end-boundary.length) { - if(fillBuffer() <= 0) - return -1; // EOF - } - int leftover = buf_end - buf_pos; - - // The request is larger then the buffer size - if(len > leftover){ - len = leftover; - } - // the boundary is in the read range - if(buf_pos < bound_pos && bound_pos < buf_pos+len){ - len = buf_pos - bound_pos; - } - - System.arraycopy(buffer, buf_pos, b, off, len); - buf_pos += len; - return len; - } - - /** - * Skips over the boundary at the current position in the buffer - */ - public void next(){ - if(bound_pos == buf_pos){ - buf_pos += boundary.length; - searchNextBoundary(); - } - } - - /** - * Searches for the nearest boundary from the current position - */ - protected void searchNextBoundary(){ - for(int i=buf_pos; i leftover){ - buf_pos = buf_end; - return leftover; - } - return buf_pos += n; - } - - - /** - * Sets the boundary for the stream - */ - public void setBoundary(String b){ - this.boundary = b.getBytes(); - } - - /** - * Sets the boundary for the stream - */ - public void setBoundary(byte[] b){ - boundary = new byte[b.length]; - System.arraycopy(b, 0, boundary, 0, b.length); - } - - /** - * @return if current position in the buffer is a boundary - */ - public boolean isBoundary(){ - return bound_pos == buf_pos; - } - - /** - * @return an estimate of the number of bytes that can be read (or skipped - * over) from this buffered input stream without blocking. - * @exception IOException if an I/O error occurs. - */ - public int available() throws IOException { - return buf_end - buf_pos; - } - - /** - * Tests if this input stream supports the mark and - * reset methods. - */ - public boolean markSupported(){ - return false; - } -} +/* + * The MIT License (MIT) + * + * Copyright (c) 2015 Ziver Koc + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +package zutil.io; + +import java.io.FilterInputStream; +import java.io.IOException; +import java.io.InputStream; + +/** + * TODO: boundry + * + * @author Ziver + * + */ +public class BufferedBoundaryInputStream extends FilterInputStream{ + /** The size of the buffer in bytes */ + public static final int DEFAULT_BUF_SIZE = 64*1024; + + /** The raw buffer */ + protected byte buffer[]; + /** The end position of the buffer */ + protected int buf_end = 0; + /** The current position in the buffer */ + protected int buf_pos = 0; + /** The boundary (the delimiter) */ + protected byte[] boundary; + /** Boundary position, 0< means no boundary found */ + protected int bound_pos; + + + /** + * Creates a instance of this class with a default buffer size of 64K + * + * @param in is the InputStream that the buffer will use + */ + public BufferedBoundaryInputStream(InputStream in){ + this(in, DEFAULT_BUF_SIZE); + } + + /** + * Creates a instance of this class + * + * @param in is the InputStream that the buffer will use + * @param buf_size speifies the buffer size + */ + public BufferedBoundaryInputStream(InputStream in, int buf_size){ + super(in); + buf_end = 0; + buf_pos = 0; + buffer = new byte[buf_size]; + bound_pos = -1; + } + + /** + * Moves the remaining data to the beginning of the + * buffer and then fills the buffer with data from + * the source stream to the buffer + * + * @return the size of the buffer + */ + protected int fillBuffer() throws IOException { + int leftover = buf_end - buf_pos; + // is there any data available + if(leftover < 0 && super.available() <= 0) + return -1; // EOF + + // Move the end of the buffer to the start to not miss any split boundary + System.arraycopy(buffer, buf_pos, buffer, 0, buf_end); + // Copy in new data from the stream + int n = super.read(buffer, leftover, buffer.length ); + // Reset positions + if(n+leftover >= 0) { + buf_end = leftover + n; + buf_pos = 0; + } + searchNextBoundary(); + return n+leftover; + } + + + /** + * @return the next byte in the buffer + */ + public final int read() throws IOException{ + if(buf_pos >= buf_end-boundary.length) { + if(fillBuffer() <= 0) + return -1; // EOF + } + + if(bound_pos == buf_pos) + return -1; // boundary + return buffer[buf_pos++]; + } + + /** + * Fills the given array with data from the buffer + * + * @param b is the array that will be filled + * @return the amount of bytes read or -1 if EOF + */ + public int read(byte b[]) throws IOException { + return read(b, 0, b.length); + } + + /** + * Reads a given length of bytes from the buffer + * + * @param b is the array that will be filled + * @param off is the offset in the array + * @param len is the amount to read + * @return the amount of bytes read or -1 if EOF + */ + public int read(byte b[], int off, int len) throws IOException { + if(bound_pos == buf_pos) + return -1; // boundary + + if(buf_pos >= buf_end-boundary.length) { + if(fillBuffer() <= 0) + return -1; // EOF + } + int leftover = buf_end - buf_pos; + + // The request is larger then the buffer size + if(len > leftover){ + len = leftover; + } + // the boundary is in the read range + if(buf_pos < bound_pos && bound_pos < buf_pos+len){ + len = buf_pos - bound_pos; + } + + System.arraycopy(buffer, buf_pos, b, off, len); + buf_pos += len; + return len; + } + + /** + * Skips over the boundary at the current position in the buffer + */ + public void next(){ + if(bound_pos == buf_pos){ + buf_pos += boundary.length; + searchNextBoundary(); + } + } + + /** + * Searches for the nearest boundary from the current position + */ + protected void searchNextBoundary(){ + for(int i=buf_pos; i leftover){ + buf_pos = buf_end; + return leftover; + } + return buf_pos += n; + } + + + /** + * Sets the boundary for the stream + */ + public void setBoundary(String b){ + this.boundary = b.getBytes(); + } + + /** + * Sets the boundary for the stream + */ + public void setBoundary(byte[] b){ + boundary = new byte[b.length]; + System.arraycopy(b, 0, boundary, 0, b.length); + } + + /** + * @return if current position in the buffer is a boundary + */ + public boolean isBoundary(){ + return bound_pos == buf_pos; + } + + /** + * @return an estimate of the number of bytes that can be read (or skipped + * over) from this buffered input stream without blocking. + * @exception IOException if an I/O error occurs. + */ + public int available() throws IOException { + return buf_end - buf_pos; + } + + /** + * Tests if this input stream supports the mark and + * reset methods. + */ + public boolean markSupported(){ + return false; + } +} diff --git a/src/zutil/io/InputStreamCloser.java b/src/zutil/io/InputStreamCloser.java old mode 100644 new mode 100755 index cfd1478..62971cc --- a/src/zutil/io/InputStreamCloser.java +++ b/src/zutil/io/InputStreamCloser.java @@ -30,23 +30,24 @@ import java.io.InputStream; /** * A simple Class that mirrors a InputStream but - * also has an additional Closeable object that - * will be closed with the InputStream + * also has an additional Closeable objects that + * will be closed when the this object is closed. * * @author Ziver */ public class InputStreamCloser extends InputStream{ - private Closeable c; + private Closeable[] c; private InputStream in; - public InputStreamCloser(InputStream in, Closeable c){ + public InputStreamCloser(InputStream in, Closeable... c){ this.c = c; this.in = in; } public void close() throws IOException { in.close(); - c.close(); + for (Closeable stream : c) + stream.close(); } // Mirror functions diff --git a/test/zutil/io/BoundaryBufferedInputStreamTest.java b/test/zutil/io/BufferedBoundaryInputStreamTest.java similarity index 81% rename from test/zutil/io/BoundaryBufferedInputStreamTest.java rename to test/zutil/io/BufferedBoundaryInputStreamTest.java index c092adc..25a0fea 100755 --- a/test/zutil/io/BoundaryBufferedInputStreamTest.java +++ b/test/zutil/io/BufferedBoundaryInputStreamTest.java @@ -32,13 +32,12 @@ import static org.junit.Assert.assertEquals; @SuppressWarnings("resource") -public class BoundaryBufferedInputStreamTest { +public class BufferedBoundaryInputStreamTest { @Test public void testReadB1() throws IOException { - StringInputStream inin = new StringInputStream(); - BoundaryBufferedInputStream in = new BoundaryBufferedInputStream(inin); - inin.add("aaa#aaaaaaaaaaaaaaaa#aaaaaaaaaaaaaaa#"); + StringInputStream inin = new StringInputStream("aaa#aaaaaaaaaaaaaaaa#aaaaaaaaaaaaaaa#"); + BufferedBoundaryInputStream in = new BufferedBoundaryInputStream(inin); in.setBoundary("#"); @@ -63,10 +62,9 @@ public class BoundaryBufferedInputStreamTest { @Test public void testOnlyBoundaries() throws IOException { - StringInputStream inin = new StringInputStream(); - BoundaryBufferedInputStream in = new BoundaryBufferedInputStream(inin); - inin.add("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"); - + StringInputStream inin = new StringInputStream("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"); + BufferedBoundaryInputStream in = new BufferedBoundaryInputStream(inin); + in.setBoundary("a"); int n; @@ -83,9 +81,8 @@ public class BoundaryBufferedInputStreamTest { @Test public void testNoBounds() throws IOException { String data = "1234567891011121314151617181920"; - StringInputStream inin = new StringInputStream(); - BoundaryBufferedInputStream in = new BoundaryBufferedInputStream(inin); - inin.add(data); + StringInputStream inin = new StringInputStream(data); + BufferedBoundaryInputStream in = new BufferedBoundaryInputStream(inin); in.setBoundary("#"); int out;