From 990d3147092e0b21a70804a269e15f14374b885b Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Thu, 19 Jan 2023 17:29:29 +0100 Subject: [PATCH] Add javadoc comments on top of external sop operations --- external-sop/src/main/java/sop/external/ExternalSOP.java | 3 +++ .../src/main/java/sop/external/operation/ArmorExternal.java | 3 +++ .../src/main/java/sop/external/operation/DearmorExternal.java | 3 +++ .../src/main/java/sop/external/operation/DecryptExternal.java | 3 +++ .../main/java/sop/external/operation/DetachedSignExternal.java | 3 +++ .../java/sop/external/operation/DetachedVerifyExternal.java | 3 +++ .../src/main/java/sop/external/operation/EncryptExternal.java | 3 +++ .../main/java/sop/external/operation/ExtractCertExternal.java | 3 +++ .../main/java/sop/external/operation/GenerateKeyExternal.java | 3 +++ .../main/java/sop/external/operation/InlineDetachExternal.java | 3 +++ .../main/java/sop/external/operation/InlineSignExternal.java | 3 +++ .../main/java/sop/external/operation/InlineVerifyExternal.java | 3 +++ .../src/main/java/sop/external/operation/VersionExternal.java | 3 +++ 13 files changed, 39 insertions(+) diff --git a/external-sop/src/main/java/sop/external/ExternalSOP.java b/external-sop/src/main/java/sop/external/ExternalSOP.java index 555c856..b18e438 100644 --- a/external-sop/src/main/java/sop/external/ExternalSOP.java +++ b/external-sop/src/main/java/sop/external/ExternalSOP.java @@ -43,6 +43,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link SOP} API using an external SOP binary. + */ public class ExternalSOP implements SOP { private final String binaryName; diff --git a/external-sop/src/main/java/sop/external/operation/ArmorExternal.java b/external-sop/src/main/java/sop/external/operation/ArmorExternal.java index 68edc23..bf9ddcd 100644 --- a/external-sop/src/main/java/sop/external/operation/ArmorExternal.java +++ b/external-sop/src/main/java/sop/external/operation/ArmorExternal.java @@ -16,6 +16,9 @@ import java.util.ArrayList; import java.util.Properties; import java.util.List; +/** + * Implementation of the {@link Armor} operation using an external SOP binary. + */ public class ArmorExternal implements Armor { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/DearmorExternal.java b/external-sop/src/main/java/sop/external/operation/DearmorExternal.java index 11e0322..2406131 100644 --- a/external-sop/src/main/java/sop/external/operation/DearmorExternal.java +++ b/external-sop/src/main/java/sop/external/operation/DearmorExternal.java @@ -15,6 +15,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link Dearmor} operation using an external SOP binary. + */ public class DearmorExternal implements Dearmor { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/DecryptExternal.java b/external-sop/src/main/java/sop/external/operation/DecryptExternal.java index b90e657..84da064 100644 --- a/external-sop/src/main/java/sop/external/operation/DecryptExternal.java +++ b/external-sop/src/main/java/sop/external/operation/DecryptExternal.java @@ -25,6 +25,9 @@ import java.util.Date; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link Decrypt} operation using an external SOP binary. + */ public class DecryptExternal implements Decrypt { private final ExternalSOP.TempDirProvider tempDirProvider; diff --git a/external-sop/src/main/java/sop/external/operation/DetachedSignExternal.java b/external-sop/src/main/java/sop/external/operation/DetachedSignExternal.java index e48bfa0..3deabb2 100644 --- a/external-sop/src/main/java/sop/external/operation/DetachedSignExternal.java +++ b/external-sop/src/main/java/sop/external/operation/DetachedSignExternal.java @@ -23,6 +23,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link DetachedSign} operation using an external SOP binary. + */ public class DetachedSignExternal implements DetachedSign { private final ExternalSOP.TempDirProvider tempDirProvider; diff --git a/external-sop/src/main/java/sop/external/operation/DetachedVerifyExternal.java b/external-sop/src/main/java/sop/external/operation/DetachedVerifyExternal.java index d95c9dc..ed658c7 100644 --- a/external-sop/src/main/java/sop/external/operation/DetachedVerifyExternal.java +++ b/external-sop/src/main/java/sop/external/operation/DetachedVerifyExternal.java @@ -23,6 +23,9 @@ import java.util.List; import java.util.Properties; import java.util.Set; +/** + * Implementation of the {@link DetachedVerify} operation using an external SOP binary. + */ public class DetachedVerifyExternal implements DetachedVerify { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/EncryptExternal.java b/external-sop/src/main/java/sop/external/operation/EncryptExternal.java index 7096842..f45cd12 100644 --- a/external-sop/src/main/java/sop/external/operation/EncryptExternal.java +++ b/external-sop/src/main/java/sop/external/operation/EncryptExternal.java @@ -16,6 +16,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link Encrypt} operation using an external SOP binary. + */ public class EncryptExternal implements Encrypt { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/ExtractCertExternal.java b/external-sop/src/main/java/sop/external/operation/ExtractCertExternal.java index 68d0750..549b1ad 100644 --- a/external-sop/src/main/java/sop/external/operation/ExtractCertExternal.java +++ b/external-sop/src/main/java/sop/external/operation/ExtractCertExternal.java @@ -14,6 +14,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link ExtractCert} operation using an external SOP binary. + */ public class ExtractCertExternal implements ExtractCert { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/GenerateKeyExternal.java b/external-sop/src/main/java/sop/external/operation/GenerateKeyExternal.java index b348fa4..d125fc0 100644 --- a/external-sop/src/main/java/sop/external/operation/GenerateKeyExternal.java +++ b/external-sop/src/main/java/sop/external/operation/GenerateKeyExternal.java @@ -13,6 +13,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link GenerateKey} operation using an external SOP binary. + */ public class GenerateKeyExternal implements GenerateKey { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/InlineDetachExternal.java b/external-sop/src/main/java/sop/external/operation/InlineDetachExternal.java index 0ed3e18..c03fe1b 100644 --- a/external-sop/src/main/java/sop/external/operation/InlineDetachExternal.java +++ b/external-sop/src/main/java/sop/external/operation/InlineDetachExternal.java @@ -20,6 +20,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link InlineDetach} operation using an external SOP binary. + */ public class InlineDetachExternal implements InlineDetach { private final ExternalSOP.TempDirProvider tempDirProvider; diff --git a/external-sop/src/main/java/sop/external/operation/InlineSignExternal.java b/external-sop/src/main/java/sop/external/operation/InlineSignExternal.java index 2a49ad5..17e5b12 100644 --- a/external-sop/src/main/java/sop/external/operation/InlineSignExternal.java +++ b/external-sop/src/main/java/sop/external/operation/InlineSignExternal.java @@ -16,6 +16,9 @@ import java.util.ArrayList; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link InlineSign} operation using an external SOP binary. + */ public class InlineSignExternal implements InlineSign { private final List commandList = new ArrayList<>(); diff --git a/external-sop/src/main/java/sop/external/operation/InlineVerifyExternal.java b/external-sop/src/main/java/sop/external/operation/InlineVerifyExternal.java index 17e3ff9..5fbdde6 100644 --- a/external-sop/src/main/java/sop/external/operation/InlineVerifyExternal.java +++ b/external-sop/src/main/java/sop/external/operation/InlineVerifyExternal.java @@ -23,6 +23,9 @@ import java.util.Date; import java.util.List; import java.util.Properties; +/** + * Implementation of the {@link InlineVerify} operation using an external SOP binary. + */ public class InlineVerifyExternal implements InlineVerify { private final ExternalSOP.TempDirProvider tempDirProvider; diff --git a/external-sop/src/main/java/sop/external/operation/VersionExternal.java b/external-sop/src/main/java/sop/external/operation/VersionExternal.java index 447078a..6848cab 100644 --- a/external-sop/src/main/java/sop/external/operation/VersionExternal.java +++ b/external-sop/src/main/java/sop/external/operation/VersionExternal.java @@ -12,6 +12,9 @@ import java.io.IOException; import java.io.InputStreamReader; import java.util.Properties; +/** + * Implementation of the {@link Version} operation using an external SOP binary. + */ public class VersionExternal implements Version { private final Runtime runtime = Runtime.getRuntime();