Merge pull request #2477 from jglick/Secret-nullability

Adding a few nullability annotations
jenkinsci · Jul 26, 2016 · eeadf3a · eeadf3a
2 parents 39e35d2 + 5a3823e
commit eeadf3a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/core/src/main/java/hudson/model/PasswordParameterValue.java b/core/src/main/java/hudson/model/PasswordParameterValue.java
@@ -29,12 +29,14 @@
 import org.kohsuke.stapler.DataBoundConstructor;
 
 import java.util.Locale;
+import javax.annotation.Nonnull;
 
 /**
  * @author Kohsuke Kawaguchi
  */
 public class PasswordParameterValue extends ParameterValue {
 
+    @Nonnull
     private final Secret value;
 
     // kept for backward compatibility
@@ -68,7 +70,8 @@ public String resolve(String name) {
     public boolean isSensitive() {
         return true;
     }
-
+
+    @Nonnull
     public Secret getValue() {
         return value;
     }

diff --git a/core/src/main/java/hudson/util/Secret.java b/core/src/main/java/hudson/util/Secret.java
@@ -42,6 +42,8 @@
 import java.io.IOException;
 import java.security.GeneralSecurityException;
 import java.util.regex.Pattern;
+import javax.annotation.CheckForNull;
+import javax.annotation.Nonnull;
 import org.kohsuke.accmod.Restricted;
 import org.kohsuke.accmod.restrictions.NoExternalUse;
 
@@ -62,6 +64,7 @@ public final class Secret implements Serializable {
     /**
      * Unencrypted secret text.
      */
+    @Nonnull
     private final String value;
 
     private Secret(String value) {
@@ -87,6 +90,7 @@ public String toString() {
      * Before using this method, ask yourself if you'd be better off using {@link Secret#toString(Secret)}
      * to avoid NPE.
      */
+    @Nonnull
     public String getPlainText() {
         return value;
     }
@@ -144,7 +148,8 @@ public String getEncryptedValue() {
      * Reverse operation of {@link #getEncryptedValue()}. Returns null
      * if the given cipher text was invalid.
      */
-    public static Secret decrypt(String data) {
+    @CheckForNull
+    public static Secret decrypt(@CheckForNull String data) {
         if(data==null)      return null;
         try {
             byte[] in = Base64.decode(data.toCharArray());
@@ -192,10 +197,9 @@ public static Cipher getCipher(String algorithm) throws GeneralSecurityException
      *
      * <p>
      * Useful for recovering a value from a form field.
-     *
-     * @return never null
      */
-    public static Secret fromString(String data) {
+    @Nonnull
+    public static Secret fromString(@CheckForNull String data) {
         data = Util.fixNull(data);
         Secret s = decrypt(data);
         if(s==null) s=new Secret(data);
@@ -207,7 +211,8 @@ public static Secret fromString(String data) {
      * To be consistent with {@link #fromString(String)}, this method doesn't distinguish
      * empty password and null password.
      */
-    public static String toString(Secret s) {
+    @Nonnull
+    public static String toString(@CheckForNull Secret s) {
         return s==null ? "" : s.value;
     }