commit c9bacee44d63dddc14766c06cdd579af98f30db1
author Pavlin Radoslavov <pavlin@onlab.us> Fri Apr 11 19:02:17 2014 -0700
committer Gerrit Code Review <gerrit2@onos-services> Mon Apr 14 19:15:28 2014 -0700
tree ff00466914627c6103af92220729425f849f34b9
parent 7fb16415fd579ff2f03e6c99737d3735f5fa1c36

Suppress issues found by FindBugs: EI_EXPOSE_REP and EI_EXPOSE_REP2

http://findbugs.sourceforge.net/bugDescriptions.html#EI_EXPOSE_REP

http://findbugs.sourceforge.net/bugDescriptions.html#EI_EXPOSE_REP2

A proper fix for EI_EXPOSE_REP would require eventually to return a copy of an
internal object.
A proper fix for EI_EXPOSE_REP2 would require eventually to store a copy of the
provided object-argument.
However, the performance implication of creating the extra copies is not clear,
hence for the time being all those issues are suppressed by using the following
statements:

    @SuppressFBWarnings(value = "EI_EXPOSE_REP",
                        justification = "TODO: Return a copy of the object?")

    @SuppressFBWarnings(value = "EI_EXPOSE_REP2",
                        justification = "TODO: Store a copy of the object?")

Those suppressed warnings should be re-evaluated and addressed on case-by-case, e.g.
create object copies as appropriate.

Change-Id: I2df00242876e6c185d9fc098b15217138a324a8d

src/main/java/net/onrc/onos/core/datastore/hazelcast/HZTable.java

diff --git a/src/main/java/net/onrc/onos/core/datastore/hazelcast/HZTable.java b/src/main/java/net/onrc/onos/core/datastore/hazelcast/HZTable.java
index 20501bb..e609bce 100644
--- a/src/main/java/net/onrc/onos/core/datastore/hazelcast/HZTable.java
+++ b/src/main/java/net/onrc/onos/core/datastore/hazelcast/HZTable.java
@@ -7,6 +7,8 @@
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicLong;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
 import net.onrc.onos.core.datastore.IKVTable;
 import net.onrc.onos.core.datastore.IKVTableID;
 import net.onrc.onos.core.datastore.ObjectDoesntExistException;
@@ -152,6 +154,8 @@
         byte[] value;
         long version;
 
+        @SuppressFBWarnings(value = "EI_EXPOSE_REP2",
+                            justification = "TODO: Store a copy of the object?")
         public Entry(final byte[] key, final byte[] value, final long version) {
             this.key = key;
             this.setValue(value);
@@ -163,11 +167,15 @@
         }
 
         @Override
+        @SuppressFBWarnings(value = "EI_EXPOSE_REP",
+                            justification = "TODO: Return a copy of the object?")
         public byte[] getKey() {
             return key;
         }
 
         @Override
+        @SuppressFBWarnings(value = "EI_EXPOSE_REP",
+                            justification = "TODO: Return a copy of the object?")
         public byte[] getValue() {
             return value;
         }