Annotate Guava Immutable collections

The following methods in Immutable{List|Set|Map} are all used
to create new collections and never return null values:

builder()
Builder.build()
copyOf()
of()

They can all be annotated as @NonNull.

Change-Id: I7149f488d2905c5def7b7b39993e9584642a4b0a
Signed-off-by: Alexandre Montplaisir <alexmonthy@voxpopuli.im>
Reviewed-on: https://git.eclipse.org/r/59326
Reviewed-by: Hudson CI
Reviewed-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>
Tested-by: Marc-Andre Laperle <marc-andre.laperle@ericsson.com>

diff --git a/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableList$Builder.eea b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableList$Builder.eea
new file mode 100644 (file)
index 0000000..c6c3367
--- /dev/null
+++ b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableList$Builder.eea
@@ -0,0 +1,4 @@
+class com/google/common/collect/ImmutableList$Builder
+build
+ ()Lcom/google/common/collect/ImmutableList<TE;>;
+ ()L1com/google/common/collect/ImmutableList<TE;>;

diff --git a/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableList.eea b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableList.eea
new file mode 100644 (file)
index 0000000..c660721
--- /dev/null
+++ b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableList.eea
@@ -0,0 +1,58 @@
+class com/google/common/collect/ImmutableList
+EMPTY
+ Lcom/google/common/collect/ImmutableList<Ljava/lang/Object;>;
+ L1com/google/common/collect/ImmutableList<Ljava/lang/Object;>;
+builder
+ <E:Ljava/lang/Object;>()Lcom/google/common/collect/ImmutableList$Builder<TE;>;
+ <E:Ljava/lang/Object;>()L1com/google/common/collect/ImmutableList$Builder<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>(Ljava/lang/Iterable<+TE;>;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(Ljava/lang/Iterable<+TE;>;)L1com/google/common/collect/ImmutableList<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>(Ljava/util/Collection<+TE;>;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(Ljava/util/Collection<+TE;>;)L1com/google/common/collect/ImmutableList<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>(Ljava/util/Iterator<+TE;>;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(Ljava/util/Iterator<+TE;>;)L1com/google/common/collect/ImmutableList<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>([TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>([TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>()Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>()L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableList<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;[TE;)Lcom/google/common/collect/ImmutableList<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;TE;[TE;)L1com/google/common/collect/ImmutableList<TE;>;

diff --git a/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableMap$Builder.eea b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableMap$Builder.eea
new file mode 100644 (file)
index 0000000..114dee7
--- /dev/null
+++ b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableMap$Builder.eea
@@ -0,0 +1,4 @@
+class com/google/common/collect/ImmutableMap$Builder
+build
+ ()Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ ()L1com/google/common/collect/ImmutableMap<TK;TV;>;

diff --git a/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableMap.eea b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableMap.eea
new file mode 100644 (file)
index 0000000..6eabf29
--- /dev/null
+++ b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableMap.eea
@@ -0,0 +1,25 @@
+class com/google/common/collect/ImmutableMap
+builder
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>()Lcom/google/common/collect/ImmutableMap$Builder<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>()L1com/google/common/collect/ImmutableMap$Builder<TK;TV;>;
+copyOf
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(Ljava/util/Map<+TK;+TV;>;)Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(Ljava/util/Map<+TK;+TV;>;)L1com/google/common/collect/ImmutableMap<TK;TV;>;
+of
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>()Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>()L1com/google/common/collect/ImmutableMap<TK;TV;>;
+of
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;)Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;)L1com/google/common/collect/ImmutableMap<TK;TV;>;
+of
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;)Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;)L1com/google/common/collect/ImmutableMap<TK;TV;>;
+of
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;TK;TV;)Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;TK;TV;)L1com/google/common/collect/ImmutableMap<TK;TV;>;
+of
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;TK;TV;TK;TV;)Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;TK;TV;TK;TV;)L1com/google/common/collect/ImmutableMap<TK;TV;>;
+of
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;TK;TV;TK;TV;TK;TV;)Lcom/google/common/collect/ImmutableMap<TK;TV;>;
+ <K:Ljava/lang/Object;V:Ljava/lang/Object;>(TK;TV;TK;TV;TK;TV;TK;TV;TK;TV;)L1com/google/common/collect/ImmutableMap<TK;TV;>;

diff --git a/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableSet$Builder.eea b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableSet$Builder.eea
new file mode 100644 (file)
index 0000000..503e10b
--- /dev/null
+++ b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableSet$Builder.eea
@@ -0,0 +1,4 @@
+class com/google/common/collect/ImmutableSet$Builder
+build
+ ()Lcom/google/common/collect/ImmutableSet<TE;>;
+ ()L1com/google/common/collect/ImmutableSet<TE;>;

diff --git a/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableSet.eea b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableSet.eea
new file mode 100644 (file)
index 0000000..93ed65a
--- /dev/null
+++ b/common/org.eclipse.tracecompass.common.core/annotations/com/google/common/collect/ImmutableSet.eea
@@ -0,0 +1,37 @@
+class com/google/common/collect/ImmutableSet
+builder
+ <E:Ljava/lang/Object;>()Lcom/google/common/collect/ImmutableSet$Builder<TE;>;
+ <E:Ljava/lang/Object;>()L1com/google/common/collect/ImmutableSet$Builder<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>(Ljava/lang/Iterable<+TE;>;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(Ljava/lang/Iterable<+TE;>;)L1com/google/common/collect/ImmutableSet<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>(Ljava/util/Collection<+TE;>;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(Ljava/util/Collection<+TE;>;)L1com/google/common/collect/ImmutableSet<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>(Ljava/util/Iterator<+TE;>;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(Ljava/util/Iterator<+TE;>;)L1com/google/common/collect/ImmutableSet<TE;>;
+copyOf
+ <E:Ljava/lang/Object;>([TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>([TE;)L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>()Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>()L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(TE;)L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;)L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;)L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;)L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;)L1com/google/common/collect/ImmutableSet<TE;>;
+of
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;[TE;)Lcom/google/common/collect/ImmutableSet<TE;>;
+ <E:Ljava/lang/Object;>(TE;TE;TE;TE;TE;TE;[TE;)L1com/google/common/collect/ImmutableSet<TE;>;

diff --git a/tmf/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/trace/TmfTraceUtilsTest.java b/tmf/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/trace/TmfTraceUtilsTest.java
index cd5b4f6b7daebbaab2314462859542a1b51e043b..ba66c7bfd30e853e4645cb5ac8efea8c97731394 100644 (file)
--- a/tmf/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/trace/TmfTraceUtilsTest.java
+++ b/tmf/org.eclipse.tracecompass.tmf.core.tests/src/org/eclipse/tracecompass/tmf/core/tests/trace/TmfTraceUtilsTest.java
@@ -73,9 +73,7 @@ public class TmfTraceUtilsTest {
                 }
             });
             builder.addAll(TmfTrace.BASE_ASPECTS);
-            @SuppressWarnings("null")
-            @NonNull Collection<ITmfEventAspect> ret = builder.build();
-            EVENT_ASPECTS = ret;
+            EVENT_ASPECTS = builder.build();
         }
 
         public TmfTraceStubWithAspects(String path) throws TmfTraceException {

diff --git a/tmf/org.eclipse.tracecompass.tmf.core.tests/stubs/org/eclipse/tracecompass/tmf/tests/stubs/trace/xml/TmfXmlTraceStub.java b/tmf/org.eclipse.tracecompass.tmf.core.tests/stubs/org/eclipse/tracecompass/tmf/tests/stubs/trace/xml/TmfXmlTraceStub.java
index 8f635a68d24568191dce39dd2a3caf402ce2b7ef..64c48ac99dec115b0d4b3611baf49eecd156e513 100644 (file)
--- a/tmf/org.eclipse.tracecompass.tmf.core.tests/stubs/org/eclipse/tracecompass/tmf/tests/stubs/trace/xml/TmfXmlTraceStub.java
+++ b/tmf/org.eclipse.tracecompass.tmf.core.tests/stubs/org/eclipse/tracecompass/tmf/tests/stubs/trace/xml/TmfXmlTraceStub.java
@@ -331,10 +331,7 @@ public class TmfXmlTraceStub extends TmfTrace {
 
         /* Add the big content aspect */
         builder.add(ITmfEventAspect.BaseAspects.CONTENTS);
-
-        @SuppressWarnings("null")
-        @NonNull Collection<ITmfEventAspect> aspectList = builder.build();
-        fAspects = aspectList;
+        fAspects = builder.build();
     }
 
     @Override