Changeset 9711 in josm

Timestamp:

2016-02-01T23:47:27+01:00 (8 years ago)

Author:

simon04

Message:

see #12300 - Provide wrapper classes for transfer data to avoid unchecked casts

Location:

trunk

Files:

• src/org/openstreetmap/josm/gui/datatransfer/PrimitiveTransferable.java (modified) (3 diffs)
• src/org/openstreetmap/josm/gui/datatransfer/RelationMemberTransferable.java (modified) (2 diffs)
• src/org/openstreetmap/josm/gui/dialogs/relation/MemberTransferHandler.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/gui/datatransfer/PrimitiveTransferableTest.java (modified) (2 diffs)
• test/unit/org/openstreetmap/josm/gui/datatransfer/RelationMemberTransferableTest.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/gui/datatransfer/PrimitiveTransferable.java

@@ -19 +19 @@
 
     /**
-     * Data flavor for {@link PrimitiveData}.
+     * A wrapper for a collection of {@link PrimitiveData}.
      */
-    public static final DataFlavor PRIMITIVE_DATA = new DataFlavor(PrimitiveData.class, PrimitiveData.class.getName());
+    public static final class Data {
+        private final Collection<PrimitiveData> primitiveData;
+
+        private Data(Collection<PrimitiveData> primitiveData) {
+            this.primitiveData = primitiveData;
+        }
+
+        /**
+         * Returns the contained {@link PrimitiveData}
+         * @return the contained {@link PrimitiveData}
+         */
+        public Collection<PrimitiveData> getPrimitiveData() {
+            return primitiveData;
+        }
+    }
+
+    /**
+     * Data flavor for {@link PrimitiveData} which is wrapped in {@link Data}.
+     */
+    public static final DataFlavor PRIMITIVE_DATA = new DataFlavor(Data.class, Data.class.getName());
     private final Collection<? extends OsmPrimitive> primitives;
 
@@ -47 +66 @@
             return getStringData();
         } else if (PRIMITIVE_DATA.equals(flavor)) {
-            return getRelationMemberData();
+            return getPrimitiveData();
         }
         throw new UnsupportedFlavorException(flavor);
@@ -63 +82 @@
     }
 
-    protected Collection<PrimitiveData> getRelationMemberData() {
+    protected Data getPrimitiveData() {
         final Collection<PrimitiveData> r = new ArrayList<>(primitives.size());
         for (OsmPrimitive primitive : primitives) {
             r.add(primitive.save());
         }
-        return r;
+        return new Data(r);
     }
 }

trunk/src/org/openstreetmap/josm/gui/datatransfer/RelationMemberTransferable.java

@@ -19 +19 @@
 
     /**
-     * Data flavor for {@link RelationMemberData}.
+     * A wrapper for a collection of {@link RelationMemberData}.
      */
-    public static final DataFlavor RELATION_MEMBER_DATA = new DataFlavor(RelationMemberData.class, RelationMemberData.class.getName());
+    public static final class Data {
+        private final Collection<RelationMemberData> relationMemberDatas;
+
+        private Data(Collection<RelationMemberData> primitiveData) {
+            this.relationMemberDatas = primitiveData;
+        }
+
+        /**
+         * Returns the contained {@link RelationMemberData}
+         * @return the contained {@link RelationMemberData}
+         */
+        public Collection<RelationMemberData> getRelationMemberData() {
+            return relationMemberDatas;
+        }
+    }
+
+    /**
+     * Data flavor for {@link RelationMemberData} which is wrapped in {@link Data}.
+     */
+    public static final DataFlavor RELATION_MEMBER_DATA = new DataFlavor(Data.class, Data.class.getName());
     private final Collection<RelationMember> members;
 
@@ -64 +83 @@
     }
 
-    protected Collection<RelationMemberData> getRelationMemberData() {
+    protected Data getRelationMemberData() {
         final Collection<RelationMemberData> r = new ArrayList<>(members.size());
         for (RelationMember member : members) {
             r.add(new RelationMemberData(member.getRole(), member.getType(), member.getUniqueId()));
         }
-        return r;
+        return new Data(r);
     }
 }

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberTransferHandler.java

@@ -64 +64 @@
     protected void importRelationMemberData(TransferSupport support, final MemberTable destination, int insertRow)
             throws UnsupportedFlavorException, IOException {
-        //noinspection unchecked
-        @SuppressWarnings("unchecked")
-        final Collection<RelationMemberData> memberData = (Collection<RelationMemberData>)
+        final RelationMemberTransferable.Data memberData = (RelationMemberTransferable.Data)
                 support.getTransferable().getTransferData(RelationMemberTransferable.RELATION_MEMBER_DATA);
-        importData(destination, insertRow, memberData, new Function<RelationMemberData, RelationMember>() {
+        importData(destination, insertRow, memberData.getRelationMemberData(), new Function<RelationMemberData, RelationMember>() {
             @Override
             public RelationMember apply(RelationMemberData member) {
@@ -84 +82 @@
     protected void importPrimitiveData(TransferSupport support, final MemberTable destination, int insertRow)
             throws UnsupportedFlavorException, IOException {
-        //noinspection unchecked
-        @SuppressWarnings("unchecked")
-        final Collection<PrimitiveData> data = (Collection<PrimitiveData>)
+        final PrimitiveTransferable.Data data = (PrimitiveTransferable.Data)
                 support.getTransferable().getTransferData(PrimitiveTransferable.PRIMITIVE_DATA);
-        importData(destination, insertRow, data, new Function<PrimitiveData, RelationMember>() {
+        importData(destination, insertRow, data.getPrimitiveData(), new Function<PrimitiveData, RelationMember>() {
             @Override
             public RelationMember apply(PrimitiveData data) {

trunk/test/unit/org/openstreetmap/josm/gui/datatransfer/PrimitiveTransferableTest.java

@@ -4 +4 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 import static org.openstreetmap.josm.gui.datatransfer.PrimitiveTransferable.PRIMITIVE_DATA;
@@ -57 +56 @@
      */
     @Test
-    @SuppressWarnings("unchecked")
     public void testGetTransferDataNominal() throws UnsupportedFlavorException {
         PrimitiveTransferable pt = new PrimitiveTransferable(Collections.singleton(new Node(1)));
         assertEquals("node 1 # incomplete\n", pt.getTransferData(DataFlavor.stringFlavor));
-        Collection<PrimitiveData> td = (Collection<PrimitiveData>) pt.getTransferData(PRIMITIVE_DATA);
+        Collection<PrimitiveData> td = ((PrimitiveTransferable.Data) pt.getTransferData(PRIMITIVE_DATA)).getPrimitiveData();
         assertEquals(1, td.size());
-        assertNotNull(td.iterator().next());
+        assertTrue(td.iterator().next() instanceof PrimitiveData);
     }
 

trunk/test/unit/org/openstreetmap/josm/gui/datatransfer/RelationMemberTransferableTest.java

@@ -4 +4 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 import static org.openstreetmap.josm.gui.datatransfer.RelationMemberTransferable.RELATION_MEMBER_DATA;
@@ -17 +16 @@
 import org.openstreetmap.josm.JOSMFixture;
 import org.openstreetmap.josm.data.osm.Node;
-import org.openstreetmap.josm.data.osm.PrimitiveData;
 import org.openstreetmap.josm.data.osm.RelationMember;
+import org.openstreetmap.josm.data.osm.RelationMemberData;
 
 /**
@@ -58 +57 @@
      */
     @Test
-    @SuppressWarnings("unchecked")
     public void testGetTransferDataNominal() throws UnsupportedFlavorException {
         RelationMemberTransferable rmt = new RelationMemberTransferable(Collections.singleton(new RelationMember("test", new Node(1))));
         assertEquals("node 1 test # incomplete\n", rmt.getTransferData(DataFlavor.stringFlavor));
-        Collection<PrimitiveData> td = (Collection<PrimitiveData>) rmt.getTransferData(RELATION_MEMBER_DATA);
+        Collection<RelationMemberData> td = ((RelationMemberTransferable.Data) rmt.getTransferData(RELATION_MEMBER_DATA)).getRelationMemberData();
         assertEquals(1, td.size());
-        assertNotNull(td.iterator().next());
+        assertTrue(td.iterator().next() instanceof RelationMemberData);
     }