<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<!-- Generated by javadoc (build 1.6.0_10) on Tue Nov 17 12:13:39 PST 2009 -->
<
META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
SharedFileInputStream (JavaMail API documentation)
<
META NAME="date" CONTENT="2009-11-17">
<
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="SharedFileInputStream (JavaMail API documentation)";
}
}
<
BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= 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="">
<
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/SharedFileInputStream.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>
<
TD ALIGN="right" VALIGN="top" ROWSPAN=3><
EM>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../javax/mail/util/SharedByteArrayInputStream.html" title="class in javax.mail.util"><
B>PREV CLASS<
/B><
/A>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../index.html?javax/mail/util/SharedFileInputStream.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="SharedFileInputStream.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>');
}
//-->
<
A HREF="../../../allclasses-noframe.html"><
B>All Classes<
/B><
/A>
<
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>
<
A NAME="skip-navbar_top"><
/A>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
Class SharedFileInputStream<
/H2>
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.
lang.Object<
/A>
<
IMG SRC="../../../resources/inherit.gif" ALT="extended by "><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream<
/A>
<
IMG SRC="../../../resources/inherit.gif" ALT="extended by "><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">java.io.FilterInputStream<
/A>
<
IMG SRC="../../../resources/inherit.gif" ALT="extended by "><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">java.io.BufferedInputStream<
/A>
<
IMG SRC="../../../resources/inherit.gif" ALT="extended by "><
B>javax.mail.util.SharedFileInputStream<
/B>
<
DT><
B>All Implemented Interfaces:<
/B> <
DD><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable<
/A>, <
A HREF="../../../javax/mail/internet/SharedInputStream.html" title="interface in javax.mail.internet">SharedInputStream<
/A><
/DD>
<
DT><
PRE>public
class <
B>SharedFileInputStream<
/B><
DT>extends <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
DT>implements <
A HREF="../../../javax/mail/internet/SharedInputStream.html" title="interface in javax.mail.internet">SharedInputStream<
/A><
/DL>
A <
code>SharedFileInputStream<
/code> is a
<
code>BufferedInputStream<
/code> that buffers
data from the file and supports the <
code>mark<
/code>
and <
code>reset<
/code> methods. It also supports the
<
code>newStream<
/code>
method that allows you to create
other streams that represent subsets of the file.
A <
code>RandomAccessFile<
/code>
object is used to
access the file
data. <
p>
Note that when the SharedFileInputStream is closed,
all streams created with the <
code>newStream<
/code>
method are also closed. This allows the creator of the
SharedFileInputStream object to control access to the
underlying file and ensure that it is closed when
needed, to avoid leaking file descriptors. Note also
that this behavior contradicts the requirements of
SharedInputStream and may change in a future release.
<!-- =========== 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">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#bufpos">bufpos<
/A><
/B><
/CODE>
The file offset that corresponds to the first byte in
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#bufsize">bufsize<
/A><
/B><
/CODE>
The normal
size of the read buffer.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#datalen">datalen<
/A><
/B><
/CODE>
The amount of
data in this subset of the file.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE>protected <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/RandomAccessFile.html?is-external=true" title="class or interface in java.io">RandomAccessFile<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#in">in<
/A><
/B><
/CODE>
The file containing the
data.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#start">start<
/A><
/B><
/CODE>
The file offset of the
start of
data in this subset of the file.<
/TD>
<
A NAME="fields_inherited_from_class_java.io.BufferedInputStream"><!-- --><
/A>
<
TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<
TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<
TH ALIGN="left"><
B>Fields inherited from
class java.io.<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#buf" title="class or interface in java.io">buf<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#count" title="class or interface in java.io">count<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#marklimit" title="class or interface in java.io">marklimit<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#markpos" title="class or interface in java.io">markpos<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#pos" title="class or interface in java.io">pos<
/A><
/CODE><
/TD>
<!-- ======== 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">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#SharedFileInputStream(java.io.File)">SharedFileInputStream<
/A><
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File<
/A> file
)<
/CODE>
Creates a <
code>SharedFileInputStream<
/code>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#SharedFileInputStream(java.io.File, int)">SharedFileInputStream<
/A><
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File<
/A> file,
Creates a <
code>SharedFileInputStream<
/code>
with the specified buffer
size.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#SharedFileInputStream(java.lang.String)">SharedFileInputStream<
/A><
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> file
)<
/CODE>
Creates a <
code>SharedFileInputStream<
/code>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#SharedFileInputStream(java.lang.String, int)">SharedFileInputStream<
/A><
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> file,
Creates a <
code>SharedFileInputStream<
/code>
with the specified buffer
size.<
/TD>
<!-- ========== 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">
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#available()">available<
/A><
/B>
()<
/CODE>
Returns the number of bytes that can be read from this input
stream without blocking.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#close()">close<
/A><
/B>
()<
/CODE>
Closes this input stream and releases any system resources
associated with the stream.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#finalize()">finalize<
/A><
/B>
()<
/CODE>
Force this stream to close.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#getPosition()">getPosition<
/A><
/B>
()<
/CODE>
Return the current position in the InputStream, as an
offset from the beginning of the InputStream.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#mark(int)">mark<
/A><
/B>
(int readlimit
)<
/CODE>
See the general contract of the <
code>mark<
/code>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#markSupported()">markSupported<
/A><
/B>
()<
/CODE>
Tests if this input stream supports the <
code>mark<
/code>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
CODE> <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream<
/A><
/CODE><
/FONT><
/TD>
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#newStream(long, long)">newStream<
/A><
/B>
(long
start,
Return a new InputStream representing a subset of the data
from this InputStream, starting at <
code>start<
/code>
(inclusive
)
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#read()">read<
/A><
/B>
()<
/CODE>
See the general contract of the <
code>read<
/code>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#read(byte[], int, int)">read<
/A><
/B>
(byte
[] b,
int off,
Reads bytes from this stream into the specified byte array,
starting at the given offset.<
/TD>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#reset()">reset<
/A><
/B>
()<
/CODE>
See the general contract of the <
code>reset<
/code>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD ALIGN="right" VALIGN="top" WIDTH="1%"><
FONT SIZE="-1">
<
TD><
CODE><
B><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#skip(long)">skip<
/A><
/B>
(long n
)<
/CODE>
See the general contract of the <
code>skip<
/code>
<
A NAME="methods_inherited_from_class_java.io.FilterInputStream"><!-- --><
/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.io.<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">FilterInputStream<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/FilterInputStream.html?is-external=true#read(byte[])" title="class or interface in java.io">read<
/A><
/CODE><
/TD>
<
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.<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object<
/A><
/B><
/TH>
<
TR BGCOLOR="white" CLASS="TableRowColor">
<
TD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait<
/A>, <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait<
/A><
/CODE><
/TD>
<!-- ============ 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">
<
A NAME="in"><!-- --><
/A><
H3>
protected <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/RandomAccessFile.html?is-external=true" title="class or interface in java.io">RandomAccessFile<
/A> <
B>in<
/B><
/PRE>
<
DD>The file containing the
data.
Shared by all related SharedFileInputStreams.
<
A NAME="bufsize"><!-- --><
/A><
H3>
protected int <
B>bufsize<
/B><
/PRE>
<
DD>The normal
size of the read buffer.
<
A NAME="bufpos"><!-- --><
/A><
H3>
protected long <
B>bufpos<
/B><
/PRE>
<
DD>The file offset that corresponds to the first byte in
the read buffer.
<
A NAME="start"><!-- --><
/A><
H3>
protected long <
B>start<
/B><
/PRE>
<
DD>The file offset of the
start of
data in this subset of the file.
<
A NAME="datalen"><!-- --><
/A><
H3>
protected long <
B>datalen<
/B><
/PRE>
<
DD>The amount of
data in this subset of the file.
<!-- ========= 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">
<
A NAME="SharedFileInputStream(java.io.File)"><!-- --><
/A><
H3>
SharedFileInputStream<
/H3>
public <
B>SharedFileInputStream<
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File<
/A> file
)
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
for the file.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE><
/DL>
<
A NAME="SharedFileInputStream(java.lang.String)"><!-- --><
/A><
H3>
SharedFileInputStream<
/H3>
public <
B>SharedFileInputStream<
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> file
)
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
for the named file
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE><
/DL>
<
A NAME="SharedFileInputStream(java.io.File, int)"><!-- --><
/A><
H3>
SharedFileInputStream<
/H3>
public <
B>SharedFileInputStream<
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File<
/A> file,
int size)
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
with the specified buffer size.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException<
/A><
/CODE> - if
size <
= 0.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE><
/DL>
<
A NAME="SharedFileInputStream(java.lang.String, int)"><!-- --><
/A><
H3>
SharedFileInputStream<
/H3>
public <
B>SharedFileInputStream<
/B>
(<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String<
/A> file,
int size)
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
with the specified buffer size.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException<
/A><
/CODE> - if
size <
= 0.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE><
/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">
<
A NAME="read()"><!-- --><
/A><
H3>
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
<
DD>See the general contract of the <
code>read<
/code>
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#read()" title="class or interface in java.io">read<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Returns:<
/B><
DD>the next byte of
data, or <
code>-
1<
/code> if the end of the
stream is reached.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE> - if an I
/O error occurs.<
/DL>
<
A NAME="read(byte[], int, int)"><!-- --><
/A><
H3>
public int <
B>read<
/B>
(byte
[] b,
int off,
int len)
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
<
DD>Reads bytes from this stream into the specified byte array,
starting at the given offset.
<
p> This
method implements the general contract of the corresponding
<
code><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true#read(byte[], int, int)" title="class or interface in java.io"><
CODE>read<
/CODE><
/A><
/code>
method of the <
code><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><
CODE>InputStream<
/CODE><
/A><
/code>
class.
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#read(byte[], int, int)" title="class or interface in java.io">read<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Parameters:<
/B><
DD><
CODE>b<
/CODE> - destination buffer.<
DD><
CODE>off<
/CODE> - offset at which to
start storing bytes.<
DD><
CODE>len<
/CODE> - maximum number of bytes to read.
<
DT><
B>Returns:<
/B><
DD>the number of bytes read, or <
code>-
1<
/code> if the end of
the stream has been reached.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE> - if an I
/O error occurs.<
/DL>
<
A NAME="skip(long)"><!-- --><
/A><
H3>
public long <
B>skip<
/B>
(long n
)
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
<
DD>See the general contract of the <
code>skip<
/code>
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#skip(long)" title="class or interface in java.io">skip<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Parameters:<
/B><
DD><
CODE>n<
/CODE> - the number of bytes to be skipped.
<
DT><
B>Returns:<
/B><
DD>the actual number of bytes skipped.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE> - if an I
/O error occurs.<
/DL>
<
A NAME="available()"><!-- --><
/A><
H3>
public int <
B>available<
/B>
()
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
<
DD>Returns the number of bytes that can be read from this input
stream without blocking.
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#available()" title="class or interface in java.io">available<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Returns:<
/B><
DD>the number of bytes that can be read from this input
stream without blocking.
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE> - if an I
/O error occurs.<
/DL>
<
A NAME="mark(int)"><!-- --><
/A><
H3>
public void <
B>mark<
/B>
(int readlimit
)<
/PRE>
<
DD>See the general contract of the <
code>mark<
/code>
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#mark(int)" title="class or interface in java.io">mark<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Parameters:<
/B><
DD><
CODE>readlimit<
/CODE> - the maximum limit of bytes that can be read before
the mark position becomes invalid.<
DT><
B>See Also:<
/B><
DD><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#reset()"><
CODE>reset
()<
/CODE><
/A><
/DL>
<
A NAME="reset()"><!-- --><
/A><
H3>
public void <
B>reset<
/B>
()
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
<
DD>See the general contract of the <
code>reset<
/code>
(no mark has been set or the mark has been
invalidated
), an <
code>IOException<
/code>
is thrown. Otherwise, <
code>pos<
/code> is
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#reset()" title="class or interface in java.io">reset<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE> - if this stream has not been marked or
if the mark has been invalidated.<
DT><
B>See Also:<
/B><
DD><
A HREF="../../../javax/mail/util/SharedFileInputStream.html#mark(int)"><
CODE>mark
(int
)<
/CODE><
/A><
/DL>
<
A NAME="markSupported()"><!-- --><
/A><
H3>
public boolean <
B>markSupported<
/B>
()<
/PRE>
<
DD>Tests if this input stream supports the <
code>mark<
/code>
method of <
code>SharedFileInputStream<
/code> returns
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#markSupported()" title="class or interface in java.io">markSupported<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Returns:<
/B><
DD>a <
code>boolean<
/code> indicating if this stream
type supports
the <
code>mark<
/code> and <
code>reset<
/code> methods.<
DT><
B>See Also:<
/B><
DD><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true#mark(int)" title="class or interface in java.io"><
CODE>InputStream.mark
(int
)<
/CODE><
/A>,
<
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true#reset()" title="class or interface in java.io"><
CODE>InputStream.reset
()<
/CODE><
/A><
/DL>
<
A NAME="close()"><!-- --><
/A><
H3>
public void <
B>close<
/B>
()
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/PRE>
<
DD>Closes this input stream and releases any system resources
associated with the stream.
<
DT><
B>Specified by:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Closeable.html?is-external=true#close()" title="class or interface in java.io">close<
/A><
/CODE> in interface <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable<
/A><
/CODE><
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true#close()" title="class or interface in java.io">close<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/BufferedInputStream.html?is-external=true" title="class or interface in java.io">BufferedInputStream<
/A><
/CODE><
/DL>
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException<
/A><
/CODE> - if an I
/O error occurs.<
/DL>
<
A NAME="getPosition()"><!-- --><
/A><
H3>
public long <
B>getPosition<
/B>
()<
/PRE>
<
DD>Return the current position in the InputStream, as an
offset from the beginning of the InputStream.
<
DT><
B>Specified by:<
/B><
DD><
CODE><
A HREF="../../../javax/mail/internet/SharedInputStream.html#getPosition()">getPosition<
/A><
/CODE> in interface <
CODE><
A HREF="../../../javax/mail/internet/SharedInputStream.html" title="interface in javax.mail.internet">SharedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Returns:<
/B><
DD>the current position<
/DL>
<
A NAME="newStream(long, long)"><!-- --><
/A><
H3>
public <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream<
/A> <
B>newStream<
/B>
(long
start,
<
DD>Return a new InputStream representing a subset of the
data
from this InputStream, starting at <
code>start<
/code>
(inclusive
)
non-negative. If <
code>end<
/code> is -
1, the new stream ends
at the same place as this stream. The returned InputStream
will also implement the SharedInputStream interface.
<
DT><
B>Specified by:<
/B><
DD><
CODE><
A HREF="../../../javax/mail/internet/SharedInputStream.html#newStream(long, long)">newStream<
/A><
/CODE> in interface <
CODE><
A HREF="../../../javax/mail/internet/SharedInputStream.html" title="interface in javax.mail.internet">SharedInputStream<
/A><
/CODE><
/DL>
<
DT><
B>Returns:<
/B><
DD>the new stream<
/DL>
<
A NAME="finalize()"><!-- --><
/A><
H3>
protected void <
B>finalize<
/B>
()
throws <
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable<
/A><
/PRE>
<
DD>Force this stream to close.
<
DT><
B>Overrides:<
/B><
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize<
/A><
/CODE> in
class <
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object<
/A><
/CODE><
/DL>
<
DD><
CODE><
A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable<
/A><
/CODE><
/DL>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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="">
<
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/SharedFileInputStream.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>
<
TD ALIGN="right" VALIGN="top" ROWSPAN=3><
EM>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../javax/mail/util/SharedByteArrayInputStream.html" title="class in javax.mail.util"><
B>PREV CLASS<
/B><
/A>
<
TD BGCOLOR="white" CLASS="NavBarCell2"><
FONT SIZE="-2">
<
A HREF="../../../index.html?javax/mail/util/SharedFileInputStream.html" target="_top"><
B>FRAMES<
/B><
/A>
<
A HREF="SharedFileInputStream.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>');
}
//-->
<
A HREF="../../../allclasses-noframe.html"><
B>All Classes<
/B><
/A>
<
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>
<
A NAME="skip-navbar_bottom"><
/A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
Copyright &#
169;
2009 <
a href="http://www.sun.com">Sun Microsystems, Inc.<
/a>. All Rights Reserved.