Kotlin conversion: KeyIdUtil

This PR also introduces LongExtensions.kt which provides extension methods to
parse Long from Hex KeyIDs and to format Longs as Hex KeyIDs.
This commit is contained in:
Paul Schaub 2023-09-04 14:30:50 +02:00
parent d075ed6637
commit 44c22f9044
Signed by: vanitasvitae
GPG Key ID: 62BEE9264BF17311
3 changed files with 61 additions and 37 deletions

View File

@ -1,37 +0,0 @@
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
package org.pgpainless.key.util;
import java.math.BigInteger;
import java.util.regex.Pattern;
public final class KeyIdUtil {
private KeyIdUtil() {
}
private static final Pattern LONG_KEY_ID = Pattern.compile("^[0-9A-Fa-f]{16}$");
/**
* Convert a long key-id into a key-id.
* A long key-id is a 16 digit hex string.
*
* @param longKeyId 16-digit hexadecimal string
* @return key-id converted to {@link Long}.
*/
public static long fromLongKeyId(String longKeyId) {
if (!LONG_KEY_ID.matcher(longKeyId).matches()) {
throw new IllegalArgumentException("Provided long key-id does not match expected format. " +
"A long key-id consists of 16 hexadecimal characters.");
}
return new BigInteger(longKeyId, 16).longValue();
}
public static String formatKeyId(long keyId) {
return String.format("%016X", keyId);
}
}

View File

@ -0,0 +1,25 @@
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
package _kotlin
/**
* Format this Long as a 16 digit uppercase hex number.
*/
fun Long.hexKeyId(): String {
return String.format("%016X", this).uppercase()
}
/**
* Parse a 16 digit hex number into a Long.
*/
fun Long.Companion.fromHexKeyId(hexKeyId: String): Long {
require("^[0-9A-Fa-f]{16}$".toRegex().matches(hexKeyId)) {
"Provided long key-id does not match expected format. " +
"A long key-id consists of 16 hexadecimal characters."
}
// Calling toLong() only fails with a NumberFormatException.
// Therefore, we call toULong(16).toLong(), which seems to work.
return hexKeyId.toULong(16).toLong()
}

View File

@ -0,0 +1,36 @@
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
package org.pgpainless.key.util
import _kotlin.fromHexKeyId
import _kotlin.hexKeyId
class KeyIdUtil {
companion object {
/**
* Convert a long key-id into a key-id.
* A long key-id is a 16 digit hex string.
*
* @param longKeyId 16-digit hexadecimal string
* @return key-id converted to {@link Long}.
*/
@JvmStatic
@Deprecated("Superseded by Long extension method.",
ReplaceWith("Long.fromHexKeyId(longKeyId)"))
fun fromLongKeyId(longKeyId: String) = Long.fromHexKeyId(longKeyId)
/**
* Format a long key-ID as upper-case hex string.
* @param keyId keyId
* @return hex encoded key ID
*/
@JvmStatic
@Deprecated("Superseded by Long extension method.",
ReplaceWith("keyId.hexKeyId()"))
fun formatKeyId(keyId: Long) = keyId.hexKeyId()
}
}