Fingerprint: add constructor javadoc
Change-Id: Ie6980571d632c6d7d8ae7ac1092df5692a98729e
diff --git a/gerrit-server/src/main/java/com/google/gerrit/server/git/gpg/Fingerprint.java b/gerrit-server/src/main/java/com/google/gerrit/server/git/gpg/Fingerprint.java
index 924f918..bc70cb3 100644
--- a/gerrit-server/src/main/java/com/google/gerrit/server/git/gpg/Fingerprint.java
+++ b/gerrit-server/src/main/java/com/google/gerrit/server/git/gpg/Fingerprint.java
@@ -39,9 +39,18 @@
return fp;
}
+ /**
+ * Wrap a fingerprint byte array.
+ * <p>
+ * The newly created Fingerprint object takes ownership of the byte array,
+ * which must not be subsequently modified. (Most callers, such as hex
+ * decoders and {@code
+ * org.bouncycastle.openpgp.PGPPublicKey#getFingerprint()}, already produce
+ * fresh byte arrays).
+ *
+ * @param fp 20-byte fingerprint byte array to wrap.
+ */
public Fingerprint(byte[] fp) {
- // Don't bother with defensive copies; PGPPublicKey#getFingerprint() already
- // does so.
this.fp = checkLength(fp);
}