felix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cziege...@apache.org
Subject svn commit: r1424593 - in /felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status: StatusPrinterHandler.java StatusPrinterManager.java impl/webconsole/ResourceBundleManager.java
Date Thu, 20 Dec 2012 17:14:41 GMT
Author: cziegeler
Date: Thu Dec 20 17:14:41 2012
New Revision: 1424593

URL: http://svn.apache.org/viewvc?rev=1424593&view=rev
Log:
Add javadocs

Modified:
    felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterHandler.java
    felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterManager.java
    felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/impl/webconsole/ResourceBundleManager.java

Modified: felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterHandler.java
URL: http://svn.apache.org/viewvc/felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterHandler.java?rev=1424593&r1=1424592&r2=1424593&view=diff
==============================================================================
--- felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterHandler.java
(original)
+++ felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterHandler.java
Thu Dec 20 17:14:41 2012
@@ -21,19 +21,30 @@ package org.apache.felix.status;
 import java.io.PrintWriter;
 import java.net.URL;
 
+/**
+ * The status printer handler can be used by clients to access
+ * a status printer.
+ */
 public interface StatusPrinterHandler {
 
-    String getTitle();
-
+    /** The unique name of the printer. */
     String getName();
 
+    /** The human readable title for the status printer. */
+    String getTitle();
+
+    /** The optional category for this printer. */
     String getCategory();
 
+    /** All supported modes. */
     PrinterMode[] getModes();
 
+    /** Whether the printer supports this mode. */
     boolean supports( final PrinterMode mode );
 
+    /** Print the configuration in the mode. */
     void printConfiguration( PrinterMode mode, PrintWriter printWriter );
 
+    /** Get the attachments for the zip. */
     URL[] getAttachmentsForZip();
 }

Modified: felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterManager.java
URL: http://svn.apache.org/viewvc/felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterManager.java?rev=1424593&r1=1424592&r2=1424593&view=diff
==============================================================================
--- felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterManager.java
(original)
+++ felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/StatusPrinterManager.java
Thu Dec 20 17:14:41 2012
@@ -18,11 +18,29 @@
  */
 package org.apache.felix.status;
 
+/**
+ * The manager allows to access status printers.
+ * Instead of directly returning a status printer, a status
+ * printer handler is returned which provides access to the
+ * meta information of the printer and other utility methods.
+ */
 public interface StatusPrinterManager {
 
+    /**
+     * Get all status printer handlers.
+     * @return A list of handlers - might be empty.
+     */
     StatusPrinterHandler[] getAllHandlers();
 
+    /**
+     * Get all handlers supporting the mode.
+     * @return A list of handlers - might be empty.
+     */
     StatusPrinterHandler[] getHandlers( final PrinterMode mode);
 
+    /**
+     * Return a handler for the unique name.
+     * @return The corresponding handler or <code>null</code>.
+     */
     StatusPrinterHandler getHandler( final String name );
 }

Modified: felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/impl/webconsole/ResourceBundleManager.java
URL: http://svn.apache.org/viewvc/felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/impl/webconsole/ResourceBundleManager.java?rev=1424593&r1=1424592&r2=1424593&view=diff
==============================================================================
--- felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/impl/webconsole/ResourceBundleManager.java
(original)
+++ felix/sandbox/cziegeler/status-printer/src/main/java/org/apache/felix/status/impl/webconsole/ResourceBundleManager.java
Thu Dec 20 17:14:41 2012
@@ -125,7 +125,7 @@ public class ResourceBundleManager imple
         return null;
     }
 
-
+    // TODO : Instead of getting all property files, we could just get the one for the default
locale
     private synchronized Map getResourceBundleEntries(final Bundle bundle)
     {
         String file = ( String ) bundle.getHeaders().get( Constants.BUNDLE_LOCALIZATION );



Mime
View raw message