Sprinkle @NonNull annotations 69/98369/2
authorRobert Varga <robert.varga@pantheon.tech>
Mon, 8 Nov 2021 15:50:25 +0000 (16:50 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Mon, 8 Nov 2021 16:17:51 +0000 (17:17 +0100)
We have a few return methods which could use @NonNull annotations,
sprinkle them around.

Change-Id: I48c0f8879127673eb122321dd6c92d4572098f68
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/Envelope.java
opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/FrontendIdentifier.java
opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/LocalHistoryIdentifier.java
opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/MemberName.java
opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/concepts/TransactionIdentifier.java
opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/AbstractIdentifiablePayload.java

index 8c5f513..c6123d6 100644 (file)
@@ -11,12 +11,13 @@ import static java.util.Objects.requireNonNull;
 
 import com.google.common.base.MoreObjects;
 import java.io.Serializable;
 
 import com.google.common.base.MoreObjects;
 import java.io.Serializable;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.concepts.Immutable;
 
 public abstract class Envelope<T extends Message<?, ?>> implements Immutable, Serializable {
     private static final long serialVersionUID = 1L;
 
 import org.opendaylight.yangtools.concepts.Immutable;
 
 public abstract class Envelope<T extends Message<?, ?>> implements Immutable, Serializable {
     private static final long serialVersionUID = 1L;
 
-    private final T message;
+    private final @NonNull T message;
     private final long txSequence;
     private final long sessionId;
 
     private final long txSequence;
     private final long sessionId;
 
@@ -31,7 +32,7 @@ public abstract class Envelope<T extends Message<?, ?>> implements Immutable, Se
      *
      * @return enclose message
      */
      *
      * @return enclose message
      */
-    public T getMessage() {
+    public @NonNull T getMessage() {
         return message;
     }
 
         return message;
     }
 
index d47f037..10abac6 100644 (file)
@@ -17,6 +17,7 @@ import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.util.Objects;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.util.Objects;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.concepts.WritableIdentifier;
 
 /**
 import org.opendaylight.yangtools.concepts.WritableIdentifier;
 
 /**
@@ -69,11 +70,11 @@ public final class FrontendIdentifier implements WritableIdentifier {
         this.memberName = requireNonNull(memberName);
     }
 
         this.memberName = requireNonNull(memberName);
     }
 
-    public static FrontendIdentifier create(final MemberName memberName, final FrontendType clientType) {
+    public static @NonNull FrontendIdentifier create(final MemberName memberName, final FrontendType clientType) {
         return new FrontendIdentifier(memberName, clientType);
     }
 
         return new FrontendIdentifier(memberName, clientType);
     }
 
-    public static FrontendIdentifier readFrom(final DataInput in) throws IOException {
+    public static @NonNull FrontendIdentifier readFrom(final DataInput in) throws IOException {
         final MemberName memberName = MemberName.readFrom(in);
         final FrontendType clientType = FrontendType.readFrom(in);
         return new FrontendIdentifier(memberName, clientType);
         final MemberName memberName = MemberName.readFrom(in);
         final FrontendType clientType = FrontendType.readFrom(in);
         return new FrontendIdentifier(memberName, clientType);
@@ -85,11 +86,11 @@ public final class FrontendIdentifier implements WritableIdentifier {
         clientType.writeTo(out);
     }
 
         clientType.writeTo(out);
     }
 
-    public FrontendType getClientType() {
+    public @NonNull FrontendType getClientType() {
         return clientType;
     }
 
         return clientType;
     }
 
-    public MemberName getMemberName() {
+    public @NonNull MemberName getMemberName() {
         return memberName;
     }
 
         return memberName;
     }
 
@@ -111,7 +112,7 @@ public final class FrontendIdentifier implements WritableIdentifier {
         return memberName.equals(other.memberName) && clientType.equals(other.clientType);
     }
 
         return memberName.equals(other.memberName) && clientType.equals(other.clientType);
     }
 
-    public String toPersistentId() {
+    public @NonNull String toPersistentId() {
         return memberName.getName() + "-frontend-" + clientType.getName();
     }
 
         return memberName.getName() + "-frontend-" + clientType.getName();
     }
 
index f8f890e..137bf59 100644 (file)
@@ -16,6 +16,7 @@ import java.io.Externalizable;
 import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.concepts.WritableIdentifier;
 import org.opendaylight.yangtools.concepts.WritableObjects;
 
 import org.opendaylight.yangtools.concepts.WritableIdentifier;
 import org.opendaylight.yangtools.concepts.WritableObjects;
 
@@ -51,7 +52,7 @@ public final class LocalHistoryIdentifier implements WritableIdentifier {
         }
 
         Proxy(final ClientIdentifier frontendId, final long historyId, final long cookie) {
         }
 
         Proxy(final ClientIdentifier frontendId, final long historyId, final long cookie) {
-            this.clientId = requireNonNull(frontendId);
+            clientId = requireNonNull(frontendId);
             this.historyId = historyId;
             this.cookie = cookie;
         }
             this.historyId = historyId;
             this.cookie = cookie;
         }
@@ -77,7 +78,7 @@ public final class LocalHistoryIdentifier implements WritableIdentifier {
     }
 
     private static final long serialVersionUID = 1L;
     }
 
     private static final long serialVersionUID = 1L;
-    private final ClientIdentifier clientId;
+    private final @NonNull ClientIdentifier clientId;
     private final long historyId;
     private final long cookie;
 
     private final long historyId;
     private final long cookie;
 
@@ -86,12 +87,12 @@ public final class LocalHistoryIdentifier implements WritableIdentifier {
     }
 
     public LocalHistoryIdentifier(final ClientIdentifier frontendId, final long historyId, final long cookie) {
     }
 
     public LocalHistoryIdentifier(final ClientIdentifier frontendId, final long historyId, final long cookie) {
-        this.clientId = requireNonNull(frontendId);
+        clientId = requireNonNull(frontendId);
         this.historyId = historyId;
         this.cookie = cookie;
     }
 
         this.historyId = historyId;
         this.cookie = cookie;
     }
 
-    public static LocalHistoryIdentifier readFrom(final DataInput in) throws IOException {
+    public static @NonNull LocalHistoryIdentifier readFrom(final DataInput in) throws IOException {
         final ClientIdentifier clientId = ClientIdentifier.readFrom(in);
 
         final byte header = WritableObjects.readLongHeader(in);
         final ClientIdentifier clientId = ClientIdentifier.readFrom(in);
 
         final byte header = WritableObjects.readLongHeader(in);
@@ -105,7 +106,7 @@ public final class LocalHistoryIdentifier implements WritableIdentifier {
         WritableObjects.writeLongs(out, historyId, cookie);
     }
 
         WritableObjects.writeLongs(out, historyId, cookie);
     }
 
-    public ClientIdentifier getClientId() {
+    public @NonNull ClientIdentifier getClientId() {
         return clientId;
     }
 
         return clientId;
     }
 
index 8a1123d..3cc2b0c 100644 (file)
@@ -22,6 +22,7 @@ import java.io.IOException;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.nio.charset.StandardCharsets;
 import java.io.ObjectInput;
 import java.io.ObjectOutput;
 import java.nio.charset.StandardCharsets;
+import org.eclipse.jdt.annotation.NonNull;
 import org.opendaylight.yangtools.concepts.WritableIdentifier;
 
 /**
 import org.opendaylight.yangtools.concepts.WritableIdentifier;
 
 /**
@@ -65,7 +66,8 @@ public final class MemberName implements Comparable<MemberName>, WritableIdentif
     }
 
     private static final long serialVersionUID = 1L;
     }
 
     private static final long serialVersionUID = 1L;
-    private final String name;
+
+    private final @NonNull String name;
 
     @SuppressFBWarnings(value = "VO_VOLATILE_REFERENCE_TO_ARRAY",
             justification = "The array elements are non-volatile but we don't access them.")
 
     @SuppressFBWarnings(value = "VO_VOLATILE_REFERENCE_TO_ARRAY",
             justification = "The array elements are non-volatile but we don't access them.")
@@ -80,13 +82,13 @@ public final class MemberName implements Comparable<MemberName>, WritableIdentif
         this.serialized = verifyNotNull(serialized);
     }
 
         this.serialized = verifyNotNull(serialized);
     }
 
-    public static MemberName forName(final String name) {
+    public static @NonNull MemberName forName(final String name) {
         checkArgument(!Strings.isNullOrEmpty(name));
         // TODO: consider caching instances here
         return new MemberName(name);
     }
 
         checkArgument(!Strings.isNullOrEmpty(name));
         // TODO: consider caching instances here
         return new MemberName(name);
     }
 
-    public static MemberName readFrom(final DataInput in) throws IOException {
+    public static @NonNull MemberName readFrom(final DataInput in) throws IOException {
         final byte[] serialized = new byte[in.readInt()];
         in.readFully(serialized);
         return new MemberName(new String(serialized, StandardCharsets.UTF_8));
         final byte[] serialized = new byte[in.readInt()];
         in.readFully(serialized);
         return new MemberName(new String(serialized, StandardCharsets.UTF_8));
@@ -99,12 +101,12 @@ public final class MemberName implements Comparable<MemberName>, WritableIdentif
         out.write(local);
     }
 
         out.write(local);
     }
 
-    public String getName() {
+    public @NonNull String getName() {
         return name;
     }
 
     public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
         return name;
     }
 
     public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
-        .MemberName toYang() {
+        .@NonNull MemberName toYang() {
         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
                 .MemberName(name);
     }
         return new org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.cds.types.rev191024
                 .MemberName(name);
     }
index 8fa0b62..d2a92ea 100644 (file)
@@ -62,7 +62,7 @@ public final class TransactionIdentifier implements WritableIdentifier {
     }
 
     private static final long serialVersionUID = 1L;
     }
 
     private static final long serialVersionUID = 1L;
-    private final LocalHistoryIdentifier historyId;
+    private final @NonNull LocalHistoryIdentifier historyId;
     private final long transactionId;
     private String shortString;
 
     private final long transactionId;
     private String shortString;
 
@@ -71,7 +71,7 @@ public final class TransactionIdentifier implements WritableIdentifier {
         this.transactionId = transactionId;
     }
 
         this.transactionId = transactionId;
     }
 
-    public static TransactionIdentifier readFrom(final DataInput in) throws IOException {
+    public static @NonNull TransactionIdentifier readFrom(final DataInput in) throws IOException {
         final LocalHistoryIdentifier historyId = LocalHistoryIdentifier.readFrom(in);
         return new TransactionIdentifier(historyId, WritableObjects.readLong(in));
     }
         final LocalHistoryIdentifier historyId = LocalHistoryIdentifier.readFrom(in);
         return new TransactionIdentifier(historyId, WritableObjects.readLong(in));
     }
@@ -82,7 +82,7 @@ public final class TransactionIdentifier implements WritableIdentifier {
         WritableObjects.writeLong(out, transactionId);
     }
 
         WritableObjects.writeLong(out, transactionId);
     }
 
-    public LocalHistoryIdentifier getHistoryId() {
+    public @NonNull LocalHistoryIdentifier getHistoryId() {
         return historyId;
     }
 
         return historyId;
     }
 
index 32e155b..de9b0bb 100644 (file)
@@ -7,9 +7,9 @@
  */
 package org.opendaylight.controller.cluster.datastore.persisted;
 
  */
 package org.opendaylight.controller.cluster.datastore.persisted;
 
+import static com.google.common.base.Verify.verifyNotNull;
 import static java.util.Objects.requireNonNull;
 
 import static java.util.Objects.requireNonNull;
 
-import com.google.common.base.Verify;
 import com.google.common.io.ByteStreams;
 import java.io.DataInput;
 import java.io.Externalizable;
 import com.google.common.io.ByteStreams;
 import java.io.DataInput;
 import java.io.Externalizable;
@@ -32,6 +32,7 @@ public abstract class AbstractIdentifiablePayload<T extends Identifier> extends
         implements Serializable {
     protected abstract static class AbstractProxy<T extends Identifier> implements Externalizable {
         private static final long serialVersionUID = 1L;
         implements Serializable {
     protected abstract static class AbstractProxy<T extends Identifier> implements Externalizable {
         private static final long serialVersionUID = 1L;
+
         private byte[] serialized;
         private T identifier;
 
         private byte[] serialized;
         private T identifier;
 
@@ -54,11 +55,11 @@ public abstract class AbstractIdentifiablePayload<T extends Identifier> extends
             final int length = in.readInt();
             serialized = new byte[length];
             in.readFully(serialized);
             final int length = in.readInt();
             serialized = new byte[length];
             in.readFully(serialized);
-            identifier = Verify.verifyNotNull(readIdentifier(ByteStreams.newDataInput(serialized)));
+            identifier = verifyNotNull(readIdentifier(ByteStreams.newDataInput(serialized)));
         }
 
         protected final Object readResolve() {
         }
 
         protected final Object readResolve() {
-            return Verify.verifyNotNull(createObject(identifier, serialized));
+            return verifyNotNull(createObject(identifier, serialized));
         }
 
         protected abstract @NonNull T readIdentifier(@NonNull DataInput in) throws IOException;
         }
 
         protected abstract @NonNull T readIdentifier(@NonNull DataInput in) throws IOException;
@@ -68,8 +69,9 @@ public abstract class AbstractIdentifiablePayload<T extends Identifier> extends
     }
 
     private static final long serialVersionUID = 1L;
     }
 
     private static final long serialVersionUID = 1L;
-    private final byte[] serialized;
-    private final T identifier;
+
+    private final byte @NonNull [] serialized;
+    private final @NonNull T identifier;
 
     AbstractIdentifiablePayload(final @NonNull T identifier, final byte @NonNull[] serialized) {
         this.identifier = requireNonNull(identifier);
 
     AbstractIdentifiablePayload(final @NonNull T identifier, final byte @NonNull[] serialized) {
         this.identifier = requireNonNull(identifier);
@@ -87,7 +89,7 @@ public abstract class AbstractIdentifiablePayload<T extends Identifier> extends
     }
 
     protected final Object writeReplace() {
     }
 
     protected final Object writeReplace() {
-        return Verify.verifyNotNull(externalizableProxy(serialized));
+        return verifyNotNull(externalizableProxy(serialized));
     }
 
     @SuppressWarnings("checkstyle:hiddenField")
     }
 
     @SuppressWarnings("checkstyle:hiddenField")