Changeset 34917 in osm for applications

Timestamp:

2019-03-11T16:00:20+01:00 (6 years ago)

Author:

gerdp

Message:

fix some sonar/javadoc issues, no functional change expected

Location:

applications/editors/josm/plugins/reverter/src/reverter

Files:

• ChangesetReverter.java (modified) (12 diffs)
• DataSetCommandMerger.java (modified) (3 diffs)
• MultiOsmReader.java (modified) (1 diff)
• OsmServerMultiObjectReader.java (modified) (3 diffs)
• ReverterPlugin.java (modified) (1 diff)
• corehacks/ChangesetDataSet.java (modified) (1 diff)
• corehacks/OsmServerChangesetReader.java (modified) (8 diffs)

applications/editors/josm/plugins/reverter/src/reverter/ChangesetReverter.java

@@ -24 +24 @@
 import org.openstreetmap.josm.data.osm.PrimitiveId;
 import org.openstreetmap.josm.data.osm.Relation;
+import org.openstreetmap.josm.data.osm.RelationMember;
 import org.openstreetmap.josm.data.osm.RelationMemberData;
 import org.openstreetmap.josm.data.osm.SimplePrimitiveId;
@@ -39 +40 @@
 import org.openstreetmap.josm.io.OsmTransferException;
 import org.openstreetmap.josm.tools.Logging;
+import org.openstreetmap.josm.tools.Utils;
 
 import reverter.corehacks.ChangesetDataSet;
@@ -110 +112 @@
 
     /**
-     * Checks if {@see ChangesetDataSetEntry} conforms to current RevertType
+     * Checks if {@link ChangesetDataSetEntry} conforms to current RevertType
      * @param entry entry to be checked
-     * @return <code>true</code> if {@see ChangesetDataSetEntry} conforms to current RevertType
+     * @return <code>true</code> if {@link ChangesetDataSetEntry} conforms to current RevertType
      */
     private boolean checkOsmChangeEntry(ChangesetDataSetEntry entry) {
@@ -128 +130 @@
      * creates a reverter for specific changeset and fetches initial data
      * @param changesetId changeset id
+     * @param revertType type of revert
+     * @param newLayer set to true if a new layer should be created
      * @param monitor progress monitor
      * @throws OsmTransferException if data transfer errors occur
@@ -185 +189 @@
     }
 
-    private void readObjectVersion(OsmServerMultiObjectReader rdr, PrimitiveId id, int version, ProgressMonitor progressMonitor)
+    private static void readObjectVersion(OsmServerMultiObjectReader rdr, PrimitiveId id, int version, ProgressMonitor progressMonitor)
             throws OsmTransferException {
         boolean readOK = false;
@@ -214 +218 @@
      * @throws OsmTransferException if data transfer errors occur
      */
-    @SuppressWarnings("unchecked")
     public void downloadObjectsHistory(ProgressMonitor progressMonitor) throws OsmTransferException {
         final OsmServerMultiObjectReader rdr = new OsmServerMultiObjectReader();
@@ -220 +223 @@
         progressMonitor.beginTask(tr("Downloading objects history"), updated.size()+deleted.size()+1);
         try {
-            for (HashSet<HistoryOsmPrimitive> collection : Arrays.asList(new HashSet[]{updated, deleted})) {
+            for (HashSet<HistoryOsmPrimitive> collection : Arrays.asList(updated, deleted)) {
                 for (HistoryOsmPrimitive entry : collection) {
                     PrimitiveId id = entry.getPrimitiveId();
@@ -279 +282 @@
     }
 
-    private static Conflict<? extends OsmPrimitive> CreateConflict(OsmPrimitive p, boolean isMyDeleted) {
+    private static Conflict<? extends OsmPrimitive> createConflict(OsmPrimitive p, boolean isMyDeleted) {
         switch (p.getType()) {
         case NODE:
@@ -337 +340 @@
     /**
      * Builds a list of commands that will revert the changeset
+     * @return list of commands
      *
      */
@@ -390 +394 @@
                     /* Don't create conflict if the object has to be deleted but has already been deleted */
                     && !(toDelete.contains(dp) && dp.isDeleted())) {
-                cmds.add(new ConflictAddCommand(layer.data, CreateConflict(dp,
+                cmds.add(new ConflictAddCommand(layer.data, createConflict(dp,
                         entry.getModificationType() == ChangesetModificationType.CREATED)));
                 conflicted.add(dp);
@@ -412 +416 @@
                                */
                 if (!conflicted.contains(p)) {
-                    cmds.add(new ConflictAddCommand(layer.data, CreateConflict(p, true)));
+                    cmds.add(new ConflictAddCommand(layer.data, createConflict(p, true)));
                     conflicted.add(p);
                 }
@@ -421 +425 @@
 
         // Create a Command to delete all marked objects
-        List<? extends OsmPrimitive> list;
-        list = OsmPrimitive.getFilteredList(toDelete, Relation.class);
-        if (!list.isEmpty()) cmds.add(new DeleteCommand(list));
-        list = OsmPrimitive.getFilteredList(toDelete, Way.class);
-        if (!list.isEmpty()) cmds.add(new DeleteCommand(list));
-        list = OsmPrimitive.getFilteredList(toDelete, Node.class);
-        if (!list.isEmpty()) cmds.add(new DeleteCommand(list));
+        Collection<? extends OsmPrimitive> collection;
+        collection = Utils.filteredCollection(toDelete, Relation.class);
+        if (!collection.isEmpty()) cmds.add(new DeleteCommand(collection));
+        collection = Utils.filteredCollection(toDelete, Way.class);
+        if (!collection.isEmpty()) cmds.add(new DeleteCommand(collection));
+        collection = Utils.filteredCollection(toDelete, Node.class);
+        if (!collection.isEmpty()) cmds.add(new DeleteCommand(collection));
         return cmds;
     }

applications/editors/josm/plugins/reverter/src/reverter/DataSetCommandMerger.java

@@ -23 +23 @@
 
 /**
- * Modified {@see org.openstreetmap.josm.data.osm.DataSetMerger} that
+ * Modified {@link org.openstreetmap.josm.data.osm.DataSetMerger} that
  * produces list of commands instead of directly merging layers.
  *
@@ -40 +40 @@
     /**
      * constructor
+     * @param sourceDataSet the source Dataset for the merge
+     * @param targetDataSet the target Dataset for the merge
      */
     DataSetCommandMerger(DataSet sourceDataSet, DataSet targetDataSet) {
@@ -65 +67 @@
     }
 
-    private void mergePrimitive(OsmPrimitive source, OsmPrimitive target, OsmPrimitive newTarget) {
+    private static void mergePrimitive(OsmPrimitive source, OsmPrimitive target, OsmPrimitive newTarget) {
         newTarget.mergeFrom(source);
         newTarget.setOsmId(target.getId(), target.getVersion());

applications/editors/josm/plugins/reverter/src/reverter/MultiOsmReader.java

@@ -14 +14 @@
 
 /**
- * Subclass of {@see org.openstreetmap.josm.io.OsmReader} that can handle multiple XML streams.
+ * Subclass of {@link org.openstreetmap.josm.io.OsmReader} that can handle multiple XML streams.
  *
  */

applications/editors/josm/plugins/reverter/src/reverter/OsmServerMultiObjectReader.java

@@ -14 +14 @@
 import org.openstreetmap.josm.io.OsmServerReader;
 import org.openstreetmap.josm.io.OsmTransferException;
-import org.xml.sax.SAXException;
 
 public class OsmServerMultiObjectReader extends OsmServerReader {
@@ -24 +23 @@
 
     public void readObject(long id, int version, OsmPrimitiveType type, ProgressMonitor progressMonitor) throws OsmTransferException {
-        StringBuffer sb = new StringBuffer();
+        StringBuilder sb = new StringBuilder();
         sb.append(type.getAPIName());
         sb.append("/");
@@ -43 +42 @@
      * Method to parse downloaded objects
      * @return the data requested
-     * @throws SAXException in case of SAX error
-     * @throws IOException in case of I/O error
+     * @throws OsmTransferException in case of error
      */
     @Override

applications/editors/josm/plugins/reverter/src/reverter/ReverterPlugin.java

@@ -11 +11 @@
 import org.openstreetmap.josm.plugins.PluginInformation;
 
+/**
+ * The reverter plugin
+ */
 public class ReverterPlugin extends Plugin {
-    static boolean reverterUsed = false;
+    static boolean reverterUsed;
+
+    /**
+     * Constructs a new {@code ReverterPlugin}.
+     * @param info plugin information
+     */
     public ReverterPlugin(PluginInformation info) {
         super(info);
         JMenu historyMenu = MainApplication.getMenu().dataMenu;
-        //MainMenu.add(historyMenu, new ObjectsHistoryAction());
         MainMenu.add(historyMenu, new RevertChangesetAction());
         UploadAction.registerUploadHook(new ReverterUploadHook(this));

applications/editors/josm/plugins/reverter/src/reverter/corehacks/ChangesetDataSet.java

@@ -166 +166 @@
 
     /**
-     * Replies the {@see HistoryOsmPrimitive} with id <code>id</code> from this
+     * Replies the {@link HistoryOsmPrimitive} with id <code>id</code> from this
      * dataset. null, if there is no such primitive in the data set.
      *
      * @param id the id
-     * @return  the {@see HistoryOsmPrimitive} with id <code>id</code> from this
+     * @return  the {@link HistoryOsmPrimitive} with id <code>id</code> from this
      * dataset
      */

applications/editors/josm/plugins/reverter/src/reverter/corehacks/OsmServerChangesetReader.java

@@ -54 +54 @@
      * @param query  the query specification. Must not be null.
      * @param monitor a progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
-     * @return the list of changesets read from the server
+     * @return the list of changesets read from the server or {@code null}
      * @throws IllegalArgumentException thrown if query is null
      * @throws OsmTransferException thrown if something goes wrong w
@@ -65 +65 @@
         try {
             monitor.beginTask(tr("Reading changesets..."));
-            StringBuffer sb = new StringBuffer();
+            StringBuilder sb = new StringBuilder();
             sb.append("changesets?").append(query.getQueryString());
             InputStream in = getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true));
@@ -98 +98 @@
         try {
             monitor.beginTask(tr("Reading changeset {0} ...", id));
-            StringBuffer sb = new StringBuffer();
+            StringBuilder sb = new StringBuilder();
             sb.append("changeset/").append(id);
             InputStream in = getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true));
@@ -120 +120 @@
      * Reads the changeset with id <code>id</code> from the server
      *
-     * @param ids  the list of ids. Ignored if null. Only load changesets for ids &gt; 0.
+     * @param ids  the collection of ids. Ignored if null. Only load changesets for ids &gt; 0.
      * @param monitor the progress monitor. Set to {@link NullProgressMonitor#INSTANCE} if null
-     * @return the changeset read
+     * @return the list of changesets read or an empty list or null in case of errors
      * @throws OsmTransferException thrown if something goes wrong
      * @throws IllegalArgumentException if id &lt;= 0
@@ -143 +143 @@
                 }
                 i++;
-                StringBuffer sb = new StringBuffer();
+                StringBuilder sb = new StringBuilder();
                 sb.append("changeset/").append(id);
                 InputStream in = getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true));
@@ -175 +175 @@
      * @throws OsmTransferException thrown if something went wrong
      */
-    public ChangesetDataSet downloadChangeset(int id, ProgressMonitor monitor) throws IllegalArgumentException, OsmTransferException {
+    public ChangesetDataSet downloadChangeset(int id, ProgressMonitor monitor) throws OsmTransferException {
         if (id <= 0)
             throw new IllegalArgumentException(
@@ -184 +184 @@
         try {
             monitor.beginTask(tr("Downloading changeset content"));
-            StringBuffer sb = new StringBuffer();
+            StringBuilder sb = new StringBuilder();
             sb.append("changeset/").append(id).append("/download");
             InputStream in = getInputStream(sb.toString(), monitor.createSubTaskMonitor(1, true));
@@ -191 +191 @@
             monitor.setCustomText(tr("Downloading content for changeset {0} ...", id));
             OsmChangesetContentParser parser = new OsmChangesetContentParser(in);
-            ChangesetDataSet ds = parser.parse(monitor.createSubTaskMonitor(1, true));
-            return ds;
-        } catch (UnsupportedEncodingException e) {
-            throw new OsmTransferException(e);
-        } catch (XmlParsingException e) {
+            return parser.parse(monitor.createSubTaskMonitor(1, true));
+        } catch (UnsupportedEncodingException | XmlParsingException e) {
             throw new OsmTransferException(e);
         } finally {