PGPainless/sop-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/sop-java.git synced 2024-11-22 15:12:06 +01:00
Code Issues Projects Releases Packages Wiki Activity

Kotlin conversion: Version

Browse source
This commit is contained in:
Paul Schaub 2023-10-31 14:38:34 +01:00
parent a8c2e72ef5
commit d0ee9c2066
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
3 changed files with 100 additions and 118 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

109
sop-java/src/main/java/sop/operation/Version.java
View file

@ -1,109 +0,0 @@
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
package sop.operation;
public interface Version {
/**
* Return the implementations name.
* e.g. "SOP",
*
* @return implementation name
*/
String getName();
/**
* Return the implementations short version string.
* e.g. "1.0"
*
* @return version string
*/
String getVersion();
/**
* Return version information about the used OpenPGP backend.
* e.g. "Bouncycastle 1.70"
*
* @return backend version string
*/
String getBackendVersion();
/**
* Return an extended version string containing multiple lines of version information.
* The first line MUST match the information produced by {@link #getName()} and {@link #getVersion()}, but the rest of the text
* has no defined structure.
* Example:
* <pre>
* "SOP 1.0
* Awesome PGP!
* Using Bouncycastle 1.70
* LibFoo 1.2.2
* See https://pgp.example.org/sop/ for more information"
* </pre>
*
* @return extended version string
*/
String getExtendedVersion();
/**
* Return the revision of the SOP specification that this implementation is implementing, for example,
* <pre>draft-dkg-openpgp-stateless-cli-06</pre>.
* If the implementation targets a specific draft but the implementer knows the implementation is incomplete,
* it should prefix the draft title with a "~" (TILDE, U+007E), for example:
* <pre>~draft-dkg-openpgp-stateless-cli-06</pre>.
* The implementation MAY emit additional text about its relationship to the targeted draft on the lines following
* the versioned title.
*
* @return implemented SOP spec version
*/
default String getSopSpecVersion() {
StringBuilder sb = new StringBuilder();
if (isSopSpecImplementationIncomplete()) {
sb.append('~');
}
sb.append(getSopSpecRevisionName());
if (getSopSpecImplementationRemarks() != null) {
sb.append('\n')
.append('\n')
.append(getSopSpecImplementationRemarks());
}
return sb.toString();
}
/**
* Return the version number of the latest targeted SOP spec revision.
*
* @return SOP spec revision number
*/
int getSopSpecRevisionNumber();
/**
* Return the name of the latest targeted revision of the SOP spec.
*
* @return SOP spec revision string
*/
default String getSopSpecRevisionName() {
return "draft-dkg-openpgp-stateless-cli-" + String.format("%02d", getSopSpecRevisionNumber());
}
/**
* Return <pre>true</pre>, if this implementation of the SOP spec is known to be incomplete or defective.
*
* @return true if incomplete, false otherwise
*/
boolean isSopSpecImplementationIncomplete();
/**
* Return free-form text containing remarks about the completeness of the SOP implementation.
* If there are no remarks, this method returns <pre>null</pre>.
*
* @return remarks or null
*/
String getSopSpecImplementationRemarks();
}

9
sop-java/src/main/java/sop/operation/package-info.java
View file

@ -1,9 +0,0 @@
// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
/**
* Stateless OpenPGP Interface for Java.
* Different cryptographic operations.
*/
package sop.operation;

100
sop-java/src/main/kotlin/sop/operation/Version.kt Normal file
View file

@ -0,0 +1,100 @@
// SPDX-FileCopyrightText: 2023 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0
package sop.operation
interface Version {
/**
* Return the implementations name. e.g. `SOP`,
*
* @return implementation name
*/
fun getName(): String
/**
* Return the implementations short version string. e.g. `1.0`
*
* @return version string
*/
fun getVersion(): String
/**
* Return version information about the used OpenPGP backend. e.g. `Bouncycastle 1.70`
*
* @return backend version string
*/
fun getBackendVersion(): String
/**
* Return an extended version string containing multiple lines of version information. The first
* line MUST match the information produced by [getName] and [getVersion], but the rest of the
* text has no defined structure. Example:
* ```
* "SOP 1.0
* Awesome PGP!
* Using Bouncycastle 1.70
* LibFoo 1.2.2
* See https://pgp.example.org/sop/ for more information"
* ```
*
* @return extended version string
*/
fun getExtendedVersion(): String
/**
* Return the revision of the SOP specification that this implementation is implementing, for
* example, `draft-dkg-openpgp-stateless-cli-06`. If the implementation targets a specific draft
* but the implementer knows the implementation is incomplete, it should prefix the draft title
* with a `~` (TILDE, U+007E), for example: `~draft-dkg-openpgp-stateless-cli-06`. The
* implementation MAY emit additional text about its relationship to the targeted draft on the
* lines following the versioned title.
*
* @return implemented SOP spec version
*/
fun getSopSpecVersion(): String {
return buildString {
if (isSopSpecImplementationIncomplete()) append('~')
append(getSopSpecRevisionName())
if (getSopSpecImplementationRemarks() != null) {
append('\n')
append('\n')
append(getSopSpecImplementationRemarks())
}
}
}
/**
* Return the version number of the latest targeted SOP spec revision.
*
* @return SOP spec revision number
*/
fun getSopSpecRevisionNumber(): Int
/**
* Return the name of the latest targeted revision of the SOP spec.
*
* @return SOP spec revision string
*/
fun getSopSpecRevisionName(): String = buildString {
append("draft-dkg-openpgp-stateless-cli-")
append(String.format("%02d", getSopSpecRevisionNumber()))
}
/**
* Return <pre>true</pre>, if this implementation of the SOP spec is known to be incomplete or
* defective.
*
* @return true if incomplete, false otherwise
*/
fun isSopSpecImplementationIncomplete(): Boolean
/**
* Return free-form text containing remarks about the completeness of the SOP implementation. If
* there are no remarks, this method returns <pre>null</pre>.
*
* @return remarks or null
*/
fun getSopSpecImplementationRemarks(): String?
}