123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="de">
- <head>
- <!-- Generated by javadoc -->
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
- <title>ObservableInputStream (Apache Commons IO 2.6 API)</title>
- <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="ObservableInputStream (Apache Commons IO 2.6 API)";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/ObservableInputStream.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../../index-all.html">Index</a></li>
- <li><a href="../../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../../org/apache/commons/io/input/NullReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../index.html?org/apache/commons/io/input/ObservableInputStream.html" target="_top">Frames</a></li>
- <li><a href="ObservableInputStream.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li><a href="#nested.class.summary">Nested</a> | </li>
- <li><a href="#fields.inherited.from.class.java.io.FilterInputStream">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">org.apache.commons.io.input</div>
- <h2 title="Class ObservableInputStream" class="title">Class ObservableInputStream</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
- <li>
- <ul class="inheritance">
- <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">java.io.InputStream</a></li>
- <li>
- <ul class="inheritance">
- <li><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">java.io.FilterInputStream</a></li>
- <li>
- <ul class="inheritance">
- <li><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">org.apache.commons.io.input.ProxyInputStream</a></li>
- <li>
- <ul class="inheritance">
- <li>org.apache.commons.io.input.ObservableInputStream</li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <dl>
- <dt>All Implemented Interfaces:</dt>
- <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></dd>
- </dl>
- <dl>
- <dt>Direct Known Subclasses:</dt>
- <dd><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" title="class in org.apache.commons.io.input">MessageDigestCalculatingInputStream</a></dd>
- </dl>
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">ObservableInputStream</span>
- extends <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></pre>
- <div class="block">The <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a> allows, that an InputStream may be consumed
- by other receivers, apart from the thread, which is reading it.
- The other consumers are implemented as instances of <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream.Observer</code></a>. A
- typical application may be the generation of a <a href="http://docs.oracle.com/javase/7/docs/api/java/security/MessageDigest.html?is-external=true" title="class or interface in java.security"><code>MessageDigest</code></a> on the
- fly.
- <code>Note</code>: The <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html" title="class in org.apache.commons.io.input"><code>ObservableInputStream</code></a> is <em>not</em> thread safe,
- as instances of InputStream usually aren't.
- If you must access the stream from multiple threads, then synchronization, locking,
- or a similar means must be used.</div>
- <dl>
- <dt><span class="seeLabel">See Also:</span></dt>
- <dd><a href="../../../../../org/apache/commons/io/input/MessageDigestCalculatingInputStream.html" title="class in org.apache.commons.io.input"><code>MessageDigestCalculatingInputStream</code></a></dd>
- </dl>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== NESTED CLASS SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="nested.class.summary">
- <!-- -->
- </a>
- <h3>Nested Class Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
- <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Class and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colFirst"><code>static class </code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a></span></code> </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- =========== 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="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true" title="class or interface in java.io">FilterInputStream</a></h3>
- <code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/FilterInputStream.html?is-external=true#in" title="class or interface in java.io">in</a></code></li>
- </ul>
- </li>
- </ul>
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#ObservableInputStream-java.io.InputStream-">ObservableInputStream</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> pProxy)</code>
- <div class="block">Creates a new ObservableInputStream for the given InputStream.</div>
- </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#add-org.apache.commons.io.input.ObservableInputStream.Observer-">add</a></span>(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a> pObserver)</code>
- <div class="block">Adds an Observer.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#close--">close</a></span>()</code>
- <div class="block">Invokes the delegate's <code>close()</code> method.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#consume--">consume</a></span>()</code>
- <div class="block">Reads all data from the underlying <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, while notifying the
- observers.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#getObservers--">getObservers</a></span>()</code>
- <div class="block">Gets all currently registered observers.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code>protected void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteClosed--">noteClosed</a></span>()</code>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>protected void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteDataByte-int-">noteDataByte</a></span>(int pDataByte)</code>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-int-"><code>ObservableInputStream.Observer.data(int)</code></a>
- with the given arguments.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>protected void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteDataBytes-byte:A-int-int-">noteDataBytes</a></span>(byte[] pBuffer,
- int pOffset,
- int pLength)</code>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-byte:A-int-int-"><code>ObservableInputStream.Observer.data(byte[],int,int)</code></a>
- with the given arguments.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>protected void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteError-java.io.IOException-">noteError</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a> pException)</code>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#error-java.io.IOException-"><code>ObservableInputStream.Observer.error(IOException)</code></a>
- with the given argument.</div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code>protected void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#noteFinished--">noteFinished</a></span>()</code>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read--">read</a></span>()</code>
- <div class="block">Invokes the delegate's <code>read()</code> method.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read-byte:A-">read</a></span>(byte[] pBuffer)</code>
- <div class="block">Invokes the delegate's <code>read(byte[])</code> method.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#read-byte:A-int-int-">read</a></span>(byte[] pBuffer,
- int pOffset,
- int pLength)</code>
- <div class="block">Invokes the delegate's <code>read(byte[], int, int)</code> method.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#remove-org.apache.commons.io.input.ObservableInputStream.Observer-">remove</a></span>(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a> pObserver)</code>
- <div class="block">Removes an Observer.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code>void</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.html#removeAllObservers--">removeAllObservers</a></span>()</code>
- <div class="block">Removes all Observers.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.org.apache.commons.io.input.ProxyInputStream">
- <!-- -->
- </a>
- <h3>Methods inherited from class org.apache.commons.io.input.<a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></h3>
- <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#afterRead-int-">afterRead</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#available--">available</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#beforeRead-int-">beforeRead</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#handleIOException-java.io.IOException-">handleIOException</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#mark-int-">mark</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#markSupported--">markSupported</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#reset--">reset</a>, <a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#skip-long-">skip</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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
- <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/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://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">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>Constructor Detail</h3>
- <a name="ObservableInputStream-java.io.InputStream-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>ObservableInputStream</h4>
- <pre>public ObservableInputStream(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> pProxy)</pre>
- <div class="block">Creates a new ObservableInputStream for the given InputStream.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pProxy</code> - the input stream to proxy</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="add-org.apache.commons.io.input.ObservableInputStream.Observer-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>add</h4>
- <pre>public void add(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a> pObserver)</pre>
- <div class="block">Adds an Observer.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pObserver</code> - the observer to add</dd>
- </dl>
- </li>
- </ul>
- <a name="remove-org.apache.commons.io.input.ObservableInputStream.Observer-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>remove</h4>
- <pre>public void remove(<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a> pObserver)</pre>
- <div class="block">Removes an Observer.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pObserver</code> - the observer to remove</dd>
- </dl>
- </li>
- </ul>
- <a name="removeAllObservers--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>removeAllObservers</h4>
- <pre>public void removeAllObservers()</pre>
- <div class="block">Removes all Observers.</div>
- </li>
- </ul>
- <a name="read--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>read</h4>
- <pre>public int read()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read--">ProxyInputStream</a></code></span></div>
- <div class="block">Invokes the delegate's <code>read()</code> method.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read--">read</a></code> in class <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the byte read or -1 if the end of stream</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/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</dd>
- </dl>
- </li>
- </ul>
- <a name="read-byte:A-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>read</h4>
- <pre>public int read(byte[] pBuffer)
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-">ProxyInputStream</a></code></span></div>
- <div class="block">Invokes the delegate's <code>read(byte[])</code> method.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-">read</a></code> in class <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pBuffer</code> - the buffer to read the bytes into</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the number of bytes read or EOF if the end of stream</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/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</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[] pBuffer,
- int pOffset,
- int pLength)
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-int-int-">ProxyInputStream</a></code></span></div>
- <div class="block">Invokes the delegate's <code>read(byte[], int, int)</code> method.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#read-byte:A-int-int-">read</a></code> in class <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pBuffer</code> - the buffer to read the bytes into</dd>
- <dd><code>pOffset</code> - The start offset</dd>
- <dd><code>pLength</code> - The number of bytes to read</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>the number of bytes read or -1 if the end of stream</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/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</dd>
- </dl>
- </li>
- </ul>
- <a name="noteDataBytes-byte:A-int-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>noteDataBytes</h4>
- <pre>protected void noteDataBytes(byte[] pBuffer,
- int pOffset,
- int pLength)
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-byte:A-int-int-"><code>ObservableInputStream.Observer.data(byte[],int,int)</code></a>
- with the given arguments.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pBuffer</code> - Passed to the observers.</dd>
- <dd><code>pOffset</code> - Passed to the observers.</dd>
- <dd><code>pLength</code> - Passed to the observers.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Some observer has thrown an exception, which is being
- passed down.</dd>
- </dl>
- </li>
- </ul>
- <a name="noteFinished--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>noteFinished</h4>
- <pre>protected void noteFinished()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
- <dl>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Some observer has thrown an exception, which is being
- passed down.</dd>
- </dl>
- </li>
- </ul>
- <a name="noteDataByte-int-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>noteDataByte</h4>
- <pre>protected void noteDataByte(int pDataByte)
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#data-int-"><code>ObservableInputStream.Observer.data(int)</code></a>
- with the given arguments.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pDataByte</code> - Passed to the observers.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Some observer has thrown an exception, which is being
- passed down.</dd>
- </dl>
- </li>
- </ul>
- <a name="noteError-java.io.IOException-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>noteError</h4>
- <pre>protected void noteError(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a> pException)
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#error-java.io.IOException-"><code>ObservableInputStream.Observer.error(IOException)</code></a>
- with the given argument.</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>pException</code> - Passed to the observers.</dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Some observer has thrown an exception, which is being
- passed down. This may be the same exception, which has been passed as an
- argument.</dd>
- </dl>
- </li>
- </ul>
- <a name="noteClosed--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>noteClosed</h4>
- <pre>protected void noteClosed()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block">Notifies the observers by invoking <a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html#finished--"><code>ObservableInputStream.Observer.finished()</code></a>.</div>
- <dl>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Some observer has thrown an exception, which is being
- passed down.</dd>
- </dl>
- </li>
- </ul>
- <a name="getObservers--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getObservers</h4>
- <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input">ObservableInputStream.Observer</a>> getObservers()</pre>
- <div class="block">Gets all currently registered observers.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>a list of the currently registered observers</dd>
- </dl>
- </li>
- </ul>
- <a name="close--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>close</h4>
- <pre>public void close()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#close--">ProxyInputStream</a></code></span></div>
- <div class="block">Invokes the delegate's <code>close()</code> method.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/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://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io">Closeable</a></code></dd>
- <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true#close--" title="class or interface in java.lang">close</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang">AutoCloseable</a></code></dd>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html#close--">close</a></code> in class <code><a href="../../../../../org/apache/commons/io/input/ProxyInputStream.html" title="class in org.apache.commons.io.input">ProxyInputStream</a></code></dd>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/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</dd>
- </dl>
- </li>
- </ul>
- <a name="consume--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>consume</h4>
- <pre>public void consume()
- throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
- <div class="block">Reads all data from the underlying <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, while notifying the
- observers.</div>
- <dl>
- <dt><span class="throwsLabel">Throws:</span></dt>
- <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - The underlying <a href="http://docs.oracle.com/javase/7/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io"><code>InputStream</code></a>, or either of the
- observers has thrown an exception.</dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="class-use/ObservableInputStream.html">Use</a></li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../../../index-all.html">Index</a></li>
- <li><a href="../../../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../../../org/apache/commons/io/input/NullReader.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../../../org/apache/commons/io/input/ObservableInputStream.Observer.html" title="class in org.apache.commons.io.input"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../../../index.html?org/apache/commons/io/input/ObservableInputStream.html" target="_top">Frames</a></li>
- <li><a href="ObservableInputStream.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li><a href="#nested.class.summary">Nested</a> | </li>
- <li><a href="#fields.inherited.from.class.java.io.FilterInputStream">Field</a> | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <p class="legalCopy"><small>Copyright © 2002–2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
- </body>
- </html>
|