From bb79b44e7f9ecd7f0c8d646df14ab63091b9b85a Mon Sep 17 00:00:00 2001 From: Vincent Date: Sun, 15 Nov 2015 20:33:47 +0100 Subject: add documentation on marker packet skipping --- .../openpgp/jcajce/JcaSkipMarkerPGPObjectFactory.java | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'OpenKeychain/src/main/java') 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) { -- cgit v1.2.3