uTools-Manuals/docs/java/javax/swing/ProgressMonitorInputStream.html

470 lines
19 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<div class="header">
<div class="subTitle">
javax.swing
</div>
<h2 class="title" title="Class ProgressMonitorInputStream">Class ProgressMonitorInputStream</h2>
</div><div class="contentContainer">
<ul class="inheritance">
<li><a href="../../java/lang/Object.html" title="class in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../java/io/InputStream.html" title="class in java.io">java.io.InputStream</a></li>
<li>
<ul class="inheritance">
<li><a href="../../java/io/FilterInputStream.html" title="class in java.io">java.io.FilterInputStream</a></li>
<li>
<ul class="inheritance">
<li>javax.swing.ProgressMonitorInputStream</li>
</ul> </li>
</ul> </li>
</ul> </li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>
All Implemented Interfaces:
</dt>
<dd>
<span><a href="../../java/io/Closeable.html" title="java.io中的接口">Closeable</a> <a href="../../java/lang/AutoCloseable.html" title="java.lang中的接口">AutoCloseable</a></span>
</dd>
</dl>
<hr/> <br/> <pre>public class <span class="typeNameLabel">ProgressMonitorInputStream</span>
extends <a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></pre>
<div class="block">
<span>监视从一些InputStream读取进度。</span>
<span>这个ProgressMonitor通常大致以这种形式被调用</span>
<pre> <span>InputStream in = new BufferedInputStream(
new ProgressMonitorInputStream(
parentComponent,
"Reading " + fileName,
new FileInputStream(fileName)));</span> </pre>
<p> <span>这将创建一个进度监视器来监视读取输入流的进度。</span> <span>如果需要一段时间将弹出一个ProgressDialog来通知用户。</span> <span>如果用户点击“取消”按钮则会在下次读取时抛出InterruptedIOException异常。</span> <span>所有正确的清理都是在流关闭时完成的。</span> </p>
<p> <span>有关进一步的文档和示例,请参阅<em>Java Tutorial</em><em></em> <a href="http://docs.oracle.com/javase/tutorial/uiswing/components/progress.html">How to Monitor Progress</a> <em></em></span> </p>
</div>
<dl>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<span><a href="../../javax/swing/ProgressMonitor.html" title="javax.swing中的类"><code>ProgressMonitor</code></a> <a href="../../javax/swing/JOptionPane.html" title="javax.swing中的类"><code>JOptionPane</code></a></span>
</dd>
</dl> </li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- --> </a> <h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.io.FilterInputStream">
<!-- --> </a> <h3>Fields inherited from class java.io.<a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></h3> <code><a href="../../java/io/FilterInputStream.html#in">in</a></code></li>
</ul> </li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- --> </a> <h3>构造方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption>
<span>构造方法</span>
<span class="tabEnd"> </span>
</caption>
<tbody>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#ProgressMonitorInputStream-java.awt.Component-java.lang.Object-java.io.InputStream-">ProgressMonitorInputStream</a></span>(<a href="../../java/awt/Component.html" title="class in java.awt">Component</a> parentComponent, <a href="../../java/lang/Object.html" title="class in java.lang">Object</a> message, <a href="../../java/io/InputStream.html" title="class in java.io">InputStream</a> in)</code>
<div class="block">
构造一个对象来监视输入流的进度。
</div> </td>
</tr>
</tbody>
</table> </li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- --> </a> <h3>方法摘要</h3>
<table border="0" cellpadding="3" cellspacing="0" class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption>
<span class="activeTableTab" id="t0"><span>所有方法</span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t2"><span><a href="javascript:show(2);">接口方法</a></span><span class="tabEnd"> </span></span>
<span class="tableTab" id="t4"><span><a href="javascript:show(8);">具体的方法</a></span><span class="tabEnd"> </span></span>
</caption>
<tbody>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor" id="i0">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#close--">close</a></span>()</code>
<div class="block">
覆盖
<code>FilterInputStream.close</code>以关闭进度监视器以及流。
</div> </td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code><a href="../../javax/swing/ProgressMonitor.html" title="class in javax.swing">ProgressMonitor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#getProgressMonitor--">getProgressMonitor</a></span>()</code>
<div class="block">
获取此流所使用的ProgressMonitor对象。
</div> </td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#read--">read</a></span>()</code>
<div class="block">
覆盖
<code>FilterInputStream.read</code> ,以便在读取后更新进度监视器。
</div> </td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#read-byte:A-">read</a></span>(byte[] b)</code>
<div class="block">
覆盖
<code>FilterInputStream.read</code> ,以便在读取后更新进度监视器。
</div> </td>
</tr>
<tr class="altColor" id="i4">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#read-byte:A-int-int-">read</a></span>(byte[] b, int off, int len)</code>
<div class="block">
覆盖
<code>FilterInputStream.read</code> ,以便在读取后更新进度监视器。
</div> </td>
</tr>
<tr class="rowColor" id="i5">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#reset--">reset</a></span>()</code>
<div class="block">
覆盖
<code>FilterInputStream.reset</code>以重置进度监视器以及流。
</div> </td>
</tr>
<tr class="altColor" id="i6">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../javax/swing/ProgressMonitorInputStream.html#skip-long-">skip</a></span>(long n)</code>
<div class="block">
覆盖
<code>FilterInputStream.skip</code>以在跳过后更新进度监视器。
</div> </td>
</tr>
</tbody>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.FilterInputStream">
<!-- --> </a> <h3>Methods inherited from class java.io.<a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></h3> <code><a href="../../java/io/FilterInputStream.html#available--">available</a>, <a href="../../java/io/FilterInputStream.html#mark-int-">mark</a>, <a href="../../java/io/FilterInputStream.html#markSupported--">markSupported</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- --> </a> <h3>Methods inherited from class java.lang.<a href="../../java/lang/Object.html" title="class in java.lang">Object</a></h3> <code><a href="../../java/lang/Object.html#clone--">clone</a>, <a href="../../java/lang/Object.html#equals-java.lang.Object-">equals</a>, <a href="../../java/lang/Object.html#finalize--">finalize</a>, <a href="../../java/lang/Object.html#getClass--">getClass</a>, <a href="../../java/lang/Object.html#hashCode--">hashCode</a>, <a href="../../java/lang/Object.html#notify--">notify</a>, <a href="../../java/lang/Object.html#notifyAll--">notifyAll</a>, <a href="../../java/lang/Object.html#toString--">toString</a>, <a href="../../java/lang/Object.html#wait--">wait</a>, <a href="../../java/lang/Object.html#wait-long-">wait</a>, <a href="../../java/lang/Object.html#wait-long-int-">wait</a></code></li>
</ul> </li>
</ul> </li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- --> </a> <h3>构造方法详细信息</h3> <a name="ProgressMonitorInputStream-java.awt.Component-java.lang.Object-java.io.InputStream-">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>ProgressMonitorInputStream</h4> <pre>public ProgressMonitorInputStream(<a href="../../java/awt/Component.html" title="class in java.awt">Component</a> parentComponent,
<a href="../../java/lang/Object.html" title="class in java.lang">Object</a> message,
<a href="../../java/io/InputStream.html" title="class in java.io">InputStream</a> in)</pre>
<div class="block">
构造一个对象来监视输入流的进度。
</div>
<dl>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>message</code> - 描述性文本放在对话框中,如果弹出。
</dd>
<dd>
<code>parentComponent</code> - 触发被监视操作的组件。
</dd>
<dd>
<code>in</code> - 要监视的输入流。
</dd>
</dl> </li>
</ul> </li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- --> </a> <h3>方法详细信息</h3> <a name="getProgressMonitor--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>getProgressMonitor</h4> <pre>public <a href="../../javax/swing/ProgressMonitor.html" title="class in javax.swing">ProgressMonitor</a> getProgressMonitor()</pre>
<div class="block">
<span>获取此流所使用的ProgressMonitor对象。</span>
<span>通常这是不需要的,除非你想通过阅读文件来做某些改变描述性文本的东西。</span>
</div>
<dl>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
该对象使用的ProgressMonitor对象
</dd>
</dl> </li>
</ul> <a name="read--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>read</h4> <pre>public int read()
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
覆盖
<code>FilterInputStream.read</code>以便在读取后更新进度监视器。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../java/io/FilterInputStream.html#read--">read</a></code>
<code><a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></code>
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
数据的下一个字节,如果达到流的末尾,
<code>-1</code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果发生I / O错误。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../java/io/FilterInputStream.html#in"><code>FilterInputStream.in</code></a>
</dd>
</dl> </li>
</ul> <a name="read-byte:A-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>read</h4> <pre>public int read(byte[] b)
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
覆盖
<code>FilterInputStream.read</code>以便在读取后更新进度监视器。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../java/io/FilterInputStream.html#read-byte:A-">read</a></code>
<code><a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></code>
</dd>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>b</code> - 读取数据的缓冲区。
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
读取到缓冲区的总字节数,如果没有更多的数据,因为已经到达流的末尾,
<code>-1</code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果发生I / O错误。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../java/io/FilterInputStream.html#read-byte:A-int-int-"><code>FilterInputStream.read(byte[], int, int)</code></a>
</dd>
</dl> </li>
</ul> <a name="read-byte:A-int-int-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>read</h4> <pre>public int read(byte[] b,
int off,
int len)
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
覆盖
<code>FilterInputStream.read</code> ,以便在读取后更新进度监视器。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../java/io/FilterInputStream.html#read-byte:A-int-int-">read</a></code>
<code><a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></code>
</dd>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>b</code> - 读取数据的缓冲区。
</dd>
<dd>
<code>off</code> - 目标数组
<code>b</code>的起始偏移量
</dd>
<dd>
<code>len</code> - 读取的最大字节数。
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
读取到缓冲区的总字节数,如果没有更多的数据,因为已经到达流的末尾,
<code>-1</code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果发生I / O错误。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../java/io/FilterInputStream.html#in"><code>FilterInputStream.in</code></a>
</dd>
</dl> </li>
</ul> <a name="skip-long-">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>skip</h4> <pre>public long skip(long n)
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
覆盖
<code>FilterInputStream.skip</code>以在跳过后更新进度监视器。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../java/io/FilterInputStream.html#skip-long-">skip</a></code>
<code><a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></code>
</dd>
<dt>
<span class="paramLabel">参数</span>
</dt>
<dd>
<code>n</code> - 要跳过的字节数。
</dd>
<dt>
<span class="returnLabel">结果</span>
</dt>
<dd>
实际跳过的字节数。
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果流不支持查询或者发生其他I / O错误。
</dd>
</dl> </li>
</ul> <a name="close--">
<!-- --> </a>
<ul class="blockList">
<li class="blockList"> <h4>close</h4> <pre>public void close()
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
覆盖
<code>FilterInputStream.close</code>以关闭进度监视器以及流。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../java/io/Closeable.html#close--">close</a></code>在接口
<code><a href="../../java/io/Closeable.html" title="interface in java.io">Closeable</a></code>
</dd>
<dt>
<span class="overrideSpecifyLabel">Specified by:</span>
</dt>
<dd>
<code><a href="../../java/lang/AutoCloseable.html#close--">close</a></code>在接口
<code><a href="../../java/lang/AutoCloseable.html" title="interface in java.lang">AutoCloseable</a></code>
</dd>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../java/io/FilterInputStream.html#close--">close</a></code>
<code><a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果发生I / O错误。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../java/io/FilterInputStream.html#in"><code>FilterInputStream.in</code></a>
</dd>
</dl> </li>
</ul> <a name="reset--">
<!-- --> </a>
<ul class="blockListLast">
<li class="blockList"> <h4>reset</h4> <pre>public void reset()
throws <a href="../../java/io/IOException.html" title="class in java.io">IOException</a></pre>
<div class="block">
覆盖
<code>FilterInputStream.reset</code>以重置进度监视器以及流。
</div>
<dl>
<dt>
<span class="overrideSpecifyLabel">重写:</span>
</dt>
<dd>
<code><a href="../../java/io/FilterInputStream.html#reset--">reset</a></code>
<code><a href="../../java/io/FilterInputStream.html" title="class in java.io">FilterInputStream</a></code>
</dd>
<dt>
<span class="throwsLabel">异常</span>
</dt>
<dd>
<code><a href="../../java/io/IOException.html" title="class in java.io">IOException</a></code> - 如果流未标记或标记已被无效。
</dd>
<dt>
<span class="seeLabel">另请参见:</span>
</dt>
<dd>
<a href="../../java/io/FilterInputStream.html#in"><code>FilterInputStream.in</code></a>
<a href="../../java/io/FilterInputStream.html#mark-int-"><code>FilterInputStream.mark(int)</code></a>
</dd>
</dl> </li>
</ul> </li>
</ul> </li>
</ul>
</div>
</div>