Modifier and Type	Class and Description
private static class	BCPGInputStream.PartialInputStream a stream that overlays our input stream, allowing the user to only read a segment of it.

Modifier and Type	Field and Description
pack-priv InputStream	in
pack-priv boolean	mNext
pack-priv int	mNextB
pack-priv boolean	next
pack-priv int	nextB

Access	Constructor and Description
public	BCPGInputStream(InputStream in)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
public void	close() Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Closes this input stream and releases any system resources associated with the stream.
public synchronized void	mark(int the maximum limit of bytes that can be read before the mark position becomes invalid. readLimit) Overrides java.io.InputStream.mark. Marks the current position in this input stream.
public boolean	markSupported() Overrides java.io.InputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods.
public int	Returns: the `tag number`. nextPacketTag() Obtains the tag of the next packet in the stream.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] the buffer into which the data is read. buf, int the start offset in array `b` at which the data is written. off, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public byte[]	readAll()
public void	readFully(byte[] buf, int off, int len)
public void	readFully(byte[] buf)
public Packet	readPacket() Reads the next packet from the stream.
public synchronized void	reset() Overrides java.io.InputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.
public int	Returns: the tag for the next non-marker/padding packet skipMarkerAndPaddingPackets() skip any marker and padding packets found in the stream.
public int	Returns: the tag for the next non-marker/padding packet skipMarkerPackets() Deprecated use skipMarkerAndPaddingPackets
public static BCPGInputStream	Returns: BCPGInputStream wrap(InputStream input stream in) If the argument is a `BCPGInputStream`, return it.

Inherited from java.io.InputStream:: nullInputStream read readAllBytes readNBytes readNBytes skip skipNBytes transferTo

Field Detail

in	back to summary
pack-priv InputStream in

mNext	back to summary
pack-priv boolean mNext

mNextB	back to summary
pack-priv int mNextB

next	back to summary
pack-priv boolean next

nextB	back to summary
pack-priv int nextB

Constructor Detail

BCPGInputStream	back to summary
public BCPGInputStream(InputStream in)

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Note that while some implementations of InputStream will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Exceptions

IOException:: if an I/O error occurs.

close	back to summary
public void close() throws IOException Overrides java.io.InputStream.close. Implements java.io.Closeable.close. Doc from java.io.InputStream.close. Closes this input stream and releases any system resources associated with the stream. Exceptions IOException: if an I/O error occurs.

back to summary

public void close() throws IOException

Overrides java.io.InputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.InputStream.close.

Closes this input stream and releases any system resources associated with the stream.

Exceptions

IOException:: if an I/O error occurs.

mark back to summary

mark	back to summary
public synchronized void mark(int readLimit) Overrides java.io.InputStream.mark. Doc from java.io.InputStream.mark. Marks the current position in this input stream. A subsequent call to the `reset` method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The `readlimit` arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated. The general contract of `mark` is that, if the method `markSupported` returns `true`, the stream somehow remembers all the bytes read after the call to `mark` and stands ready to supply those same bytes again if and whenever the method `reset` is called. However, the stream is not required to remember any data at all if more than `readlimit` bytes are read from the stream before `reset` is called. Marking a closed stream should not have any effect on the stream. Parameters readLimit:int the maximum limit of bytes that can be read before the mark position becomes invalid.

public synchronized void mark(int readLimit)

Overrides java.io.InputStream.mark.

Doc from java.io.InputStream.mark.

Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes.

The readlimit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than readlimit bytes are read from the stream before reset is called.

Marking a closed stream should not have any effect on the stream.

Parameters

readLimit:int: the maximum limit of bytes that can be read before the mark position becomes invalid.

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.InputStream.markSupported. Doc from java.io.InputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods. Whether or not `mark` and `reset` are supported is an invariant property of a particular input stream instance. Returns:boolean `true` if this stream instance supports the mark and reset methods; `false` otherwise.

public boolean markSupported()

Overrides java.io.InputStream.markSupported.

Doc from java.io.InputStream.markSupported.

Tests if this input stream supports the mark and reset methods. Whether or not mark and reset are supported is an invariant property of a particular input stream instance.

Returns:boolean: true if this stream instance supports the mark and reset methods; false otherwise.

nextPacketTag back to summary

nextPacketTag	back to summary
public int nextPacketTag() throws IOException Obtains the tag of the next packet in the stream. Returns:int the `tag number`. Exceptions IOException: if an error occurs reading the tag from the stream.

public int nextPacketTag() throws IOException

Obtains the tag of the next packet in the stream.

Returns:int

the tag number.

Exceptions

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

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] buf, int off, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters buf:byte[] the buffer into which the data is read. off:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

buf:byte[]: the buffer into which the data is read.
off:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

readAll	back to summary
public byte[] readAll() throws IOException

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

readFully	back to summary
public void readFully(byte[] buf) throws IOException

readPacket	back to summary
public Packet readPacket() throws IOException Reads the next packet from the stream.

reset back to summary

reset	back to summary
public synchronized void reset() throws IOException Overrides java.io.InputStream.reset. Doc from java.io.InputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream. The general contract of `reset` is: If the method `markSupported` returns `true`, then: If the method `mark` has not been called since the stream was created, or the number of bytes read from the stream since `mark` was last called is larger than the argument to `mark` at that last call, then an `IOException` might be thrown. If such an `IOException` is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to `mark` (or since the start of the file, if `mark` has not been called) will be resupplied to subsequent callers of the `read` method, followed by any bytes that otherwise would have been the next input data as of the time of the call to `reset`. If the method `markSupported` returns `false`, then: The call to `reset` may throw an `IOException`. If an `IOException` is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the `read` method depend on the particular type of the input stream. Exceptions IOException: if this stream has not been marked or if the mark has been invalidated.

public synchronized void reset() throws IOException

Overrides java.io.InputStream.reset.

Doc from java.io.InputStream.reset.

Repositions this stream to the position at the time the mark method was last called on this input stream.

The general contract of reset is:

If the method markSupported returns true, then:
- If the method mark has not been called since the stream was created, or the number of bytes read from the stream since mark was last called is larger than the argument to mark at that last call, then an IOException might be thrown.
- If such an IOException is not thrown, then the stream is reset to a state such that all the bytes read since the most recent call to mark (or since the start of the file, if mark has not been called) will be resupplied to subsequent callers of the read method, followed by any bytes that otherwise would have been the next input data as of the time of the call to reset.
If the method markSupported returns false, then:
- The call to reset may throw an IOException.
- If an IOException is not thrown, then the stream is reset to a fixed state that depends on the particular type of the input stream and how it was created. The bytes that will be supplied to subsequent callers of the read method depend on the particular type of the input stream.

Exceptions

IOException:: if this stream has not been marked or if the mark has been invalidated.

skipMarkerAndPaddingPackets	back to summary
public int skipMarkerAndPaddingPackets() throws IOException skip any marker and padding packets found in the stream. Returns:int the tag for the next non-marker/padding packet Exceptions IOException: on a parsing issue.

skipMarkerAndPaddingPackets

back to summary

public int skipMarkerAndPaddingPackets() throws IOException

skip any marker and padding packets found in the stream.

Returns:int

the tag for the next non-marker/padding packet

Exceptions

IOException:: on a parsing issue.

skipMarkerPackets	back to summary
public int skipMarkerPackets() throws IOException Deprecated use skipMarkerAndPaddingPackets Returns:int the tag for the next non-marker/padding packet Exceptions IOException: on a parsing issue.

wrap back to summary

wrap	back to summary
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:InputStream input stream Returns:BCPGInputStream BCPGInputStream

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:InputStream: input stream

Returns:BCPGInputStream

BCPGInputStream

org.bouncycastle.bcpg back to summary

private Class BCPGInputStream.PartialInputStream

Class Inheritance

extends InputStream

java.lang.Object
java.io.InputStream
org.bouncycastle.bcpg.BCPGInputStream.PartialInputStream

a stream that overlays our input stream, allowing the user to only read a segment of it.

Note

dataLength will be negative if the segment length is in the upper range above 2**31.

Field Summary

Modifier and Type	Field and Description
private int	dataLength
private BCPGInputStream	in
private boolean	partial

Constructor Summary

Access	Constructor and Description
pack-priv	PartialInputStream(BCPGInputStream in, boolean partial, int dataLength)

Method Summary

Modifier and Type	Method and Description
public int	available() Overrides java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected.
private int	loadDataLength()
public int	read(byte[] the buffer into which the data is read. buf, int the start offset in array `b` at which the data is written. offset, int the maximum number of bytes to read. len) Overrides java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes.
public int	read() Implements abstract java.io.InputStream.read. Reads the next byte of data from the input stream.

Inherited from java.io.InputStream:: close mark markSupported nullInputStream read readAllBytes readNBytes readNBytes reset skip skipNBytes transferTo

Field Detail

dataLength	back to summary
private int dataLength

in	back to summary
private BCPGInputStream in

partial	back to summary
private boolean partial

Constructor Detail

PartialInputStream	back to summary
pack-priv PartialInputStream(BCPGInputStream in, boolean partial, int dataLength)

Method Detail

available back to summary

available	back to summary
public int available() throws IOException Overrides java.io.InputStream.available. Doc from java.io.InputStream.available. Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking, which may be 0, or 0 when end of stream is detected. The read might be on the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes. Note that while some implementations of `InputStream` will return the total number of bytes in the stream, many will not. It is never correct to use the return value of this method to allocate a buffer intended to hold all data in this stream. A subclass's implementation of this method may choose to throw an `IOException` if this input stream has been closed by invoking the `close()` method. Returns:int an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or `0` when it reaches the end of the input stream. Exceptions IOException: if an I/O error occurs.

public int available() throws IOException

Overrides java.io.InputStream.available.

Doc from java.io.InputStream.available.

A subclass's implementation of this method may choose to throw an IOException if this input stream has been closed by invoking the close() method.

Returns:int

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Exceptions

IOException:: if an I/O error occurs.

loadDataLength	back to summary
private int loadDataLength() throws IOException

read back to summary

read	back to summary
public int read(byte[] buf, int offset, int len) throws IOException Overrides java.io.InputStream.read. Doc from java.io.InputStream.read. Reads up to `len` bytes of data from the input stream into an array of bytes. An attempt is made to read as many as `len` bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer. This method blocks until input data is available, end of file is detected, or an exception is thrown. If `len` is zero, then no bytes are read and `0` is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value `-1` is returned; otherwise, at least one byte is read and stored into `b`. The first byte read is stored into element `b[off]`, the next one into `b[off+1]`, and so on. The number of bytes read is, at most, equal to `len`. Let k be the number of bytes actually read; these bytes will be stored in elements `b[off]` through `b[off+`k`-1]`, leaving elements `b[off+`k`]` through `b[off+len-1]` unaffected. In every case, elements `b[0]` through `b[off-1]` and elements `b[off+len]` through `b[b.length-1]` are unaffected. Parameters buf:byte[] the buffer into which the data is read. offset:int the start offset in array `b` at which the data is written. len:int the maximum number of bytes to read. Returns:int the total number of bytes read into the buffer, or `-1` if there is no more data because the end of the stream has been reached. Exceptions IOException: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

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

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters

buf:byte[]: the buffer into which the data is read.
offset:int: the start offset in array b at which the data is written.
len:int: the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Exceptions

IOException:: If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

read back to summary

read	back to summary
public int read() throws IOException Implements abstract java.io.InputStream.read. Doc from java.io.InputStream.read. Reads the next byte of data from the input stream. The value byte is returned as an `int` in the range `0` to `255`. If no byte is available because the end of the stream has been reached, the value `-1` is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown. Returns:int the next byte of data, or `-1` if the end of the stream is reached. Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Exceptions

IOException:: if an I/O error occurs.

public Class BCPGInputStream

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BCPGInputStream.PartialInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail