From 61ec6093e1ae5f4f349ff99db8cbe11920914272 Mon Sep 17 00:00:00 2001
From: Nils Christian Ehmke <nie@informatik.uni-kiel.de>
Date: Mon, 15 Oct 2012 23:09:14 +0200
Subject: [PATCH] Some minor modifications for quality reasons.
---
Kieker.WebGUI/.classpath | 6 ++++++
.../webgui/beans/application/GlobalPropertiesBean.java | 8 ++++----
.../webgui/beans/application/ThemeSwitcherBean.java | 2 +-
.../main/java/kieker/webgui/beans/session/UserBean.java | 2 +-
.../java/kieker/webgui/beans/view/CurrentCockpitBean.java | 3 ++-
.../webgui/beans/view/CurrentProjectOverviewBean.java | 7 ++++---
.../common/exception/AnalysisInitializationException.java | 7 +------
.../webgui/common/exception/AnalysisStateException.java | 7 +------
.../webgui/common/exception/DisplayNotFoundException.java | 4 +---
.../common/exception/LibraryAlreadyExistingException.java | 4 +---
.../webgui/common/exception/LibraryLoadException.java | 4 +---
.../webgui/common/exception/NewerProjectException.java | 4 +---
.../common/exception/ProjectAlreadyExistingException.java | 4 +---
.../webgui/common/exception/ProjectLoadException.java | 6 ++----
.../common/exception/ProjectNotExistingException.java | 4 +---
.../main/java/kieker/webgui/common/util/PluginFinder.java | 2 +-
16 files changed, 29 insertions(+), 45 deletions(-)
diff --git a/Kieker.WebGUI/.classpath b/Kieker.WebGUI/.classpath
index c39d34ad..658fc2e3 100644
--- a/Kieker.WebGUI/.classpath
+++ b/Kieker.WebGUI/.classpath
@@ -11,6 +11,12 @@
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
+ <classpathentry kind="src" output="target/test-classes" path="src/test/java">
+ <attributes>
+ <attribute name="optional" value="true"/>
+ <attribute name="maven.pomderived" value="true"/>
+ </attributes>
+ </classpathentry>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6">
<attributes>
<attribute name="maven.pomderived" value="true"/>
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/GlobalPropertiesBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/GlobalPropertiesBean.java
index 7ce21852..2a540050 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/GlobalPropertiesBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/GlobalPropertiesBean.java
@@ -30,8 +30,8 @@ import kieker.common.logging.Log;
import kieker.common.logging.LogFactory;
/**
- * The class {@link GlobalPropertiesBean} is an application-scoped JSF bean, containing the necessary properties and constants for the application. It reads them
- * from one or more properties-files and resource bundles to allow the simple modification of parameters without a necessary recompiling of the whole
+ * The class {@link GlobalPropertiesBean} is an application-scoped JSF bean, containing properties, constants and partially localized texts for the application. It
+ * reads them from properties files and ressource bundles, making sure that those constants can be modified without a necessary recompiling of the whole
* application.<br>
* It is application-scoped as only one instance of this class is necessary.
*
@@ -79,7 +79,7 @@ public final class GlobalPropertiesBean {
} catch (final IOException ex) {
// If this exception occurs there isn't much we can do. This means the resource isn't available. We can't shutdown the whole application, so instead we
// log the error.
- GlobalPropertiesBean.LOG.error("An error occured during the initialization of the propertiess.", ex);
+ GlobalPropertiesBean.LOG.error("An error occured during the initialization of the properties.", ex);
}
}
@@ -184,7 +184,7 @@ public final class GlobalPropertiesBean {
}
/**
- * This method delivers the localized message, which can be used if he creation of a repository resulted in an exception.
+ * This method delivers the localized message, which can be used if the creation of a repository resulted in an exception.
*
* @return The value of the property.
*/
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ThemeSwitcherBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ThemeSwitcherBean.java
index a07118a6..e88427d5 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ThemeSwitcherBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ThemeSwitcherBean.java
@@ -27,7 +27,7 @@ import javax.faces.bean.ManagedBean;
/**
* The {@link ThemeSwitcherBean} is responsible for holding a list with all application wide available themes (look and feels). As this is a static list, it is not
* possible to import new themes during the runtime.<br>
- * As the list with the available themes is a static list, this class is an application scoped JSF managed bean.
+ * This class is an application scoped JSF managed bean, as the list with the available themes is a static list.
*
* @author Nils Christian Ehmke
*/
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/UserBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/UserBean.java
index 04fa8a0d..6a718e06 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/UserBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/UserBean.java
@@ -23,7 +23,7 @@ import javax.faces.bean.SessionScoped;
import kieker.webgui.beans.application.GlobalPropertiesBean;
/**
- * This bean contains information about the user of this session (like user name and authorization). It provides method to log into the application.<br>
+ * This bean contains information about the user of this session (like user name and authorization). It provides methods to perform a login into the application.<br>
* This class is a JSF managed bean with session scope. This means also that it is possible to login the same user multiple times.
*
* @author Nils Christian Ehmke
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentCockpitBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentCockpitBean.java
index fa600e62..6711a6b3 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentCockpitBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentCockpitBean.java
@@ -101,7 +101,7 @@ public final class CurrentCockpitBean {
}
/**
- * This method sets the project stored within this bean and returns the new page for the navigation.
+ * This method sets the project stored within this bean.
*
* @param newName
* The name of the project.
@@ -118,6 +118,7 @@ public final class CurrentCockpitBean {
* JSF.</b>
*/
public void initalize() {
+ // TODO Replace the log messages with the localizes messages
synchronized (this) {
try {
// Make sure that the initialization will only be done for the init request.
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentProjectOverviewBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentProjectOverviewBean.java
index fdefb1fc..80451190 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentProjectOverviewBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/view/CurrentProjectOverviewBean.java
@@ -31,7 +31,7 @@ import org.primefaces.event.SelectEvent;
/**
* /**
- * The {@link CurrentControllerBean} contains the necessary data behind an instance of the project overview.<br>
+ * The {@link CurrentProjectOverviewBean} contains the necessary data behind an instance of the project overview.<br>
* The class is a JSF managed bean with view scope.
*
* @author Nils Christian Ehmke
@@ -50,7 +50,7 @@ public final class CurrentProjectOverviewBean {
private String projectName;
/**
- * Default constructor.
+ * Default constructor. <b>Do not call this constructor manually. It will only be accessed by JSF.</b>
*/
public CurrentProjectOverviewBean() {
// No code necessary
@@ -97,6 +97,7 @@ public final class CurrentProjectOverviewBean {
* Updates the list containing the available projects name.
*/
public void updateLists() {
+ // TODO This part should be replaced by a ManagedProperty annotation
final ELResolver el = FacesContext.getCurrentInstance().getApplication().getELResolver();
final ProjectsBean bean = (ProjectsBean) el.getValue(FacesContext.getCurrentInstance().getELContext(), null, "projectsBean");
@@ -120,7 +121,7 @@ public final class CurrentProjectOverviewBean {
/**
* This method delivers all available projects as a list of string.
*
- * @return All currently available projects. The list is just a copy.
+ * @return All currently available projects.
*/
public List<String> getProjects() {
return this.projects;
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisInitializationException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisInitializationException.java
index 735ea76c..47cd9718 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisInitializationException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisInitializationException.java
@@ -22,15 +22,10 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class AnalysisInitializationException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
- * private static final long serialVersionUID = 1L;
- *
- * /**
* Creates a new instance of this class.
*/
public AnalysisInitializationException() {
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisStateException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisStateException.java
index e9b2aa18..71118603 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisStateException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/AnalysisStateException.java
@@ -22,15 +22,10 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class AnalysisStateException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
- * private static final long serialVersionUID = 1L;
- *
- * /**
* Creates a new instance of this class.
*/
public AnalysisStateException() {
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/DisplayNotFoundException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/DisplayNotFoundException.java
index 8733d7e2..a21be52a 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/DisplayNotFoundException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/DisplayNotFoundException.java
@@ -22,9 +22,7 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class DisplayNotFoundException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryAlreadyExistingException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryAlreadyExistingException.java
index e00ee053..19eb1e9b 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryAlreadyExistingException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryAlreadyExistingException.java
@@ -22,9 +22,7 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class LibraryAlreadyExistingException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryLoadException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryLoadException.java
index cc1e81aa..a50d0a24 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryLoadException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/LibraryLoadException.java
@@ -22,9 +22,7 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class LibraryLoadException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/NewerProjectException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/NewerProjectException.java
index 1e01d3f4..cd1ac237 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/NewerProjectException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/NewerProjectException.java
@@ -23,9 +23,7 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class NewerProjectException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectAlreadyExistingException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectAlreadyExistingException.java
index ed759df6..6e0fbad9 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectAlreadyExistingException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectAlreadyExistingException.java
@@ -22,9 +22,7 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class ProjectAlreadyExistingException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectLoadException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectLoadException.java
index c1f7d74f..7e4d2bf2 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectLoadException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectLoadException.java
@@ -16,14 +16,12 @@
package kieker.webgui.common.exception;
/**
- * This exception ocurs when something goes wrong during the loading/opening of a given project.
+ * This exception occurs when something goes wrong during the loading/opening of a given project.
*
* @author Nils Christian Ehmke
*/
public final class ProjectLoadException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectNotExistingException.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectNotExistingException.java
index 7432e277..1b02f59f 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectNotExistingException.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/exception/ProjectNotExistingException.java
@@ -22,9 +22,7 @@ package kieker.webgui.common.exception;
* @author Nils Christian Ehmke
*/
public final class ProjectNotExistingException extends AbstractKiekerWebGUIException {
- /**
- * The UID.
- */
+
private static final long serialVersionUID = 1L;
/**
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/util/PluginFinder.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/util/PluginFinder.java
index 3f95ce29..11f677b9 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/util/PluginFinder.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/util/PluginFinder.java
@@ -43,7 +43,7 @@ public final class PluginFinder {
}
/**
- * This method delivers all classes which are available in the given jar and are compatible with <code>AbstractRepository</code>).
+ * This method delivers all classes which are available in the given jar and are compatible with <code>AbstractRepository</code>..
*
* @param url
* The url for the jar.
--
GitLab