FELIX-1211 JavaDoc on the getResourceProvider method
git-svn-id: https://svn.apache.org/repos/asf/felix/trunk@789267 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java b/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
index cdebce8..5341e88 100644
--- a/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
+++ b/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java
@@ -182,10 +182,23 @@
return bundleContext;
}
- protected Object getResourceProvider() {
+
+ /**
+ * Returns the object which might provide resources. The class of this
+ * object is used to find the <code>getResource</code> method.
+ * <p>
+ * This method may be overwritten by extensions. This base class
+ * implementation returns this instance.
+ *
+ * @return The resource provider object or <code>null</code> if no
+ * resources will be provided by this plugin.
+ */
+ protected Object getResourceProvider()
+ {
return this;
}
+
/**
* Returns a method which is called on the
* {@link #getResourceProvider() resource provder} class to return an URL