org.bouncycastle.bcpg

Class ArmoredInputStream

java.lang.Object

java.io.InputStream

org.bouncycastle.bcpg.ArmoredInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ArmoredInputStream
extends InputStream

reader for Base64 armored objects - read the headers and then start returning bytes when the data is reached. An IOException is thrown if the CRC check fails.

Constructor Summary

Constructors

Constructor and Description
ArmoredInputStream(InputStream in) Create a stream for reading a PGP armoured message, parsing up to a header and then reading the data that follows.
ArmoredInputStream(InputStream in, boolean hasHeaders) Create an armoured input stream which will assume the data starts straight away, or parse for headers first depending on the value of hasHeaders.

Method Summary

Methods

Modifier and Type	Method and Description
int	available()
void	close()
String	getArmorHeaderLine() Return the armor header line (if there is one)
String[]	getArmorHeaders() Return the armor headers (the lines after the armor header line),
boolean	isClearText()
boolean	isEndOfStream()
int	read()

Methods inherited from class java.io.InputStream

mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArmoredInputStream

public ArmoredInputStream(InputStream in)
                   throws IOException

Create a stream for reading a PGP armoured message, parsing up to a header and then reading the data that follows.

Parameters:

in -

Throws:

IOException

ArmoredInputStream

public ArmoredInputStream(InputStream in,
                  boolean hasHeaders)
                   throws IOException

Create an armoured input stream which will assume the data starts straight away, or parse for headers first depending on the value of hasHeaders.

Parameters:

in -

hasHeaders - true if headers are to be looked for, false otherwise.

Throws:

IOException

Method Detail

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

isClearText

public boolean isClearText()

Returns:

true if we are inside the clear text section of a PGP signed message.

isEndOfStream

public boolean isEndOfStream()

Returns:

true if the stream is actually at end of file.

getArmorHeaderLine

public String getArmorHeaderLine()

Return the armor header line (if there is one)

Returns:

the armor header line, null if none present.

getArmorHeaders

public String[] getArmorHeaders()

Return the armor headers (the lines after the armor header line),

Returns:

an array of armor headers, null if there aren't any.

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException