aboutsummaryrefslogtreecommitdiffstats
path: root/OpenKeychain/src/main/java
diff options
context:
space:
mode:
authorVincent <valodim@mugenguild.com>2015-11-15 20:33:47 +0100
committerVincent <valodim@mugenguild.com>2015-11-15 20:33:47 +0100
commitbb79b44e7f9ecd7f0c8d646df14ab63091b9b85a (patch)
tree3448fb4c30a6a6dea90345621e52e646413310c4 /OpenKeychain/src/main/java
parent827b8e4b94d7494c554aa269c9d2418062f4e95a (diff)
downloadopen-keychain-bb79b44e7f9ecd7f0c8d646df14ab63091b9b85a.tar.gz
open-keychain-bb79b44e7f9ecd7f0c8d646df14ab63091b9b85a.tar.bz2
open-keychain-bb79b44e7f9ecd7f0c8d646df14ab63091b9b85a.zip
add documentation on marker packet skipping
Diffstat (limited to 'OpenKeychain/src/main/java')
-rw-r--r--OpenKeychain/src/main/java/org/spongycastle/openpgp/jcajce/JcaSkipMarkerPGPObjectFactory.java10
1 files changed, 9 insertions, 1 deletions
diff --git a/OpenKeychain/src/main/java/org/spongycastle/openpgp/jcajce/JcaSkipMarkerPGPObjectFactory.java b/OpenKeychain/src/main/java/org/spongycastle/openpgp/jcajce/JcaSkipMarkerPGPObjectFactory.java
index a60c8e499..f1cf9791a 100644
--- a/OpenKeychain/src/main/java/org/spongycastle/openpgp/jcajce/JcaSkipMarkerPGPObjectFactory.java
+++ b/OpenKeychain/src/main/java/org/spongycastle/openpgp/jcajce/JcaSkipMarkerPGPObjectFactory.java
@@ -6,7 +6,15 @@ import java.io.InputStream;
import org.spongycastle.openpgp.PGPMarker;
-
+/** This class wraps the regular PGPObjectFactory, changing its behavior to
+ * ignore all PGPMarker packets it encounters while reading. These packets
+ * carry no semantics of their own, and should be ignored according to
+ * RFC 4880.
+ *
+ * @see https://tools.ietf.org/html/rfc4880#section-5.8
+ * @see org.spongycastle.openpgp.PGPMarker
+ *
+ */
public class JcaSkipMarkerPGPObjectFactory extends JcaPGPObjectFactory {
public JcaSkipMarkerPGPObjectFactory(InputStream in) {