JabRef 6.0-beta.1 · org.jabref.logic.net.ProgressInputStream

Modifier and Type	Field and Description
private final long	maxNumBytes
private final LongProperty	progress
private final LongProperty	totalNumBytesRead

Access	Constructor and Description
public	ProgressInputStream(InputStream in, long maxNumBytes)

Method Summary

Modifier and Type	Method and Description
public long	getMaxNumBytes()
public long	getProgress()
public long	getTotalNumBytesRead()
public void	mark(int readlimit) Overrides java.io.FilterInputStream.mark. Marks the current position in this input stream.
public boolean	markSupported() Overrides java.io.FilterInputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods.
public LongProperty	progressProperty()
public int	read() Overrides java.io.FilterInputStream.read. Reads the next byte of data from the input stream.
public int	read(byte[] b, int off, int len) Overrides java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes.
public void	reset() Overrides java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream.
public long	skip(long n) Overrides java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream.
public LongProperty	totalNumBytesReadProperty()
private long	updateProgress(long numBytesRead)

Inherited from java.io.FilterInputStream:: available close read

maxNumBytes	back to summary
private final long maxNumBytes

progress	back to summary
private final LongProperty progress

totalNumBytesRead	back to summary
private final LongProperty totalNumBytesRead

ProgressInputStream	back to summary
public ProgressInputStream(InputStream in, long maxNumBytes)

Method Detail

getMaxNumBytes	back to summary
public long getMaxNumBytes()

getProgress	back to summary
public long getProgress()

getTotalNumBytesRead	back to summary
public long getTotalNumBytesRead()

mark back to summary

mark	back to summary
public void mark(int readlimit) Overrides java.io.FilterInputStream.mark. Doc from java.io.FilterInputStream.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` argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated. Annotations @Override

public void mark(int readlimit)

Overrides java.io.FilterInputStream.mark.

Doc from java.io.FilterInputStream.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 argument tells this input stream to allow that many bytes to be read before the mark position gets invalidated.

Annotations

@Override

markSupported back to summary

markSupported	back to summary
public boolean markSupported() Overrides java.io.FilterInputStream.markSupported. Doc from java.io.FilterInputStream.markSupported. Tests if this input stream supports the `mark` and `reset` methods. Annotations @Override

public boolean markSupported()

Overrides java.io.FilterInputStream.markSupported.

Doc from java.io.FilterInputStream.markSupported.

Tests if this input stream supports the mark and reset methods.

Annotations

@Override

progressProperty	back to summary
public LongProperty progressProperty()

read back to summary

read	back to summary
public int read() throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.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. Annotations @Override Exceptions IOException: if an I/O error occurs.

public int read() throws IOException

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.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.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

read back to summary

read	back to summary
public int read(byte[] b, int off, int len) throws IOException Overrides java.io.FilterInputStream.read. Doc from java.io.FilterInputStream.read. Reads up to `len` bytes of data from this input stream into an array of bytes. If `len` is not zero, the method blocks until some input is available; otherwise, no bytes are read and `0` is returned. Annotations @Override Exceptions IOException: if an I/O error occurs.

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

Overrides java.io.FilterInputStream.read.

Doc from java.io.FilterInputStream.read.

Reads up to len bytes of data from this input stream into an array of bytes. If len is not zero, the method blocks until some input is available; otherwise, no bytes are read and 0 is returned.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

reset back to summary

reset	back to summary
public void reset() throws IOException Overrides java.io.FilterInputStream.reset. Doc from java.io.FilterInputStream.reset. Repositions this stream to the position at the time the `mark` method was last called on this input stream. Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser. Annotations @Override Exceptions IOException: if this stream has not been marked or if the mark has been invalidated.

public void reset() throws IOException

Overrides java.io.FilterInputStream.reset.

Doc from java.io.FilterInputStream.reset.

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

Stream marks are intended to be used in situations where you need to read ahead a little to see what's in the stream. Often this is most easily done by invoking some general parser. If the stream is of the type handled by the parse, it just chugs along happily. If the stream is not of that type, the parser should toss an exception when it fails. If this happens within readlimit bytes, it allows the outer code to reset the stream and try another parser.

Annotations

@Override

Exceptions

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

skip back to summary

skip	back to summary
public long skip(long n) throws IOException Overrides java.io.FilterInputStream.skip. Doc from java.io.FilterInputStream.skip. Skips over and discards `n` bytes of data from the input stream. The `skip` method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly `0`. The actual number of bytes skipped is returned. Annotations @Override Exceptions IOException: if `in.skip(n)` throws an IOException.

public long skip(long n) throws IOException

Overrides java.io.FilterInputStream.skip.

Doc from java.io.FilterInputStream.skip.

Skips over and discards n bytes of data from the input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. The actual number of bytes skipped is returned.

Annotations

@Override

Exceptions

IOException:: if in.skip(n) throws an IOException.

totalNumBytesReadProperty	back to summary
public LongProperty totalNumBytesReadProperty()

updateProgress	back to summary
private long updateProgress(long numBytesRead)

public Class ProgressInputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail