001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: *
023: * Free Software Foundation, Inc.
024: * 59 Temple Place, Suite 330
025: * Boston, MA 02111-1307 USA
026: *
027: * @author Scott Ferguson
028: */
029:
030: package com.caucho.quercus.lib.file;
031:
032: import com.caucho.quercus.env.StringValue;
033:
034: import java.io.IOException;
035: import java.io.InputStream;
036: import java.io.UnsupportedEncodingException;
037:
038: /**
039: * Interface for a Quercus binary input stream
040: */
041: public interface BinaryInput extends BinaryStream {
042: public static final int SEEK_SET = 0;
043: public static final int SEEK_CUR = 1;
044: public static final int SEEK_END = 2;
045:
046: /**
047: * Returns an InputStream to the input.
048: */
049: public InputStream getInputStream();
050:
051: /**
052: * Opens a new copy.
053: */
054: public BinaryInput openCopy() throws IOException;
055:
056: /**
057: * Reads the next byte, returning -1 on eof.
058: */
059: public int read() throws IOException;
060:
061: /**
062: * Unreads the last byte.
063: */
064: public void unread() throws IOException;
065:
066: /**
067: * Reads into a buffer, returning -1 on eof.
068: */
069: public int read(byte[] buffer, int offset, int length)
070: throws IOException;
071:
072: /**
073: * Reads into a buffer, returning -1 on eof.
074: */
075: public int read(char[] buffer, int offset, int length)
076: throws IOException;
077:
078: /**
079: * Reads a Binary string.
080: */
081: public StringValue read(int length) throws IOException;
082:
083: /**
084: * Reads the optional linefeed character from a \r\n
085: */
086: public boolean readOptionalLinefeed() throws IOException;
087:
088: /**
089: * Reads a line from the buffer.
090: */
091: public StringValue readLine(long length) throws IOException;
092:
093: /**
094: * Appends to a string builder.
095: */
096: public StringValue appendTo(StringValue builder) throws IOException;
097:
098: /**
099: * Returns the current location in the stream
100: */
101: public long getPosition();
102:
103: /**
104: * Sets the current location in the stream
105: */
106: public boolean setPosition(long offset);
107:
108: /**
109: * Closes the stream.
110: */
111: public void close();
112:
113: /**
114: * Closes the stream for reading
115: */
116: public void closeRead();
117:
118: /**
119: * Sets the current read encoding. The encoding can either be a
120: * Java encoding name or a mime encoding.
121: *
122: * @param encoding name of the read encoding
123: */
124: public void setEncoding(String encoding)
125: throws UnsupportedEncodingException;
126:
127: /**
128: * Seek according to offset and whence. For fseek() compatibility in
129: * wrapped streams.
130: */
131: public long seek(long offset, int whence);
132: }
|