summaryrefslogtreecommitdiffstats
path: root/bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java
diff options
context:
space:
mode:
Diffstat (limited to 'bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java')
-rw-r--r--bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java10
1 files changed, 10 insertions, 0 deletions
diff --git a/bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java b/bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java
index b18b550..933da6a 100644
--- a/bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java
+++ b/bcprov/src/main/java/org/bouncycastle/util/io/pem/PemObjectParser.java
@@ -2,8 +2,18 @@ package org.bouncycastle.util.io.pem;
import java.io.IOException;
+/**
+ * Base interface for parsers to convert PEM objects into specific objects.
+ */
public interface PemObjectParser
{
+ /**
+ * Parse an object out of the PEM object passed in.
+ *
+ * @param obj the PEM object containing the details for the specific object.
+ * @return a specific object represented by the PEM object.
+ * @throws IOException on a parsing error.
+ */
Object parseObject(PemObject obj)
throws IOException;
}