Changeset 36091 in osm

Timestamp:

2023-05-30T21:32:07+02:00 (14 months ago)

Author:

stoecker

Message:

fix warnings

Location:

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions

Files:

• dnd/PrimitiveIdTransferable.java (modified) (2 diffs)
• editor/ExceptValueModel.java (modified) (5 diffs)
• editor/JosmSelectionListModel.java (modified) (1 diff)
• editor/RelationMemberModel.java (modified) (1 diff)
• editor/TurnRestrictionEditor.java (modified) (7 diffs)
• editor/TurnRestrictionEditorManager.java (modified) (2 diffs)
• editor/TurnRestrictionEditorModel.java (modified) (1 diff)
• editor/TurnRestrictionSelectionPopupPanel.java (modified) (1 diff)
• list/TurnRestrictionsListModel.java (modified) (2 diffs)
• qa/Issue.java (modified) (2 diffs)
• qa/IssueView.java (modified) (2 diffs)
• qa/IssuesModel.java (modified) (1 diff)
• qa/IssuesView.java (modified) (1 diff)
• qa/TurnRestrictionLegSplitRequiredError.java (modified) (1 diff)

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/dnd/PrimitiveIdTransferable.java

@@ -30 +30 @@
      * See also {@link #getPrimitiveIds()} and {@link #getAsString()}
      */
-    public static final DataFlavor[] SUPPORTED_FLAVORS = new DataFlavor[] {
+    private static final DataFlavor[] SUPPORTED_FLAVORS = new DataFlavor[] {
         PRIMITIVE_ID_LIST_FLAVOR,
         DataFlavor.stringFlavor
@@ -49 +49 @@
 
     /**
-     * <p>If flavor is {@link #PRIMITIVE_ID_SET_FLAVOR}, replies a the list of
+     * <p>If flavor is {@link #PRIMITIVE_ID_LIST_FLAVOR}, replies a the list of
      * transferred {@link PrimitiveId}s</p>
      *

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/ExceptValueModel.java

@@ -130 +130 @@
      * model.
      *
-     * @param vehicleType one of the standard vehicle types from {@see #STANDARD_VEHICLE_EXCEPTION_VALUES}
+     * @param vehicleType one of the standard vehicle types from {@link #STANDARD_VEHICLE_EXCEPTION_VALUES}
      * @return true if {@code vehicleType} is currently set as exception in this
      * model.
@@ -147 +147 @@
      * Sets the {@code vehicleType} as exception in this turn restriction.
      *
-     * @param vehicleType one of the standard vehicle types from {@see #STANDARD_VEHICLE_EXCEPTION_VALUES}
+     * @param vehicleType one of the standard vehicle types from {@link #STANDARD_VEHICLE_EXCEPTION_VALUES}
      * @exception IllegalArgumentException thrown if {@code vehicleType} isn't a standard vehicle type
      */
@@ -162 +162 @@
      * on whether {@code setOrRemove} is true or false, respectively.
      *
-     * @param vehicleType one of the standard vehicle types from {@see #STANDARD_VEHICLE_EXCEPTION_VALUES}
+     * @param vehicleType one of the standard vehicle types from {@link #STANDARD_VEHICLE_EXCEPTION_VALUES}
      * @param setOrRemove if true, the exception is set; otherwise, it is removed
      * @exception IllegalArgumentException thrown if {@code vehicleType} isn't a standard vehicle type
@@ -177 +177 @@
      * Removes the {@code vehicleType} as exception in this turn restriction
      *
-     * @param vehicleType one of the standard vehicle types from {@see #STANDARD_VEHICLE_EXCEPTION_VALUES}
+     * @param vehicleType one of the standard vehicle types from {@link #STANDARD_VEHICLE_EXCEPTION_VALUES}
      * @exception IllegalArgumentException thrown if {@code vehicleType} isn't a standard vehicle type
      */
@@ -199 +199 @@
         if (this == obj)
             return true;
-        if (obj == null)
-            return false;
-        if (getClass() != obj.getClass())
+        if (!(obj instanceof ExceptValueModel))
             return false;
         ExceptValueModel other = (ExceptValueModel) obj;

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/JosmSelectionListModel.java

@@ -46 +46 @@
      * Constructor
      *
-     * @param selectionModel the selection model used in the list. Must not be null.
      * @param layer the layer this model is displaying the selection from. Must not be null.
      * @throws IllegalArgumentException thrown if {@code layer} is null

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/RelationMemberModel.java

@@ -96 +96 @@
         if (this == obj)
             return true;
-        if (obj == null)
-            return false;
-        if (getClass() != obj.getClass())
+        if (!(obj instanceof RelationMemberModel))
             return false;
         RelationMemberModel other = (RelationMemberModel) obj;

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/TurnRestrictionEditor.java

@@ -61 +61 @@
 public class TurnRestrictionEditor extends JDialog implements NavigationControler {
 
-    /** the property name for the current turn restriction
-     * @link #setRelation(Relation)
-     * @link #getRelation()
-     */
-    public static final String TURN_RESTRICION_PROP = RelationEditor.class.getName() + ".turnRestriction";
-
-    /** the property name for the current relation snapshot
-     * @link #getRelationSnapshot()
-     */
-    public static final String TURN_RESTRICION_SNAPSHOT_PROP = RelationEditor.class.getName() + ".turnRestrictionSnapshot";
+    /** The property name for the current turn restriction, see {@link #setTurnRestriction(Relation)} and
+     * {@link #getTurnRestriction()}
+     */
+    public static final String TURN_RESTRICTION_PROP = RelationEditor.class.getName() + ".turnRestriction";
+
+    /** the property name for the current relation snapshot, see {@link #getTurnRestrictionSnapshot()}
+     */
+    public static final String TURN_RESTRICTION_SNAPSHOT_PROP = RelationEditor.class.getName() + ".turnRestrictionSnapshot";
 
     /**
@@ -192 +190 @@
 
     /**
-     * builds the UI
+     * Builds the UI
      */
     protected void build() {
@@ -265 +263 @@
         setTurnRestrictionSnapshot(turnRestriction == null ? null : new Relation(turnRestriction));
         this.turnRestriction = turnRestriction;
-        support.firePropertyChange(TURN_RESTRICION_PROP, null, this.turnRestriction);
+        support.firePropertyChange(TURN_RESTRICTION_PROP, null, this.turnRestriction);
         updateTitle();
     }
@@ -309 +307 @@
     protected void setTurnRestrictionSnapshot(Relation snapshot) {
         turnRestrictionSnapshot = snapshot;
-        support.firePropertyChange(TURN_RESTRICION_SNAPSHOT_PROP, null, turnRestrictionSnapshot);
+        support.firePropertyChange(TURN_RESTRICTION_SNAPSHOT_PROP, null, turnRestrictionSnapshot);
     }
 
@@ -779 +777 @@
         @Override
         public void propertyChange(PropertyChangeEvent evt) {
-            if (evt.getPropertyName().equals(TURN_RESTRICION_PROP)) {
+            if (evt.getPropertyName().equals(TURN_RESTRICTION_PROP)) {
                 updateEnabledState();
             }
@@ -807 +805 @@
         @Override
         public void propertyChange(PropertyChangeEvent evt) {
-            if (evt.getPropertyName().equals(TURN_RESTRICION_PROP)) {
+            if (evt.getPropertyName().equals(TURN_RESTRICTION_PROP)) {
                 updateEnabledState();
             }
@@ -839 +837 @@
         @Override
         public void propertyChange(PropertyChangeEvent evt) {
-            if (evt.getPropertyName().equals(TURN_RESTRICION_PROP)) {
+            if (evt.getPropertyName().equals(TURN_RESTRICTION_PROP)) {
                 updateEnabledState();
             }

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/TurnRestrictionEditorManager.java

@@ -71 +71 @@
             if (this == obj)
                 return true;
-            if (obj == null)
-                return false;
-            if (getClass() != obj.getClass())
+            if (!(obj instanceof DialogContext))
                 return false;
             DialogContext other = (DialogContext) obj;
@@ -175 +173 @@
      * is currently open. Returns null, if relation is null.
      *
+     * See also {@link #isOpenInEditor(OsmDataLayer, Relation)}
+     *
      * @param layer the layer
      * @param relation the relation
      * @return the editor for the turn restriction managed by layer. Null, if no such editor
      * is currently open.
-     *
-     * @link #isOpenInEditor(OsmDataLayer, Relation)
      */
     public TurnRestrictionEditor getEditorForRelation(OsmDataLayer layer, Relation relation) {

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/TurnRestrictionEditorModel.java

@@ -274 +274 @@
      * <p>If {@code vias} is null, all vias are removed. All primitives
      * in {@code vias} must be assigned to a dataset and the dataset
-     * must be equal to the dataset of this editor model, see {@link #getDataSet()}</p>
-     *
-     * <p>null values in {@link vias} are skipped.</p>
+     * must be equal to the dataset of this editor model, see {@link OsmPrimitive#getDataSet()}</p>
+     *
+     * <p>null values in {@code vias} are skipped.</p>
      *
      * @param vias the list of vias

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/editor/TurnRestrictionSelectionPopupPanel.java

@@ -185 +185 @@
      * @throws IllegalArgumentException thrown if {@code layer} is null
      */
-    public TurnRestrictionSelectionPopupPanel(OsmDataLayer layer, Collection<Relation> editCandiates) {
+    public TurnRestrictionSelectionPopupPanel(OsmDataLayer layer, Collection<Relation> editCandidates) {
         CheckParameterUtil.ensureParameterNotNull(layer, "layer");
         this.layer = layer;
-        build(editCandiates);
+        build(editCandidates);
     }
 

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/list/TurnRestrictionsListModel.java

@@ -209 +209 @@
      * Sets the selected turn restrictions
      *
-     * @return sel the list of selected turn restrictions
+     * @param sel the list of selected turn restrictions
      */
     public void setSelectedTurnRestrictions(List<Relation> sel) {
@@ -227 +227 @@
      * Returns the index of a turn restriction
      *
+     * @param tr Turn restriction relation to check
      * @return index of relation (-1, if not found)
      */

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/Issue.java

@@ -13 +13 @@
  * An issue represents a data integrity violation in a turn restriction.
  *
- * The issue has a {@see Severity}. It is described to the user with a HTML formatted
- * text (see {@see #getText()}) and it suggests a list of possible actions to fix
- * the issue (see {@see #getActions()}).
+ * The issue has a {@link Severity}. It is described to the user with a HTML formatted
+ * text (see {@link #getText()}) and it suggests a list of possible actions to fix
+ * the issue (see {@link #getActions()}).
  *
  */
@@ -26 +26 @@
     /**
      * Creates a new issue associated with a parent model. Severity is
-     * initialized to {@see Severity#WARNING}.
+     * initialized to {@link Severity#WARNING}.
      *
      * @param parent the parent model. Must not be null.

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/IssueView.java

@@ -23 +23 @@
 
 /**
- * An IssueView is a view on an individual {@see Issue}.
+ * An IssueView is a view on an individual {@link Issue}.
  */
 public class IssueView extends JPanel {
@@ -35 +35 @@
      * Builds the style sheet used in the internal help browser
      *
-     * @return the style sheet
+     * @param view the {@code HtmlPanel} where the {@link StyleSheet} should be adapted
      */
     protected void initStyleSheet(HtmlPanel view) {

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/IssuesModel.java

@@ -84 +84 @@
      * turn restriction editor model. If {@code editorModel} is null, the
      * list of issues is cleared.
-     *
-     * @param editorModel the editor model.
      */
     public void populate() {

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/IssuesView.java

@@ -14 +14 @@
 
 /**
- * IssuesView provides a view on a {@see IssuesModel}.
+ * IssuesView provides a view on a {@link IssuesModel}.
  */
 public class IssuesView extends VerticallyScrollablePanel implements Observer {

applications/editors/josm/plugins/turnrestrictions/src/org/openstreetmap/josm/plugins/turnrestrictions/qa/TurnRestrictionLegSplitRequiredError.java

@@ -40 +40 @@
      * @param from the way with role "from"
      * @param to the way with role "to"
-     * @param intersect the intersection node
      */
     public TurnRestrictionLegSplitRequiredError(IssuesModel parent, Way from, Way to) {