| <!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 (version 1.7.0_25) on Mon Jul 01 12:10:56 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>InventoryPrinter (Apache Felix Inventory 1.0.0 API)</title> |
| <meta name="date" content="2013-07-01"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="InventoryPrinter (Apache Felix Inventory 1.0.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../org/apache/felix/inventory/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/InventoryPrinter.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/felix/inventory/Format.html" title="class in org.apache.felix.inventory"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/inventory/ZipAttachmentProvider.html" title="interface in org.apache.felix.inventory"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/inventory/InventoryPrinter.html" target="_top">Frames</a></li> |
| <li><a href="InventoryPrinter.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>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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.felix.inventory</div> |
| <h2 title="Interface InventoryPrinter" class="title">Interface InventoryPrinter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">InventoryPrinter</span></pre> |
| <div class="block">The <code>InventoryPrinter</code> is a service interface to be |
| implemented by providers which want to hook into the display of the |
| current configuration and state of the OSGi framework and application. |
| <p> |
| The following service registration properties further declare the |
| <code>InventoryPrinter</code> service: |
| <ul> |
| <li><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#FORMAT"><code>FORMAT</code></a> - the supported formats</li> |
| <li><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#TITLE"><code>TITLE</code></a> - the printer title</li> |
| <li><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#NAME"><code>NAME</code></a> - the printer name</li> |
| <li><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#WEBCONSOLE"><code>WEBCONSOLE</code></a> - whether to confine the printer to the Web Console</li> |
| </ul></div> |
| </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> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#FORMAT">FORMAT</a></strong></code> |
| <div class="block">The property defining one or more supported formats.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#NAME">NAME</a></strong></code> |
| <div class="block">The unique name (or label) of the printer.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#SERVICE">SERVICE</a></strong></code> |
| <div class="block">The service name under which services of this class must be registered |
| to be picked for inclusion in the configuration report.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#TITLE">TITLE</a></strong></code> |
| <div class="block">The title displayed by tools when this printer is used.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#WEBCONSOLE">WEBCONSOLE</a></strong></code> |
| <div class="block">The inventory printer feature has first class integration with the |
| Apache Felix Web Console.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#print(java.io.PrintWriter, org.apache.felix.inventory.Format, boolean)">print</a></strong>(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> printWriter, |
| <a href="../../../../org/apache/felix/inventory/Format.html" title="class in org.apache.felix.inventory">Format</a> format, |
| boolean isZip)</code> |
| <div class="block">Prints the configuration report to the given <code>printWriter</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field_detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="SERVICE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> SERVICE</pre> |
| <div class="block">The service name under which services of this class must be registered |
| to be picked for inclusion in the configuration report.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.inventory.InventoryPrinter.SERVICE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="FORMAT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>FORMAT</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> FORMAT</pre> |
| <div class="block">The property defining one or more supported formats. The value of this |
| property is either a string, a string array or a Collection<String> |
| containing valid names of the constants defined in the <a href="../../../../org/apache/felix/inventory/Format.html" title="class in org.apache.felix.inventory"><code>Format</code></a> |
| class. |
| <p> |
| Any unknown formats are ignored. If this property is not declared or does |
| not declare any known formats, the <a href="../../../../org/apache/felix/inventory/Format.html#TEXT"><code>Format.TEXT</code></a> format is assumed |
| as the printer's supported format.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.inventory.InventoryPrinter.FORMAT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NAME</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> NAME</pre> |
| <div class="block">The unique name (or label) of the printer. |
| <p> |
| If this property is missing or an empty string, the name is constructed |
| from the string <code>InventoryPrinter</code> and the service's |
| <code>service.id</code> property.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.inventory.InventoryPrinter.NAME">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="TITLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>TITLE</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TITLE</pre> |
| <div class="block">The title displayed by tools when this printer is used. It should be |
| descriptive but short. |
| <p> |
| If this property is missing or an empty string, the <a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#NAME"><code>NAME</code></a> value |
| is used as the title.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.inventory.InventoryPrinter.TITLE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="WEBCONSOLE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>WEBCONSOLE</h4> |
| <pre>static final <a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> WEBCONSOLE</pre> |
| <div class="block">The inventory printer feature has first class integration with the |
| Apache Felix Web Console. This service registration property can be used |
| to hide an inventory printer service from the Web Console. The service |
| will still be called to generate the single file or ZIP file output of |
| inventory printers. |
| <p> |
| By default, a printer is displayed in the web console, unless this |
| property is set to <code>false</code>. The property value can either be a |
| boolean or a string.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.inventory.InventoryPrinter.WEBCONSOLE">Constant Field Values</a></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="print(java.io.PrintWriter, org.apache.felix.inventory.Format, boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>print</h4> |
| <pre>void print(<a href="http://docs.oracle.com/javase/1.4.2/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> printWriter, |
| <a href="../../../../org/apache/felix/inventory/Format.html" title="class in org.apache.felix.inventory">Format</a> format, |
| boolean isZip)</pre> |
| <div class="block">Prints the configuration report to the given <code>printWriter</code>. |
| Implementations are free to print whatever information they deem useful. |
| <p> |
| If a printer is invoked with a format it doesn't support ( <a href="../../../../org/apache/felix/inventory/InventoryPrinter.html#FORMAT"><code>FORMAT</code></a>) |
| the printer should just do/print nothing and directly return. |
| <p> |
| A printer might be used in one of two different situations: either for |
| directly displaying the information to a user (like in the web console) |
| or the output is included in a ZIP. The printer might want to return |
| different output depending on the usage situation.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>printWriter</code> - where to write the data. Implementations may flush the |
| writer but must not close it.</dd><dd><code>format</code> - The render format.</dd><dd><code>isZip</code> - whether this is included in a ZIP file or used directly</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../org/apache/felix/inventory/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/InventoryPrinter.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/felix/inventory/Format.html" title="class in org.apache.felix.inventory"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/inventory/ZipAttachmentProvider.html" title="interface in org.apache.felix.inventory"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/inventory/InventoryPrinter.html" target="_top">Frames</a></li> |
| <li><a href="InventoryPrinter.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>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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 © 2006–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
