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/packet/TCP.java

diff --git a/src/main/java/net/onrc/onos/core/packet/TCP.java b/src/main/java/net/onrc/onos/core/packet/TCP.java
index f2f49e1..b435d74 100644
--- a/src/main/java/net/onrc/onos/core/packet/TCP.java
+++ b/src/main/java/net/onrc/onos/core/packet/TCP.java
@@ -20,6 +20,8 @@
 import java.nio.ByteBuffer;
 import java.util.Arrays;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
+
 /**
  * @author shudong.zhou@bigswitch.com
  */
@@ -141,11 +143,15 @@
         return this;
     }
 
+    @SuppressFBWarnings(value = "EI_EXPOSE_REP",
+                        justification = "TODO: Return a copy of the object?")
     public byte[] getOptions() {
         return this.options;
     }
 
-    public TCP setOptions(byte[] options) {
+    @SuppressFBWarnings(value = "EI_EXPOSE_REP2",
+                        justification = "TODO: Store a copy of the object?")
+    public TCP setOptions(final byte[] options) {
         this.options = options;
         this.dataOffset = (byte) ((20 + options.length + 3) >> 2);
         return this;