summaryrefslogtreecommitdiff
path: root/bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java
diff options
context:
space:
mode:
Diffstat (limited to 'bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java')
-rw-r--r--bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java19
1 files changed, 19 insertions, 0 deletions
diff --git a/bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java b/bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java
index 1c7132e5..77a3049d 100644
--- a/bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java
+++ b/bcprov/src/main/java/org/bouncycastle/asn1/BEROctetStringParser.java
@@ -5,6 +5,9 @@ import java.io.InputStream;
import org.bouncycastle.util.io.Streams;
+/**
+ * A parser for indefinite-length OCTET STRINGs.
+ */
public class BEROctetStringParser
implements ASN1OctetStringParser
{
@@ -16,17 +19,33 @@ public class BEROctetStringParser
_parser = parser;
}
+ /**
+ * Return an InputStream representing the contents of the OCTET STRING.
+ *
+ * @return an InputStream with its source as the OCTET STRING content.
+ */
public InputStream getOctetStream()
{
return new ConstructedOctetStream(_parser);
}
+ /**
+ * Return an in-memory, encodable, representation of the OCTET STRING.
+ *
+ * @return a BEROctetString.
+ * @throws IOException if there is an issue loading the data.
+ */
public ASN1Primitive getLoadedObject()
throws IOException
{
return new BEROctetString(Streams.readAll(getOctetStream()));
}
+ /**
+ * Return an BEROctetString representing this parser and its contents.
+ *
+ * @return an BEROctetString
+ */
public ASN1Primitive toASN1Primitive()
{
try