JGit 7.2.0.202503040940-r · org.eclipse.jgit.internal.storage.io.CancellableDigestOutputStream

Field Summary

Modifier and Type	Field and Description
public static final int	BYTES_TO_WRITE_BEFORE_CANCEL_CHECK The OutputStream checks every this value for cancellation
private long	checkCancelAt
private long	count
private final MessageDigest	md
private final OutputStream	out
private final ProgressMonitor	writeMonitor

Constructor Summary

Access	Constructor and Description
public	CancellableDigestOutputStream(ProgressMonitor monitor to update on output progress and check cancel. writeMonitor, OutputStream target stream to receive all contents. out) Initialize a CancellableDigestOutputStream.

Method Summary

Modifier and Type	Method and Description
public void	flush() Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Flushes this output stream and forces any buffered output bytes to be written out.
public final byte[]	Returns: SHA-1 digest getDigest() Obtain the current SHA-1 digest.
public final ProgressMonitor	Returns: the monitor getWriteMonitor() Get the monitor which is used to update on output progress and check cancel.
public final long	Returns: total number of bytes written since stream start. length() Get total number of bytes written since stream start.
public final void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public final void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited from java.io.OutputStream:: close nullOutputStream write

Field Detail

BYTES_TO_WRITE_BEFORE_CANCEL_CHECK	back to summary
public static final int BYTES_TO_WRITE_BEFORE_CANCEL_CHECK The OutputStream checks every this value for cancellation

checkCancelAt	back to summary
private long checkCancelAt

count	back to summary
private long count

md	back to summary
private final MessageDigest md

out	back to summary
private final OutputStream out

writeMonitor	back to summary
private final ProgressMonitor writeMonitor

Constructor Detail

CancellableDigestOutputStream	back to summary
public CancellableDigestOutputStream(ProgressMonitor writeMonitor, OutputStream out) Initialize a CancellableDigestOutputStream. Parameters writeMonitor:ProgressMonitor monitor to update on output progress and check cancel. out:OutputStream target stream to receive all contents.

CancellableDigestOutputStream

back to summary

public CancellableDigestOutputStream(ProgressMonitor writeMonitor, OutputStream out)

Initialize a CancellableDigestOutputStream.

Parameters

writeMonitor:ProgressMonitor: monitor to update on output progress and check cancel.
out:OutputStream: target stream to receive all contents.

Method Detail

flush back to summary

flush	back to summary
public void flush() throws IOException Overrides java.io.OutputStream.flush. Implements java.io.Flushable.flush. Doc from java.io.OutputStream.flush. Flushes this output stream and forces any buffered output bytes to be written out. The general contract of `flush` is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination. If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void flush() throws IOException

Overrides java.io.OutputStream.flush.

Implements java.io.Flushable.flush.

Doc from java.io.OutputStream.flush.

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

If the intended destination of this stream is an abstraction provided by the underlying operating system, for example a file, then flushing the stream guarantees only that bytes previously written to the stream are passed to the operating system for writing; it does not guarantee that they are actually written to a physical device such as a disk drive.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

getDigest	back to summary
public final byte[] getDigest() Obtain the current SHA-1 digest. Returns:byte[] SHA-1 digest

getDigest

back to summary

public final byte[] getDigest()

Obtain the current SHA-1 digest.

Returns:byte[]: SHA-1 digest

getWriteMonitor	back to summary
public final ProgressMonitor getWriteMonitor() Get the monitor which is used to update on output progress and check cancel. Returns:ProgressMonitor the monitor

getWriteMonitor

back to summary

public final ProgressMonitor getWriteMonitor()

Get the monitor which is used to update on output progress and check cancel.

Returns:ProgressMonitor: the monitor

length	back to summary
public final long length() Get total number of bytes written since stream start. Returns:long total number of bytes written since stream start.

length

back to summary

public final long length()

Get total number of bytes written since stream start.

Returns:long: total number of bytes written since stream start.

write back to summary

write	back to summary
public final void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public final void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public final void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public final void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

public Class CancellableDigestOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail