From fff356d79881d7614ff16340e6e4c7749c378f76 Mon Sep 17 00:00:00 2001
From: Nils Christian Ehmke <nie@informatik.uni-kiel.de>
Date: Sat, 16 Jun 2012 22:01:36 +0200
Subject: [PATCH] Minor quality modifications.
---
.../kieker/webgui/beans/application/ProjectsBean.java | 3 +--
.../kieker/webgui/beans/session/CurrentThemeBean.java | 3 ---
.../java/kieker/webgui/beans/session/UserBean.java | 11 +++++++----
.../webgui/beans/view/CurrentProjectOverviewBean.java | 6 ++++++
.../src/main/java/kieker/webgui/common/ACManager.java | 2 +-
.../src/main/java/kieker/webgui/common/FSManager.java | 2 +-
6 files changed, 16 insertions(+), 11 deletions(-)
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ProjectsBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ProjectsBean.java
index 2e041c11..84dbffee 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ProjectsBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/application/ProjectsBean.java
@@ -34,7 +34,6 @@ import javax.faces.bean.ApplicationScoped;
import javax.faces.bean.ManagedBean;
import javax.faces.context.FacesContext;
-import kieker.analysis.AnalysisController;
import kieker.analysis.model.analysisMetaModel.MIProject;
import kieker.common.logging.Log;
import kieker.common.logging.LogFactory;
@@ -179,7 +178,7 @@ public final class ProjectsBean {
*
* @param project
* The project whose state should be delivered.
- * @return The current state of the corresponding {@link AnalysisController} as defined by {@link ACManager#getAnalysisControllerStateString(String)}.
+ * @return The current state of the corresponding AnalysisController as defined by {@link ACManager#getAnalysisControllerStateString(String)}.
*/
public String getAnalysisControllerState(final String project) {
return ACManager.getInstance().getAnalysisControllerStateString(project);
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/CurrentThemeBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/CurrentThemeBean.java
index 044c86ba..941b213b 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/CurrentThemeBean.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/CurrentThemeBean.java
@@ -29,15 +29,12 @@ import javax.faces.context.FacesContext;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;
-import kieker.webgui.beans.application.ThemeSwitcherBean;
-
/**
* This bean contains the current user theme (look and feel) of the (session) user. The default value is the "glass-x"-theme, if no other value can be find within
* the parameters of the faces context or in the cookies of the user.
*
* @author Nils Christian Ehmke
*
- * @see ThemeSwitcherBean
* @version 1.0
*/
@ManagedBean
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 304c1bfb..6d7f16c8 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
@@ -41,14 +41,14 @@ public final class UserBean implements Serializable {
* The serial version UID.
*/
private static final long serialVersionUID = 3942693805646862667L;
- /**
- * This field contains the name of the user.
- */
- private final String userName;
/**
* The counter to get a number for the current user and to differ the sessions in test purposes.
*/
private static final AtomicLong GUEST_COUNTER = new AtomicLong();
+ /**
+ * This field contains the name of the user.
+ */
+ private final String userName;
/**
* Creates a new instance of this class. The user name is set to "Guest".
@@ -57,6 +57,9 @@ public final class UserBean implements Serializable {
this.userName = "Guest #" + UserBean.GUEST_COUNTER.getAndIncrement();
}
+ /**
+ * This method should only be called automatically by the JVM just before the object is destroyed.
+ */
@PreDestroy
protected void destroy() {
UserBean.GUEST_COUNTER.decrementAndGet();
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 62f4f1c4..3819230b 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
@@ -76,11 +76,17 @@ public class CurrentProjectOverviewBean {
this.projectName = projectName;
}
+ /**
+ * This method should only be called automatically by the JVM to update the projects list.
+ */
@PostConstruct
protected void init() {
this.updateLists();
}
+ /**
+ * Updates the list containing the available projects name.
+ */
public void updateLists() {
final ELResolver el = FacesContext.getCurrentInstance().getApplication().getELResolver();
final ProjectsBean bean = (ProjectsBean) el.getValue(FacesContext.getCurrentInstance().getELContext(), null, "projectsBean");
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/ACManager.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/ACManager.java
index a696057e..2634ce70 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/ACManager.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/ACManager.java
@@ -58,7 +58,7 @@ import kieker.webgui.common.exception.ProjectStillRunningException;
* @version 1.0
*/
// TODO How to differ between views and displays with same names?
-public final class ACManager {
+public final class ACManager { // NOCS (Class Data Abstraction Coupling)
/**
* This is the log for errors, exceptions etc.
*/
diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/FSManager.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/FSManager.java
index 96f34d46..b6f866e8 100644
--- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/FSManager.java
+++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/FSManager.java
@@ -60,7 +60,7 @@ import org.primefaces.model.UploadedFile;
*/
// TODO Projects have to check their lock once they entered the synchronized block in order to make sure that they have still the valid one (and not a removed one
// from an older project)
-public final class FSManager {
+public final class FSManager { // NOCS (Class Data Abstraction Coupling, Class Fan-Out Complexity)
/**
* This is the log object used to log messages, warnings etc.
*/
--
GitLab