mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-11-19 02:42:05 +01:00
Kotlin conversion: StreamEncoding
This commit is contained in:
parent
595b9c7379
commit
5da58904b6
GPG key ID:
62BEE9264BF17311
2 changed files with 71 additions and 101 deletions
|
|
@ -1,101 +0,0 @@
|
|||
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package org.pgpainless.algorithm;
|
||||
|
||||
import java.util.Map;
|
||||
import java.util.NoSuchElementException;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
|
||||
import org.bouncycastle.openpgp.PGPLiteralData;
|
||||
|
||||
import javax.annotation.Nonnull;
|
||||
import javax.annotation.Nullable;
|
||||
|
||||
/**
|
||||
* Enumeration of possible encoding formats of the content of the literal data packet.
|
||||
*
|
||||
* @see <a href="https://tools.ietf.org/html/rfc4880#section-5.9">RFC4880: Literal Data Packet</a>
|
||||
*/
|
||||
public enum StreamEncoding {
|
||||
|
||||
/**
|
||||
* The Literal packet contains binary data.
|
||||
*/
|
||||
BINARY(PGPLiteralData.BINARY),
|
||||
|
||||
/**
|
||||
* The Literal packet contains text data, and thus may need line ends converted to local form, or other
|
||||
* text-mode changes.
|
||||
*/
|
||||
TEXT(PGPLiteralData.TEXT),
|
||||
|
||||
/**
|
||||
* Indication that the implementation believes that the literal data contains UTF-8 text.
|
||||
*/
|
||||
UTF8(PGPLiteralData.UTF8),
|
||||
|
||||
/**
|
||||
* Early versions of PGP also defined a value of 'l' as a 'local' mode for machine-local conversions.
|
||||
* RFC 1991 [RFC1991] incorrectly stated this local mode flag as '1' (ASCII numeral one).
|
||||
* Both of these local modes are deprecated.
|
||||
*/
|
||||
@Deprecated
|
||||
LOCAL('l'),
|
||||
;
|
||||
|
||||
private final char code;
|
||||
|
||||
private static final Map<Character, StreamEncoding> MAP = new ConcurrentHashMap<>();
|
||||
static {
|
||||
for (StreamEncoding f : StreamEncoding.values()) {
|
||||
MAP.put(f.code, f);
|
||||
}
|
||||
// RFC 1991 [RFC1991] incorrectly stated local mode flag as '1', see doc of LOCAL.
|
||||
MAP.put('1', LOCAL);
|
||||
}
|
||||
|
||||
StreamEncoding(char code) {
|
||||
this.code = code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the code identifier of the encoding.
|
||||
*
|
||||
* @return identifier
|
||||
*/
|
||||
public char getCode() {
|
||||
return code;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the {@link StreamEncoding} corresponding to the provided code identifier.
|
||||
* If no matching encoding is found, return null.
|
||||
*
|
||||
* @param code identifier
|
||||
* @return encoding enum
|
||||
*/
|
||||
@Nullable
|
||||
public static StreamEncoding fromCode(int code) {
|
||||
return MAP.get((char) code);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the {@link StreamEncoding} corresponding to the provided code identifier.
|
||||
* If no matching encoding is found, throw a {@link NoSuchElementException}.
|
||||
*
|
||||
* @param code identifier
|
||||
* @return encoding enum
|
||||
*
|
||||
* @throws NoSuchElementException in case of an unmatched identifier
|
||||
*/
|
||||
@Nonnull
|
||||
public static StreamEncoding requireFromCode(int code) {
|
||||
StreamEncoding encoding = fromCode(code);
|
||||
if (encoding == null) {
|
||||
throw new NoSuchElementException("No StreamEncoding found for code " + code);
|
||||
}
|
||||
return encoding;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,71 @@
|
|||
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
|
||||
//
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package org.pgpainless.algorithm
|
||||
|
||||
/**
|
||||
* Enumeration of possible encoding formats of the content of the literal data packet.
|
||||
*
|
||||
* See [RFC4880: Literal Data Packet](https://tools.ietf.org/html/rfc4880#section-5.9)
|
||||
*/
|
||||
enum class StreamEncoding(val code: Char) {
|
||||
|
||||
/**
|
||||
* The Literal packet contains binary data.
|
||||
*/
|
||||
BINARY('b'),
|
||||
|
||||
/**
|
||||
* The Literal packet contains text data, and thus may need line ends converted to local form, or other
|
||||
* text-mode changes.
|
||||
*/
|
||||
TEXT('t'),
|
||||
|
||||
/**
|
||||
* Indication that the implementation believes that the literal data contains UTF-8 text.
|
||||
*/
|
||||
UTF8('u'),
|
||||
|
||||
/**
|
||||
* Early versions of PGP also defined a value of 'l' as a 'local' mode for machine-local conversions.
|
||||
* RFC 1991 [RFC1991] incorrectly stated this local mode flag as '1' (ASCII numeral one).
|
||||
* Both of these local modes are deprecated.
|
||||
*/
|
||||
@Deprecated("LOCAL is deprecated.")
|
||||
LOCAL('l'),
|
||||
;
|
||||
|
||||
|
||||
companion object {
|
||||
/**
|
||||
* Return the [StreamEncoding] corresponding to the provided code identifier.
|
||||
* If no matching encoding is found, return null.
|
||||
*
|
||||
* @param code identifier
|
||||
* @return encoding enum
|
||||
*/
|
||||
@JvmStatic
|
||||
fun fromCode(code: Int): StreamEncoding? {
|
||||
return values().firstOrNull {
|
||||
it.code == code.toChar()
|
||||
} ?: if (code == 1) return LOCAL else null
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the [StreamEncoding] corresponding to the provided code identifier.
|
||||
* If no matching encoding is found, throw a [NoSuchElementException].
|
||||
*
|
||||
* @param code identifier
|
||||
* @return encoding enum
|
||||
*
|
||||
* @throws NoSuchElementException in case of an unmatched identifier
|
||||
*/
|
||||
@JvmStatic
|
||||
fun requireFromCode(code: Int): StreamEncoding {
|
||||
return fromCode(code) ?:
|
||||
throw NoSuchElementException("No StreamEncoding found for code $code")
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in a new issue