| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>IOutputManager (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.dtfjview, package: com.ibm.jvm.dtfjview.spi, interface: IOutputManager"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.jvm.dtfjview.spi.IOutputManager interface"> |
| <meta name="keywords" content="setBuffering()"> |
| <meta name="keywords" content="clearBuffer()"> |
| <meta name="keywords" content="getBuffer()"> |
| <meta name="keywords" content="addChannel()"> |
| <meta name="keywords" content="removeChannel()"> |
| <meta name="keywords" content="removeAllChannels()"> |
| <meta name="keywords" content="getPrintStream()"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div> |
| <ul id="navbar.top.firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../index.html">Overview</a></li> |
| <li><a href="../../../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/IOutputManager.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-files/index-1.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../../../module-summary.html">openj9.dtfjview</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.jvm.dtfjview.spi</a></div> |
| <h1 title="Interface IOutputManager" class="title">Interface IOutputManager</h1> |
| </div> |
| <section class="description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../Output.html" title="class in com.ibm.jvm.dtfjview">Output</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">IOutputManager</span><span class="extends-implements"> |
| extends <a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a></span></div> |
| <div class="block">The output manager is responsible for managing a collection of registered |
| output channels. It provides methods to register and remove channels as |
| well as control buffering. When text is written to the manager then it |
| is sent to all registered output channels. |
| |
| This interface is an extension of IOutputChannel so as to enforce consistency |
| between the declarations for printing text to an output channel. The manager |
| is in effect acting as a single proxy channel for all of it's individually |
| registered channels.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#addChannel(com.ibm.jvm.dtfjview.spi.IOutputChannel)">addChannel</a></span>​(<a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a> channel)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Adds a channel to the list of registered channels.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#clearBuffer()">clearBuffer</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Clears the current buffer contents.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getBuffer()">getBuffer</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Gets the current buffer contents.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#getPrintStream()">getPrintStream</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Creates a print stream for this output object</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#removeAllChannels()">removeAllChannels</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Remove all registered channels</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#removeChannel(com.ibm.jvm.dtfjview.spi.IOutputChannel)">removeChannel</a></span>​(<a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a> channel)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Removes a specific channel for a particular type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#removeChannel(java.lang.Class)">removeChannel</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?> type)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Removes all registered channels for a particular type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setBuffering(boolean)">setBuffering</a></span>​(boolean enabled)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"> |
| <div class="block">Enabling buffering will cause the output from commands to be written |
| to an internal buffer rather than immediately to the underlying output |
| channels.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.com.ibm.jvm.dtfjview.spi.IOutputChannel">Methods declared in interface com.ibm.jvm.dtfjview.spi.<a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a></h3> |
| <code><a href="IOutputChannel.html#close()">close</a>, <a href="IOutputChannel.html#flush()">flush</a>, <a href="IOutputChannel.html#print(java.lang.String)">print</a>, <a href="IOutputChannel.html#println(java.lang.String)">println</a>, <a href="IOutputChannel.html#printPrompt(java.lang.String)">printPrompt</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setBuffering(boolean)"> |
| <h3>setBuffering</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">setBuffering</span>​<span class="parameters">(boolean enabled)</span></div> |
| <div class="block">Enabling buffering will cause the output from commands to be written |
| to an internal buffer rather than immediately to the underlying output |
| channels. This is typically used by clients to inspect or intercept the results from |
| a command before carrying out further processing. |
| |
| By default buffering is not enabled.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>enabled</code> - true turns on buffering</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="clearBuffer()"> |
| <h3>clearBuffer</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">clearBuffer</span>()</div> |
| <div class="block">Clears the current buffer contents.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBuffer()"> |
| <h3>getBuffer</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">getBuffer</span>()</div> |
| <div class="block">Gets the current buffer contents.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>buffer contents</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addChannel(com.ibm.jvm.dtfjview.spi.IOutputChannel)"> |
| <h3>addChannel</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">addChannel</span>​<span class="parameters">(<a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a> channel)</span></div> |
| <div class="block">Adds a channel to the list of registered channels.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>channel</code> - channel to add.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeChannel(java.lang.Class)"> |
| <h3>removeChannel</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeChannel</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link" target="_blank">Class</a><?> type)</span></div> |
| <div class="block">Removes all registered channels for a particular type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeChannel(com.ibm.jvm.dtfjview.spi.IOutputChannel)"> |
| <h3>removeChannel</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeChannel</span>​<span class="parameters">(<a href="IOutputChannel.html" title="interface in com.ibm.jvm.dtfjview.spi">IOutputChannel</a> channel)</span></div> |
| <div class="block">Removes a specific channel for a particular type. For this to be successful the underlying |
| implementation must override hashcode and equals.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>type</code> - </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="removeAllChannels()"> |
| <h3>removeAllChannels</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">removeAllChannels</span>()</div> |
| <div class="block">Remove all registered channels</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPrintStream()"> |
| <h3>getPrintStream</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/io/PrintStream.html" title="class or interface in java.io" class="external-link" target="_blank">PrintStream</a></span> <span class="element-name">getPrintStream</span>()</div> |
| <div class="block">Creates a print stream for this output object</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse-openj9/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
