diff options
| author | Vincent Breitmoser <valodim@mugenguild.com> | 2014-05-31 13:10:41 +0200 |
|---|---|---|
| committer | Vincent Breitmoser <valodim@mugenguild.com> | 2014-06-02 13:49:11 +0200 |
| commit | 58edc0af674f273578a76febd9dfaad95e3380f9 (patch) | |
| tree | 4bd3d8f10331a0037fe170f1c288fdeb57d8977d /OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java | |
| parent | d891f753393d26bbf3c1f766deddf71f6c9ce5ae (diff) | |
| download | open-keychain-58edc0af674f273578a76febd9dfaad95e3380f9.tar.gz open-keychain-58edc0af674f273578a76febd9dfaad95e3380f9.tar.bz2 open-keychain-58edc0af674f273578a76febd9dfaad95e3380f9.zip | |
wrapped-key-ring: add documentation
Diffstat (limited to 'OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java')
| -rw-r--r-- | OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java index cfbad89b7..dc0c722b9 100644 --- a/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java +++ b/OpenKeychain/src/main/java/org/sufficientlysecure/keychain/pgp/KeyRing.java @@ -2,6 +2,17 @@ package org.sufficientlysecure.keychain.pgp; import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralException; +/** An abstract KeyRing. + * + * This is an abstract class for all KeyRing constructs. It serves as a common + * denominator of available information, two implementations wrapping the same + * keyring should in all cases agree on the output of all methods described + * here. + * + * @see org.sufficientlysecure.keychain.pgp.WrappedKeyRing + * @see org.sufficientlysecure.keychain.provider.CachedPublicKeyRing + * + */ public abstract class KeyRing { abstract public long getMasterKeyId() throws PgpGeneralException; |