tidy up, improved logging
diff --git a/src/main/java/org/apache/log4j/chainsaw/help/HelpLocator.java b/src/main/java/org/apache/log4j/chainsaw/help/HelpLocator.java
index e97bfa2..1edee10 100644
--- a/src/main/java/org/apache/log4j/chainsaw/help/HelpLocator.java
+++ b/src/main/java/org/apache/log4j/chainsaw/help/HelpLocator.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.log4j.chainsaw.help;
import org.apache.logging.log4j.LogManager;
@@ -35,8 +34,8 @@
* <psmith@apache.org>
*/
class HelpLocator {
- private final List<ClassLoader> classLoaders = new ArrayList<>();
private static final Logger logger = LogManager.getLogger(HelpLocator.class);
+ private final List<ClassLoader> classLoaders = new ArrayList<>();
/**
* Adds a ClassLoader to be used as a help resource locator
@@ -54,8 +53,7 @@
try {
classLoaders.add(new HelpResourceLoader(url));
} catch (Exception e) {
- logger.error(
- "Failed to setup the resource loaders for the Help Subsystem");
+ logger.error("Failed to setup the resource loaders for the Help Subsystem");
}
}
diff --git a/src/main/java/org/apache/log4j/chainsaw/help/HelpManager.java b/src/main/java/org/apache/log4j/chainsaw/help/HelpManager.java
index 161d30a..d2175d1 100644
--- a/src/main/java/org/apache/log4j/chainsaw/help/HelpManager.java
+++ b/src/main/java/org/apache/log4j/chainsaw/help/HelpManager.java
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.log4j.chainsaw.help;
import org.apache.logging.log4j.LogManager;
@@ -27,10 +26,9 @@
import java.io.File;
import java.net.URL;
-
/**
* Singleton help manager where objects can register to display
- * Help for something, an independant viewer can register to
+ * Help for something, an independent viewer can register to
* be notified when the requested Help URL changes and can display
* it appropriately. This class effectively decouples the help requester
* from the help implementation (if any!)
@@ -38,30 +36,27 @@
* @author Paul Smith <psmith@apache.org>
*/
public final class HelpManager {
- private final Logger logger = LogManager.getLogger(HelpManager.class);
-
private static final HelpManager instance = new HelpManager();
- private HelpLocator helpLocator = new HelpLocator();
- private URL helpURL;
+ private final Logger logger = LogManager.getLogger(HelpManager.class);
private final PropertyChangeSupport propertySupport = new PropertyChangeSupport(this);
+ private final HelpLocator helpLocator = new HelpLocator();
private HelpManager() {
-
// TODO setup all the base URLs in the default.properties and configure in ApplicationPreferenceModel
try {
-
if (System.getProperty("log4j.chainsaw.localDocs") != null) {
- logger.info("Adding HelpLocator for localDocs property=" +
+ logger.info("Adding HelpLocator for localDocs property={}",
System.getProperty("log4j.chainsaw.localDocs"));
- helpLocator.installLocator(new URL(
- System.getProperty("log4j.chainsaw.localDocs")));
+ helpLocator.installLocator(new URL(System.getProperty("log4j.chainsaw.localDocs")));
} else if (new File("docs/api").exists()) {
File dir = new File("docs/api");
- logger.info("Detected Local JavaDocs at " + dir.toString());
+ logger.info("Detected Local JavaDocs at {}", dir);
helpLocator.installLocator(dir.toURI().toURL());
} else {
- logger.warn("Could not find any local JavaDocs, you might want to consider running 'ant javadoc'. The release version will be able to access Javadocs from the Apache website.");
+ logger.warn(
+ "Could not find any local JavaDocs, you might want to consider running 'ant javadoc'. " +
+ "The release version will be able to access Javadocs from the Apache website.");
}
} catch (Exception e) {
logger.error(e);
@@ -70,6 +65,10 @@
helpLocator.installClassloaderLocator(this.getClass().getClassLoader());
}
+ public static HelpManager getInstance() {
+ return instance;
+ }
+
/**
* The current Help URL that should be displayed, and is
* a PropertyChangeListener supported property.
@@ -81,16 +80,14 @@
* @param helpURL
*/
public void setHelpURL(URL helpURL) {
- this.helpURL = helpURL;
- firePropertyChange("helpURL", null, this.helpURL);
+ firePropertyChange("helpURL", null, helpURL);
}
public void addPropertyChangeListener(PropertyChangeListener listener) {
propertySupport.addPropertyChangeListener(listener);
}
- public synchronized void addPropertyChangeListener(String propertyName,
- PropertyChangeListener listener) {
+ public synchronized void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) {
propertySupport.addPropertyChangeListener(propertyName, listener);
}
@@ -98,35 +95,26 @@
propertySupport.firePropertyChange(evt);
}
- public void firePropertyChange(String propertyName, boolean oldValue,
- boolean newValue) {
+ public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue) {
propertySupport.firePropertyChange(propertyName, oldValue, newValue);
}
- public void firePropertyChange(String propertyName, int oldValue,
- int newValue) {
+ public void firePropertyChange(String propertyName, int oldValue, int newValue) {
propertySupport.firePropertyChange(propertyName, oldValue, newValue);
}
- public void firePropertyChange(String propertyName, Object oldValue,
- Object newValue) {
+ public void firePropertyChange(String propertyName, Object oldValue, Object newValue) {
propertySupport.firePropertyChange(propertyName, oldValue, newValue);
}
- public synchronized void removePropertyChangeListener(
- PropertyChangeListener listener) {
+ public synchronized void removePropertyChangeListener(PropertyChangeListener listener) {
propertySupport.removePropertyChangeListener(listener);
}
- public synchronized void removePropertyChangeListener(String propertyName,
- PropertyChangeListener listener) {
+ public synchronized void removePropertyChangeListener(String propertyName, PropertyChangeListener listener) {
propertySupport.removePropertyChangeListener(propertyName, listener);
}
- public static HelpManager getInstance() {
- return instance;
- }
-
/**
* Given a class, and that it belongs within the org.apache.log4j project,
* sets the URL to the JavaDoc for that class.
@@ -145,15 +133,12 @@
* @return URL
*/
public URL getHelpForClass(Class c) {
-
String name = c.getName();
name = name.replace('.', '/') + ".html";
URL url = helpLocator.findResource(name);
- logger.debug("located help resource for '" + name + "' at " +
- ((url == null) ? "" : url.toExternalForm()));
+ logger.debug("located help resource for '{}' at {}", name, ((url == null) ? "" : url.toExternalForm()));
return (url != null) ? url : ChainsawConstants.URL_PAGE_NOT_FOUND;
-
}
}
