Package org.bouncycastle.bcpg

Class BCPGInputStream

java.lang.Object

java.io.InputStream

org.bouncycastle.bcpg.BCPGInputStream

All Implemented Interfaces:

Closeable, AutoCloseable, PacketTags

public class BCPGInputStream
extends InputStream
implements PacketTags

Stream reader for PGP objects

Field Summary

Fields inherited from interface org.bouncycastle.bcpg.PacketTags

AEAD_ENC_DATA, COMPRESSED_DATA, EXPERIMENTAL_1, EXPERIMENTAL_2, EXPERIMENTAL_3, EXPERIMENTAL_4, LITERAL_DATA, MARKER, MOD_DETECTION_CODE, ONE_PASS_SIGNATURE, PADDING, PUBLIC_KEY, PUBLIC_KEY_ENC_SESSION, PUBLIC_SUBKEY, RESERVED, SECRET_KEY, SECRET_SUBKEY, SIGNATURE, SYM_ENC_INTEGRITY_PRO, SYMMETRIC_KEY_ENC, SYMMETRIC_KEY_ENC_SESSION, TRUST, USER_ATTRIBUTE, USER_ID

Constructor Summary

Constructors

Constructor	Description
BCPGInputStream(InputStream in)

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	mark(int readLimit)
boolean	markSupported()
int	nextPacketTag()	Obtains the tag of the next packet in the stream.
int	read()
int	read(byte[] buf, int off, int len)
byte[]	readAll()
void	readFully(byte[] buf)
void	readFully(byte[] buf, int off, int len)
Packet	readPacket()	Reads the next packet from the stream.
void	reset()
int	skipMarkerAndPaddingPackets()	skip any marker and padding packets found in the stream.
int	skipMarkerPackets()	Deprecated. use skipMarkerAndPaddingPackets
static BCPGInputStream	wrap(InputStream in)	If the argument is a BCPGInputStream, return it.

Methods inherited from class java.io.InputStream

nullInputStream, read, readAllBytes, readNBytes, readNBytes, skip, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

BCPGInputStream

public BCPGInputStream(InputStream in)

Method Details

wrap

public static BCPGInputStream wrap(InputStream in)

If the argument is a BCPGInputStream, return it. Otherwise wrap it in a BCPGInputStream and then return the result.

Parameters:

in - input stream

Returns:

BCPGInputStream

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

mark

public void mark(int readLimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] buf,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

readFully

public void readFully(byte[] buf,
 int off,
 int len)
               throws IOException

Throws:

IOException

readAll

public byte[] readAll()
               throws IOException

Throws:

IOException

readFully

public void readFully(byte[] buf)
               throws IOException

Throws:

IOException

nextPacketTag

public int nextPacketTag()
                  throws IOException

Obtains the tag of the next packet in the stream.

Returns:

the tag number.

Throws:

IOException - if an error occurs reading the tag from the stream.

readPacket

public Packet readPacket()
                  throws IOException

Reads the next packet from the stream.

Throws:

IOException

skipMarkerPackets

public int skipMarkerPackets()
                      throws IOException

Deprecated.

use skipMarkerAndPaddingPackets

Returns:

the tag for the next non-marker/padding packet

Throws:

IOException - on a parsing issue.

skipMarkerAndPaddingPackets

public int skipMarkerAndPaddingPackets()
                                throws IOException

skip any marker and padding packets found in the stream.

Returns:

the tag for the next non-marker/padding packet

Throws:

IOException - on a parsing issue.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException