| java.lang.Object
 com.caucho.vfs.StreamImpl
All known Subclasses: com.caucho.vfs.SocketStream, com.caucho.vfs.MultipartStream, com.caucho.vfs.TempReadStream, com.caucho.vfs.StringWriter, com.caucho.vfs.MemoryStream, com.caucho.vfs.TempCharStream, com.caucho.vfs.HttpStreamWrapper, com.caucho.vfs.HttpStream, com.caucho.vfs.StdoutStream, com.caucho.vfs.StringReader, com.caucho.vfs.StreamFilter, com.caucho.vfs.WriterStreamImpl, com.caucho.vfs.PipeStream, com.caucho.vfs.ReaderStream, com.caucho.vfs.StderrStream, com.caucho.vfs.Crc64Stream, com.caucho.vfs.TcpStream, com.caucho.vfs.ReaderWriterStream, com.caucho.vfs.VfsStream, com.caucho.vfs.TempStream, com.caucho.vfs.FileReadStream, com.caucho.vfs.StringStream,
| StreamImpl | | public class StreamImpl (Code) | | This is the service provider's interface for a stream supported by
the VFS.
|
| Method Summary | |
| public boolean | canRead()
Returns true if this is a read stream. | | public boolean | canWrite()
Returns true if this is a writable stream. | | public void | clearWrite()
Clears any buffered values in the write. | | public void | close()
Closes the stream. | | public void | closeWrite()
Closes the write half of the stream. | | public void | flush()
Flushes the write output. | | public void | flushBuffer()
Flushes buffered writes. | | public void | flushToDisk()
Flushes the write output, forcing to disk. | | public Object | getAttribute(String name)
Returns a stream attribute.
Parameters:
name - the attribute name. | | public Iterator | getAttributeNames()
Returns an iterator of the attribute names. | | public int | getAvailable()
Returns the number of bytes available without blocking. | | public boolean | getFlushOnNewline()
Returns true if the buffer should be flushed on every newline. | | public byte[] | getNewline()
Returns the stream's natural newline character. | | public Path | getPath()
Returns the Path associated with the stream. | | public byte[] | getReadBuffer()
Returns the read buffer. | | public long | getReadPosition()
Returns the current read position of the underlying file. | | public boolean | hasSkip()
Returns true if the stream implements skip. | | public int | read(byte[] buffer, int offset, int length)
Reads the next chunk from the stream.
Parameters:
buffer - byte array receiving the data.
Parameters:
offset - starting offset into the array.
Parameters:
length - number of bytes to read. | | public int | readNonBlock(byte[] buffer, int offset, int length)
Reads the next chunk from the stream in non-blocking mode.
Parameters:
buffer - byte array receiving the data.
Parameters:
offset - starting offset into the array.
Parameters:
length - number of bytes to read. | | public int | readTimeout(byte[] buffer, int offset, int length, long timeout)
Reads the next chunk from the stream in non-blocking mode.
Parameters:
buffer - byte array receiving the data.
Parameters:
offset - starting offset into the array.
Parameters:
length - number of bytes to read. | | public void | removeAttribute(String name)
Removes a stream attribute. | | public void | seekEnd(long offset)
Seeks based on the end. | | public void | seekStart(long offset)
Seeks based on the start. | | public void | setAttribute(String name, Object value)
Sets a stream attribute. | | public void | setPath(Path path)
Sets the Path associated with the stream. | | public void | setWriteEncoding(String encoding)
Sets the write encoding. | | public long | skip(long n)
Skips a number of bytes, returning the bytes skipped.
Parameters:
n - the number of types to skip. | | public void | write(byte[] buffer, int offset, int length, boolean isEnd)
Writes a buffer to the underlying stream. | | public boolean | write(byte[] buf1, int off1, int len1, byte[] buf2, int off2, int len2, boolean isEnd)
Writes a pair of buffer to the underlying stream. |
| canRead | | public boolean canRead()(Code) | | Returns true if this is a read stream.
|
| canWrite | | public boolean canWrite()(Code) | | Returns true if this is a writable stream.
|
| clearWrite | | public void clearWrite()(Code) | | Clears any buffered values in the write.
|
| closeWrite | | public void closeWrite() throws IOException(Code) | | Closes the write half of the stream.
|
| flushBuffer | | public void flushBuffer() throws IOException(Code) | | Flushes buffered writes.
|
| flushToDisk | | public void flushToDisk() throws IOException(Code) | | Flushes the write output, forcing to disk.
|
| getAttribute | | public Object getAttribute(String name) throws IOException(Code) | | Returns a stream attribute.
Parameters:
name - the attribute name. the attribute value. |
| getAvailable | | public int getAvailable() throws IOException(Code) | | Returns the number of bytes available without blocking. Depending on
the stream, this may return less than the actual bytes, but will always
return a number > 0 if there is any data available.
|
| getFlushOnNewline | | public boolean getFlushOnNewline()(Code) | | Returns true if the buffer should be flushed on every newline. This is
typically only true for error streams like stderr:.
|
| getNewline | | public byte[] getNewline()(Code) | | Returns the stream's natural newline character.
|
| getPath | | public Path getPath()(Code) | | Returns the Path associated with the stream.
|
| getReadBuffer | | public byte[] getReadBuffer()(Code) | | Returns the read buffer.
|
| getReadPosition | | public long getReadPosition()(Code) | | Returns the current read position of the underlying file.
|
| hasSkip | | public boolean hasSkip()(Code) | | Returns true if the stream implements skip.
|
| read | | public int read(byte[] buffer, int offset, int length) throws IOException(Code) | | Reads the next chunk from the stream.
Parameters:
buffer - byte array receiving the data.
Parameters:
offset - starting offset into the array.
Parameters:
length - number of bytes to read. the number of bytes read or -1 on end of file. |
| readNonBlock | | public int readNonBlock(byte[] buffer, int offset, int length) throws IOException(Code) | | Reads the next chunk from the stream in non-blocking mode.
Parameters:
buffer - byte array receiving the data.
Parameters:
offset - starting offset into the array.
Parameters:
length - number of bytes to read. the number of bytes read or -1 on end of file. |
| readTimeout | | public int readTimeout(byte[] buffer, int offset, int length, long timeout) throws IOException(Code) | | Reads the next chunk from the stream in non-blocking mode.
Parameters:
buffer - byte array receiving the data.
Parameters:
offset - starting offset into the array.
Parameters:
length - number of bytes to read. the number of bytes read or -1 on end of file. |
| removeAttribute | | public void removeAttribute(String name) throws IOException(Code) | | Removes a stream attribute.
Parameters:
name - the attribute name. |
| seekEnd | | public void seekEnd(long offset) throws IOException(Code) | | Seeks based on the end.
|
| seekStart | | public void seekStart(long offset) throws IOException(Code) | | Seeks based on the start.
|
| setAttribute | | public void setAttribute(String name, Object value) throws IOException(Code) | | Sets a stream attribute.
Parameters:
name - the attribute name.
Parameters:
value - the attribute value. |
| setPath | | public void setPath(Path path)(Code) | | Sets the Path associated with the stream.
|
| setWriteEncoding | | public void setWriteEncoding(String encoding)(Code) | | Sets the write encoding.
|
| skip | | public long skip(long n) throws IOException(Code) | | Skips a number of bytes, returning the bytes skipped.
Parameters:
n - the number of types to skip. the actual bytes skipped. |
| write | | public void write(byte[] buffer, int offset, int length, boolean isEnd) throws IOException(Code) | | Writes a buffer to the underlying stream.
Parameters:
buffer - the byte array to write.
Parameters:
offset - the offset into the byte array.
Parameters:
length - the number of bytes to write.
Parameters:
isEnd - true when the write is flushing a close. |
| write | | public boolean write(byte[] buf1, int off1, int len1, byte[] buf2, int off2, int len2, boolean isEnd) throws IOException(Code) | | Writes a pair of buffer to the underlying stream.
Parameters:
buf1 - the byte array to write.
Parameters:
off1 - the offset into the byte array.
Parameters:
len1 - the number of bytes to write.
Parameters:
buf2 - the byte array to write.
Parameters:
off2 - the offset into the byte array.
Parameters:
len2 - the number of bytes to write.
Parameters:
isEnd - true when the write is flushing a close. |
|
|