some javadoc cleanup

2026-09-24 14:38:45 +00:00 · 2016-05-17 14:23:28 +02:00
parent 76131fba6f
commit d05b7cac67
12 changed files with 45 additions and 50 deletions
@@ -3,6 +3,10 @@ package com.sap.sse.gwt.client.shared.components;
 import com.sap.sse.common.settings.AbstractSettings;
 import com.sap.sse.common.settings.Settings;

+/**
+ * @author Frank
+ *
+ */
 public class CompositeLifecycleSettings extends AbstractSettings {
    private final Iterable<ComponentLifecycleAndSettings<?,?>> settingsPerComponentLifecycle;

@@ -11,7 +11,7 @@ import com.sap.sse.gwt.client.shared.components.ComponentAndSettings;
 import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent;

 /**
- * An abstract base class for perspectives with a widget.
+ * An abstract base class for a {@link Perspective} with a widget.
 * 
 * @author Frank Mittag
 *
@@ -10,7 +10,7 @@ import com.sap.sse.gwt.client.shared.components.CompositeLifecycleSettings;
 import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent;

 /**
- * An abstract base class for perspective lifecycles.
+ * An abstract base class for perspective lifecycle's.
 * @param <PS>
 *            the perspective settings type
 * @param <PCS>
@@ -7,8 +7,8 @@ import com.sap.sse.gwt.client.shared.components.Component;
 import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent;

 /**
- * A perspective is a composition of UI components into a view/page The perspective itself is also an component and can
- * have settings.
+ * A perspective is a composition of UI components into a view/page. The perspective itself is also an {@link Component} and can
+ * have {@link settings}.
 * @param <PS>
 *      the {@link Perspective} settings type
 */
@@ -4,7 +4,7 @@ import com.sap.sse.common.settings.Settings;
 import com.sap.sse.gwt.client.shared.components.ComponentAndSettings;

 /** 
- * A perspective and it's composite settings 
+ * A utility class to combine a {@link Perspective} and it's composite settings 
 * @param <PS>
 *      the {@link Perspective} settings type
 */
@@ -6,23 +6,27 @@ import com.sap.sse.common.settings.Settings;

 /** 
 * A perspective and it's perspective specific settings 
- **/
-public class PerspectiveAndSettings<SettingsType extends Settings> implements Serializable {
+ *
+ * @param <PS>
+ *      the perspective settings type
+ * @author Frank Mittag
+ */
+public class PerspectiveAndSettings<PS extends Settings> implements Serializable {
    private static final long serialVersionUID = -6750964868964305325L;

-    private final Perspective<SettingsType> perspective;
-    private final SettingsType settings;
+    private final Perspective<PS> perspective;
+    private final PS settings;
    
-    public PerspectiveAndSettings(Perspective<SettingsType> perspective, SettingsType settings) {
+    public PerspectiveAndSettings(Perspective<PS> perspective, PS settings) {
        this.perspective = perspective;
        this.settings = settings;
    }

-    public Perspective<SettingsType> getPerspective() {
+    public Perspective<PS> getPerspective() {
        return perspective;
    }

-    public SettingsType getSettings() {
+    public PS getSettings() {
        return settings;
    }
 }
@@ -11,6 +11,7 @@ import com.sap.sse.gwt.client.shared.perspective.PerspectiveCompositeLifecycleTa
 import com.sap.sse.gwt.client.shared.perspective.PerspectiveCompositeLifecycleTabbedSettingsDialogComponent.PerspectiveLifecycleWithSettingsAndDialogComponent;

 /**
+ * A validator for the composite settings of a perspective based on the perspective lifecycle. 
 * @author Frank
 *
 * @param <PL>
@@ -15,6 +15,14 @@ import com.sap.sse.gwt.client.shared.components.Component;
 import com.sap.sse.gwt.client.shared.components.ComponentAndSettings;
 import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent;

+/**
+ * @author Frank
+ *
+ * @param <P>
+ *      the type of the Perspective
+ * @param <PS>
+ *      the type of the Perspective settings
+ **/
 public class PerspectiveCompositeTabbedSettingsDialogComponent<P extends Perspective<PS>, PS extends Settings>
    implements SettingsDialogComponent<PerspectiveCompositeSettings<PS>> {
    
@@ -10,6 +10,14 @@ import com.sap.sse.gwt.client.shared.components.ComponentAndSettings;
 import com.sap.sse.gwt.client.shared.perspective.PerspectiveCompositeTabbedSettingsDialogComponent.ComponentAndDialogComponent;
 import com.sap.sse.gwt.client.shared.perspective.PerspectiveCompositeTabbedSettingsDialogComponent.PerspectiveAndDialogComponent;

+/**
+ * @author Frank
+ *
+ * @param <P>
+ *      the type of the perspective
+ * @param <PS>
+ *      the type of the perspective settings
+ **/
 public class PerspectiveCompositeValidator<P extends Perspective<PS>, PS extends Settings>
    implements Validator<PerspectiveCompositeSettings<PS>> {
    
@@ -8,10 +8,12 @@ import com.sap.sse.gwt.client.shared.components.SettingsDialogComponent;
 /**
 * A lifecycle interface for a {@link Perspective}
 *
+ * @param <PS>
+ *      the perspective specific settings type
 * @param <PCS>
- *            the perspective composite settings type
+ *      the perspective composite settings type
 * @param <SDP>
- *            the settings dialog component type
+ *      the settings dialog component type
 * @author Frank Mittag
 */
 public interface PerspectiveLifecycle<PS extends Settings, PCS extends PerspectiveCompositeLifecycleSettings<?,?>, SDP extends SettingsDialogComponent<PCS>> extends ComponentLifecycle<PCS, SDP> {
@@ -1,33 +0,0 @@
-package com.sap.sse.gwt.client.shared.perspective;
-
-
-
-/**
- * @author Frank
- *
- * @param <PL>
- *      the {@link PerspectiveLifecycle} type
- * @param <PS>
- *      the {@link Perspective} composite settings type
- */
-public class PerspectiveLifecycleAndCompositeSettings<PL extends PerspectiveLifecycle<? ,PCS, ?>, PCS extends PerspectiveCompositeLifecycleSettings<?,?>> {
-    private final PL perspectiveLifecycle;
-    private PCS settings;
-
-    public PerspectiveLifecycleAndCompositeSettings(PL perspectiveLifecycle, PCS compositeSettings) {
-        this.perspectiveLifecycle = perspectiveLifecycle;
-        this.settings = compositeSettings;
-    }
-
-    public PL getPerspectiveLifecycle() {
-        return perspectiveLifecycle;
-    }
-    
-    public PCS getSettings() {
-        return settings;
-    }
-    
-    public void setSettings(PCS settings) {
-        this.settings = settings;
-    }
-}
@@ -3,11 +3,12 @@ package com.sap.sse.gwt.client.shared.perspective;
 import com.sap.sse.common.settings.Settings;

 /**
- * The class combining the PerspectiveLifecycle and the settings of the corresponding Perspective (not the composite settings)
- * @author Frank
- *
+ * A utility class to combine the {@link PerspectiveLifecycle} and the settings of the corresponding {@link Perspective} (not the composite settings)
 * @param <PL>
+ *      the {@link PerspectiveLifecycle} type
 * @param <PS>
+ *      the {@link Perspective} composite settings type
+ * @author Frank
 */
 public class PerspectiveLifecycleAndSettings<PL extends PerspectiveLifecycle<PS, ?, ?>, PS extends Settings> {
    private final PL perspectiveLifecycle;