Skip to content
Snippets Groups Projects
Commit 61ec6093 authored by Nils Christian Ehmke's avatar Nils Christian Ehmke
Browse files

Some minor modifications for quality reasons.

parent 524f39f7
No related branches found
No related tags found
No related merge requests found
Showing
with 29 additions and 45 deletions
......@@ -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"/>
......
......@@ -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.
*/
......
......@@ -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
*/
......
......@@ -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
......
......@@ -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.
......
......@@ -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;
......
......@@ -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() {
......
......@@ -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() {
......
......@@ -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;
/**
......
......@@ -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;
/**
......
......@@ -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;
/**
......
......@@ -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;
/**
......
......@@ -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;
/**
......
......@@ -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;
/**
......
......@@ -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;
/**
......
......@@ -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.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment