Jakarta EE 11.0.0 · jakarta.servlet.http.NoBodyOutputStream

Modifier and Type	Field and Description
private int	contentLength
pack-priv static ThreadLocal<Boolean>	disableFlush
private static final String	LSTRING_FILE Hides jakarta.servlet.ServletOutputStream.LSTRING_FILE.
private static final ResourceBundle	lStrings Hides jakarta.servlet.ServletOutputStream.lStrings.

Access	Constructor and Description
pack-priv	NoBodyOutputStream()

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.
pack-priv int	getContentLength()
public boolean	isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Returns `true` if it is allowable to call any method that may write data (i.e. `write()`, `print()` `println()` or `flush`).
pack-priv void	reset()
public void	setWriteListener(WriteListener the `WriteListener` that should be notified when it's possible to write writeListener) Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener. Instructs the `ServletOutputStream` to invoke the provided `WriteListener` when it is possible to write
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. buf, int the start offset in the data. offset, 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 jakarta.servlet.ServletOutputStream:: close print print print print print print print println println println println println println println println write

contentLength	back to summary
private int contentLength

disableFlush	back to summary
pack-priv static ThreadLocal<Boolean> disableFlush

LSTRING_FILE	back to summary
private static final String LSTRING_FILE Hides jakarta.servlet.ServletOutputStream.LSTRING_FILE.

lStrings	back to summary
private static final ResourceBundle lStrings Hides jakarta.servlet.ServletOutputStream.lStrings.

NoBodyOutputStream	back to summary
pack-priv NoBodyOutputStream()

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.

getContentLength	back to summary
pack-priv int getContentLength()

isReady back to summary

isReady	back to summary
public boolean isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Doc from jakarta.servlet.ServletOutputStream.isReady. Returns `true` if it is allowable to call any method that may write data (i.e. `write()`, `print()` `println()` or `flush`). In blocking mode, this method will always return `true`, but a subsequent call to a method that writes data may block. In non-blocking mode this method may return `false`, in which case it is illegal to call a method that writes data and an `IllegalStateException` MUST be thrown. When `WriteListener#onWritePossible()` is called, a call to this method that returned `true` is implicit. If this method returns `false` and a `WriteListener` has been set via `setWriteListener(WriteListener)`, then container will subsequently invoke `WriteListener#onWritePossible()` once a write operation becomes possible without blocking. Other than the initial call, `WriteListener#onWritePossible()` will only be called if and only if this method is called and returns false. Returns:boolean `true` if data can be written without blocking, otherwise returns `false`. Annotations @Override

public boolean isReady()

Implements abstract jakarta.servlet.ServletOutputStream.isReady.

Doc from jakarta.servlet.ServletOutputStream.isReady.

Returns true if it is allowable to call any method that may write data (i.e. write(), print() println() or flush). In blocking mode, this method will always return true, but a subsequent call to a method that writes data may block. In non-blocking mode this method may return false, in which case it is illegal to call a method that writes data and an IllegalStateException MUST be thrown. When WriteListener#onWritePossible() is called, a call to this method that returned true is implicit.

If this method returns false and a WriteListener has been set via setWriteListener(WriteListener), then container will subsequently invoke WriteListener#onWritePossible() once a write operation becomes possible without blocking. Other than the initial call, WriteListener#onWritePossible() will only be called if and only if this method is called and returns false.

Returns:boolean

true if data can be written without blocking, otherwise returns false.

Annotations

@Override

reset	back to summary
pack-priv void reset()

setWriteListener back to summary

setWriteListener	back to summary
public void setWriteListener(WriteListener writeListener) Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener. Doc from jakarta.servlet.ServletOutputStream.setWriteListener. Instructs the `ServletOutputStream` to invoke the provided `WriteListener` when it is possible to write Parameters writeListener:WriteListener the `WriteListener` that should be notified when it's possible to write Annotations @Override

public void setWriteListener(WriteListener writeListener)

Implements abstract jakarta.servlet.ServletOutputStream.setWriteListener.

Doc from jakarta.servlet.ServletOutputStream.setWriteListener.

Instructs the ServletOutputStream to invoke the provided WriteListener when it is possible to write

Parameters

writeListener:WriteListener: the WriteListener that should be notified when it's possible to write

Annotations

@Override

write back to summary

write	back to summary
public void write(int b) 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

public void write(int b)

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

write back to summary

write	back to summary
public void write(byte[] buf, int offset, 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 buf:byte[] the data. offset: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 void write(byte[] buf, int offset, 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

buf:byte[]: the data.
offset: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.

pack-priv Class NoBodyOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail