01: /*
02: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: *
23: * Free Software Foundation, Inc.
24: * 59 Temple Place, Suite 330
25: * Boston, MA 02111-1307 USA
26: *
27: * @author Scott Ferguson
28: */
29:
30: package com.caucho.quercus.lib.file;
31:
32: import com.caucho.quercus.env.Value;
33:
34: /**
35: * Interface for a Quercus stream
36: */
37: public interface BinaryStream {
38: /**
39: * All streams can be closed.
40: */
41: public void close();
42:
43: /**
44: * Tells the position in the stream.
45: * The valid range for a stream position is 0 to Long.MAX_VALUE,
46: * so a negative number can't be a valid stream position.
47: */
48: public long getPosition();
49:
50: /**
51: * Sets the current position in the stream.
52: * Returns true on success, false otherwise.
53: */
54: public boolean setPosition(long offset);
55:
56: /**
57: * Returns true if end-of-file has been reached
58: */
59: public boolean isEOF();
60:
61: /**
62: * Returns an array filled with stat information. Mainly for wrapped
63: * stream functionality.
64: */
65: public Value stat();
66: }
|