842 lines
32 KiB
HTML
842 lines
32 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_24) on Sun Apr 15 20:18:19 CEST 2012 -->
|
|
<TITLE>
|
|
Stream
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2012-04-15">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="Stream";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Stream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../System/IO/SeekOrigin.html" title="enum in System.IO"><B>PREV CLASS</B></A>
|
|
NEXT CLASS</FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?System/IO/Stream.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Stream.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
System.IO</FONT>
|
|
<BR>
|
|
Class Stream</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>System.IO.Stream</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../System/IDisposable.html" title="interface in System">IDisposable</A></DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../System/IO/MemoryStream.html" title="class in System.IO">MemoryStream</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public abstract class <B>Stream</B><DT>extends java.lang.Object<DT>implements <A HREF="../../System/IDisposable.html" title="interface in System">IDisposable</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Provides a generic view of a sequence of bytes.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Halofreak1990</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>static System.IO.NullStream</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Null">Null</A></B></CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected </CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Stream()">Stream</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Initializes a new instance of the System.IO.Stream class.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#BeginRead(byte[], int, int, System.AsyncCallback, java.lang.Object)">BeginRead</A></B>(byte[] buffer,
|
|
int offset,
|
|
int count,
|
|
<A HREF="../../System/AsyncCallback.html" title="class in System">AsyncCallback</A> callback,
|
|
java.lang.Object state)</CODE>
|
|
|
|
<BR>
|
|
Begins an asynchronous read operation.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#BeginWrite(byte[], int, int, System.AsyncCallback, java.lang.Object)">BeginWrite</A></B>(byte[] buffer,
|
|
int offset,
|
|
int count,
|
|
<A HREF="../../System/AsyncCallback.html" title="class in System">AsyncCallback</A> callback,
|
|
java.lang.Object state)</CODE>
|
|
|
|
<BR>
|
|
Begins an asynchronous write operation.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#CanRead()">CanRead</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#CanSeek()">CanSeek</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#CanTimeout()">CanTimeout</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#CanWrite()">CanWrite</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Close()">Close</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Dispose()">Dispose</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Releases all resources used by the System.IO.Stream.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Dispose(boolean)">Dispose</A></B>(boolean disposing)</CODE>
|
|
|
|
<BR>
|
|
Releases the unmanaged resources used by the System.IO.Stream and optionally releases the managed resources.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#EndRead(System.IAsyncResult)">EndRead</A></B>(<A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A> asyncResult)</CODE>
|
|
|
|
<BR>
|
|
Waits for the pending asynchronous read to complete.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#EndWrite(System.IAsyncResult)">EndWrite</A></B>(<A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A> asyncResult)</CODE>
|
|
|
|
<BR>
|
|
Ends an asynchronous write operation.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Flush()">Flush</A></B>()</CODE>
|
|
|
|
<BR>
|
|
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#getPosition()">getPosition</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Length()">Length</A></B>()</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Read(byte[], int, int)">Read</A></B>(byte[] buffer,
|
|
int offset,
|
|
int count)</CODE>
|
|
|
|
<BR>
|
|
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#ReadByte()">ReadByte</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract long</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Seek(long, System.IO.SeekOrigin)">Seek</A></B>(long offset,
|
|
<A HREF="../../System/IO/SeekOrigin.html" title="enum in System.IO">SeekOrigin</A> origin)</CODE>
|
|
|
|
<BR>
|
|
When overridden in a derived class, sets the position within the current stream.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#SetLength(long)">SetLength</A></B>(long value)</CODE>
|
|
|
|
<BR>
|
|
When overridden in a derived class, sets the length of the current stream.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#setPosition(long)">setPosition</A></B>(long value)</CODE>
|
|
|
|
<BR>
|
|
</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>abstract void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#Write(byte[], int, int)">Write</A></B>(byte[] buffer,
|
|
int offset,
|
|
int count)</CODE>
|
|
|
|
<BR>
|
|
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../System/IO/Stream.html#WriteByte(byte)">WriteByte</A></B>(byte value)</CODE>
|
|
|
|
<BR>
|
|
Writes a byte to the current position in the stream and advances the position within the stream by one byte.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="Null"><!-- --></A><H3>
|
|
Null</H3>
|
|
<PRE>
|
|
public static final System.IO.NullStream <B>Null</B></PRE>
|
|
<DL>
|
|
<DL>
|
|
</DL>
|
|
</DL>
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="Stream()"><!-- --></A><H3>
|
|
Stream</H3>
|
|
<PRE>
|
|
protected <B>Stream</B>()</PRE>
|
|
<DL>
|
|
<DD>Initializes a new instance of the System.IO.Stream class.
|
|
<P>
|
|
</DL>
|
|
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TH>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="CanRead()"><!-- --></A><H3>
|
|
CanRead</H3>
|
|
<PRE>
|
|
public abstract boolean <B>CanRead</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="CanSeek()"><!-- --></A><H3>
|
|
CanSeek</H3>
|
|
<PRE>
|
|
public abstract boolean <B>CanSeek</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="CanTimeout()"><!-- --></A><H3>
|
|
CanTimeout</H3>
|
|
<PRE>
|
|
public boolean <B>CanTimeout</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="CanWrite()"><!-- --></A><H3>
|
|
CanWrite</H3>
|
|
<PRE>
|
|
public abstract boolean <B>CanWrite</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Length()"><!-- --></A><H3>
|
|
Length</H3>
|
|
<PRE>
|
|
public abstract long <B>Length</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPosition()"><!-- --></A><H3>
|
|
getPosition</H3>
|
|
<PRE>
|
|
public abstract long <B>getPosition</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPosition(long)"><!-- --></A><H3>
|
|
setPosition</H3>
|
|
<PRE>
|
|
public abstract void <B>setPosition</B>(long value)</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BeginRead(byte[], int, int, System.AsyncCallback, java.lang.Object)"><!-- --></A><H3>
|
|
BeginRead</H3>
|
|
<PRE>
|
|
public <A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A> <B>BeginRead</B>(byte[] buffer,
|
|
int offset,
|
|
int count,
|
|
<A HREF="../../System/AsyncCallback.html" title="class in System">AsyncCallback</A> callback,
|
|
java.lang.Object state)</PRE>
|
|
<DL>
|
|
<DD>Begins an asynchronous read operation.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - <DD><CODE>offset</CODE> - <DD><CODE>count</CODE> - <DD><CODE>callback</CODE> - <DD><CODE>state</CODE> -
|
|
<DT><B>Returns:</B><DD></DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="BeginWrite(byte[], int, int, System.AsyncCallback, java.lang.Object)"><!-- --></A><H3>
|
|
BeginWrite</H3>
|
|
<PRE>
|
|
public <A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A> <B>BeginWrite</B>(byte[] buffer,
|
|
int offset,
|
|
int count,
|
|
<A HREF="../../System/AsyncCallback.html" title="class in System">AsyncCallback</A> callback,
|
|
java.lang.Object state)</PRE>
|
|
<DL>
|
|
<DD>Begins an asynchronous write operation.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - The buffer to write data from.<DD><CODE>offset</CODE> - The byte offset in buffer from which to begin writing.<DD><CODE>count</CODE> - The maximum number of bytes to write.<DD><CODE>callback</CODE> - An optional asynchronous callback, to be called when the write is complete.<DD><CODE>state</CODE> - A user-provided object that distinguishes this particular asynchronous write request from other requests.
|
|
<DT><B>Returns:</B><DD>An IAsyncResult that represents the asynchronous write, which could still be pending.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - Attempted an asynchronous write past the end of the stream, or a disk error occurs.
|
|
<DD><CODE><A HREF="../../System/ArgumentException.html" title="class in System">ArgumentException</A></CODE> - One or more of the arguments is invalid.
|
|
<DD><CODE><A HREF="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</A></CODE> - Methods were called after the stream was closed.
|
|
<DD><CODE><A HREF="../../System/NotSupportedException.html" title="class in System">NotSupportedException</A></CODE> - The current Stream implementation does not support the write operation.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Close()"><!-- --></A><H3>
|
|
Close</H3>
|
|
<PRE>
|
|
public void <B>Close</B>()</PRE>
|
|
<DL>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Dispose()"><!-- --></A><H3>
|
|
Dispose</H3>
|
|
<PRE>
|
|
public void <B>Dispose</B>()</PRE>
|
|
<DL>
|
|
<DD>Releases all resources used by the System.IO.Stream.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../System/IDisposable.html#Dispose()">Dispose</A></CODE> in interface <CODE><A HREF="../../System/IDisposable.html" title="interface in System">IDisposable</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Dispose(boolean)"><!-- --></A><H3>
|
|
Dispose</H3>
|
|
<PRE>
|
|
protected void <B>Dispose</B>(boolean disposing)</PRE>
|
|
<DL>
|
|
<DD>Releases the unmanaged resources used by the System.IO.Stream and optionally releases the managed resources.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>disposing</CODE> - true to release both managed and unmanaged resources; false to release only unmanaged resources.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="EndRead(System.IAsyncResult)"><!-- --></A><H3>
|
|
EndRead</H3>
|
|
<PRE>
|
|
public int <B>EndRead</B>(<A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A> asyncResult)</PRE>
|
|
<DL>
|
|
<DD>Waits for the pending asynchronous read to complete.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>asyncResult</CODE> - The reference to the pending asynchronous request to finish.
|
|
<DT><B>Returns:</B><DD>The number of bytes read from the stream, between zero (0) and the number of bytes you requested.
|
|
Streams return zero (0) only at the end of the stream, otherwise, they should block until at least one byte is
|
|
available.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="EndWrite(System.IAsyncResult)"><!-- --></A><H3>
|
|
EndWrite</H3>
|
|
<PRE>
|
|
public void <B>EndWrite</B>(<A HREF="../../System/IAsyncResult.html" title="interface in System">IAsyncResult</A> asyncResult)</PRE>
|
|
<DL>
|
|
<DD>Ends an asynchronous write operation.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>asyncResult</CODE> - The reference to the pending asynchronous request to finish.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</A></CODE> - asyncResult is null.
|
|
<DD><CODE><A HREF="../../System/ArgumentException.html" title="class in System">ArgumentException</A></CODE> - asyncResult did not originate from a System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object) method on the current stream.
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - The stream is closed or an internal error has occurred.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Flush()"><!-- --></A><H3>
|
|
Flush</H3>
|
|
<PRE>
|
|
public abstract void <B>Flush</B>()</PRE>
|
|
<DL>
|
|
<DD>When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - An I/O error occurs.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Read(byte[], int, int)"><!-- --></A><H3>
|
|
Read</H3>
|
|
<PRE>
|
|
public abstract int <B>Read</B>(byte[] buffer,
|
|
int offset,
|
|
int count)</PRE>
|
|
<DL>
|
|
<DD>When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.<DD><CODE>offset</CODE> - The zero-based byte offset in buffer at which to begin storing the data read from the current stream.<DD><CODE>count</CODE> - The maximum number of bytes to be read from the current stream.
|
|
<DT><B>Returns:</B><DD>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/ArgumentException.html" title="class in System">ArgumentException</A></CODE> - The sum of offset and count is larger than the buffer length.
|
|
<DD><CODE><A HREF="../../System/ArgumentNullException.html" title="class in System">ArgumentNullException</A></CODE> - buffer is null.
|
|
<DD><CODE><A HREF="../../System/ArgumentOutOfRangeException.html" title="class in System">ArgumentOutOfRangeException</A></CODE> - offset or count is negative.
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - An I/O error occurs.
|
|
<DD><CODE><A HREF="../../System/NotSupportedException.html" title="class in System">NotSupportedException</A></CODE> - The stream does not support reading.
|
|
<DD><CODE><A HREF="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</A></CODE> - Methods were called after the stream was closed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="ReadByte()"><!-- --></A><H3>
|
|
ReadByte</H3>
|
|
<PRE>
|
|
public int <B>ReadByte</B>()</PRE>
|
|
<DL>
|
|
<DD>Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>The unsigned byte cast to an Int32, or -1 if at the end of the stream.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/NotSupportedException.html" title="class in System">NotSupportedException</A></CODE> - The stream does not support reading.
|
|
<DD><CODE><A HREF="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</A></CODE> - Methods were called after the stream was closed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Seek(long, System.IO.SeekOrigin)"><!-- --></A><H3>
|
|
Seek</H3>
|
|
<PRE>
|
|
public abstract long <B>Seek</B>(long offset,
|
|
<A HREF="../../System/IO/SeekOrigin.html" title="enum in System.IO">SeekOrigin</A> origin)</PRE>
|
|
<DL>
|
|
<DD>When overridden in a derived class, sets the position within the current stream.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>offset</CODE> - A byte offset relative to the origin parameter.<DD><CODE>origin</CODE> - A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.
|
|
<DT><B>Returns:</B><DD>The new position within the current stream.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - An I/O error occurs.
|
|
<DD><CODE><A HREF="../../System/NotSupportedException.html" title="class in System">NotSupportedException</A></CODE> - The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
|
|
<DD><CODE><A HREF="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</A></CODE> - Methods were called after the stream was closed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetLength(long)"><!-- --></A><H3>
|
|
SetLength</H3>
|
|
<PRE>
|
|
public abstract void <B>SetLength</B>(long value)</PRE>
|
|
<DL>
|
|
<DD>When overridden in a derived class, sets the length of the current stream.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The desired length of the current stream in bytes.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - An I/O error occurs.
|
|
<DD><CODE><A HREF="../../System/NotSupportedException.html" title="class in System">NotSupportedException</A></CODE> - The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
|
|
<DD><CODE><A HREF="../../System/ObjectDisposedException.html" title="class in System">ObjectDisposedException</A></CODE> - Methods were called after the stream was closed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Write(byte[], int, int)"><!-- --></A><H3>
|
|
Write</H3>
|
|
<PRE>
|
|
public abstract void <B>Write</B>(byte[] buffer,
|
|
int offset,
|
|
int count)</PRE>
|
|
<DL>
|
|
<DD>When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - An array of bytes. This method copies count bytes from buffer to the current stream.<DD><CODE>offset</CODE> - The zero-based byte offset in buffer at which to begin copying bytes to the current stream.<DD><CODE>count</CODE> - The number of bytes to be written to the current stream.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="WriteByte(byte)"><!-- --></A><H3>
|
|
WriteByte</H3>
|
|
<PRE>
|
|
public void <B>WriteByte</B>(byte value)</PRE>
|
|
<DL>
|
|
<DD>Writes a byte to the current position in the stream and advances the position within the stream by one byte.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>value</CODE> - The byte to write to the stream.
|
|
<DT><B>Throws:</B>
|
|
<DD><CODE><A HREF="../../System/IO/IOException.html" title="class in System.IO">IOException</A></CODE> - An I/O error occurs.
|
|
<DD><CODE><A HREF="../../System/NotSupportedException.html" title="class in System">NotSupportedException</A></CODE> - The stream does not support writing, or the stream is already closed.</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Stream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../System/IO/SeekOrigin.html" title="enum in System.IO"><B>PREV CLASS</B></A>
|
|
NEXT CLASS</FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../index.html?System/IO/Stream.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Stream.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|