Jetty 12.0.6 · org.eclipse.jetty.ee10.servlet.util.ServletOutputStreamWrapper

Modifier and Type	Field and Description
private final ServletOutputStream	_outputStream

Access	Constructor and Description
public	ServletOutputStreamWrapper(ServletOutputStream outputStream)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Closes this output stream and releases any system resources associated with this stream.
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 boolean	isReady() Implements abstract jakarta.servlet.ServletOutputStream.isReady. Returns true if data can be written without blocking else returns false.
public static OutputStream	nullOutputStream() Hides java.io.OutputStream.nullOutputStream. Returns a new `OutputStream` which discards all bytes.
public void	print(String the `String` to send to the client s) Overrides jakarta.servlet.ServletOutputStream.print. Writes a `String` to the client, without a carriage return-line feed (CRLF) character at the end.
public void	print(boolean the `boolean` value to send to the client b) Overrides jakarta.servlet.ServletOutputStream.print. Writes a `boolean` value to the client, with no carriage return-line feed (CRLF) character at the end.
public void	print(char the character to send to the client c) Overrides jakarta.servlet.ServletOutputStream.print. Writes a character to the client, with no carriage return-line feed (CRLF) at the end.
public void	print(int the int to send to the client i) Overrides jakarta.servlet.ServletOutputStream.print. Writes an int to the client, with no carriage return-line feed (CRLF) at the end.
public void	print(long the `long` value to send to the client l) Overrides jakarta.servlet.ServletOutputStream.print. Writes a `long` value to the client, with no carriage return-line feed (CRLF) at the end.
public void	print(float the `float` value to send to the client f) Overrides jakarta.servlet.ServletOutputStream.print. Writes a `float` value to the client, with no carriage return-line feed (CRLF) at the end.
public void	print(double the `double` value to send to the client d) Overrides jakarta.servlet.ServletOutputStream.print. Writes a `double` value to the client, with no carriage return-line feed (CRLF) at the end.
public void	println() Overrides jakarta.servlet.ServletOutputStream.println. Writes a carriage return-line feed (CRLF) to the client.
public void	println(String the `String` to write to the client s) Overrides jakarta.servlet.ServletOutputStream.println. Writes a `String` to the client, followed by a carriage return-line feed (CRLF).
public void	println(boolean the `boolean` value to write to the client b) Overrides jakarta.servlet.ServletOutputStream.println. Writes a `boolean` value to the client, followed by a carriage return-line feed (CRLF).
public void	println(char the character to write to the client c) Overrides jakarta.servlet.ServletOutputStream.println. Writes a character to the client, followed by a carriage return-line feed (CRLF).
public void	println(int the int to write to the client i) Overrides jakarta.servlet.ServletOutputStream.println. Writes an int to the client, followed by a carriage return-line feed (CRLF) character.
public void	println(long the `long` value to write to the client l) Overrides jakarta.servlet.ServletOutputStream.println. Writes a `long` value to the client, followed by a carriage return-line feed (CRLF).
public void	println(float the `float` value to write to the client f) Overrides jakarta.servlet.ServletOutputStream.println. Writes a `float` value to the client, followed by a carriage return-line feed (CRLF).
public void	println(double the `double` value to write to the client d) Overrides jakarta.servlet.ServletOutputStream.println. Writes a `double` value to the client, followed by a carriage return-line feed (CRLF).
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. b) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public 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.

_outputStream	back to summary
private final ServletOutputStream _outputStream

ServletOutputStreamWrapper	back to summary
public ServletOutputStreamWrapper(ServletOutputStream outputStream)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Overrides java.io.OutputStream.close. Implements java.io.Closeable.close. Doc from java.io.OutputStream.close. Closes this output stream and releases any system resources associated with this stream. The general contract of `close` is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void close() throws IOException

Overrides java.io.OutputStream.close.

Implements java.io.Closeable.close.

Doc from java.io.OutputStream.close.

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

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.

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 data can be written without blocking else returns false. If this method returns false and a `WriteListener` has been set with `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 data can be written without blocking else returns false.

If this method returns false and a WriteListener has been set with 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

nullOutputStream back to summary

nullOutputStream	back to summary
public static OutputStream nullOutputStream() Hides java.io.OutputStream.nullOutputStream. Doc from java.io.OutputStream.nullOutputStream. Returns a new `OutputStream` which discards all bytes. The returned stream is initially open. The stream is closed by calling the `close()` method. Subsequent calls to `close()` have no effect. While the stream is open, the `write(int)`, `write(byte[])`, and `write(byte[], int, int)` methods do nothing. After the stream has been closed, these methods all throw `IOException`. The `flush()` method does nothing. Returns:OutputStream an `OutputStream` which discards all bytes

public static OutputStream nullOutputStream()

Hides java.io.OutputStream.nullOutputStream.

Doc from java.io.OutputStream.nullOutputStream.

Returns a new OutputStream which discards all bytes. The returned stream is initially open. The stream is closed by calling the close() method. Subsequent calls to close() have no effect.

While the stream is open, the write(int), write(byte[]), and write(byte[], int, int) methods do nothing. After the stream has been closed, these methods all throw IOException.

The flush() method does nothing.

Returns:OutputStream: an OutputStream which discards all bytes

print back to summary

print	back to summary
public void print(String s) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes a `String` to the client, without a carriage return-line feed (CRLF) character at the end. Parameters s:String the `String` to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void print(String s) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes a String to the client, without a carriage return-line feed (CRLF) character at the end.

Parameters

s:String: the String to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(boolean b) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes a `boolean` value to the client, with no carriage return-line feed (CRLF) character at the end. Parameters b:boolean the `boolean` value to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void print(boolean b) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes a boolean value to the client, with no carriage return-line feed (CRLF) character at the end.

Parameters

b:boolean: the boolean value to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

print	back to summary
public void print(char c) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes a character to the client, with no carriage return-line feed (CRLF) at the end. Parameters c:char the character to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

back to summary

public void print(char c) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes a character to the client, with no carriage return-line feed (CRLF) at the end.

Parameters

c:char: the character to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

print	back to summary
public void print(int i) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes an int to the client, with no carriage return-line feed (CRLF) at the end. Parameters i:int the int to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

back to summary

public void print(int i) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes an int to the client, with no carriage return-line feed (CRLF) at the end.

Parameters

i:int: the int to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(long l) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes a `long` value to the client, with no carriage return-line feed (CRLF) at the end. Parameters l:long the `long` value to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void print(long l) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes a long value to the client, with no carriage return-line feed (CRLF) at the end.

Parameters

l:long: the long value to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(float f) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes a `float` value to the client, with no carriage return-line feed (CRLF) at the end. Parameters f:float the `float` value to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void print(float f) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes a float value to the client, with no carriage return-line feed (CRLF) at the end.

Parameters

f:float: the float value to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(double d) throws IOException Overrides jakarta.servlet.ServletOutputStream.print. Doc from jakarta.servlet.ServletOutputStream.print. Writes a `double` value to the client, with no carriage return-line feed (CRLF) at the end. Parameters d:double the `double` value to send to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void print(double d) throws IOException

Overrides jakarta.servlet.ServletOutputStream.print.

Doc from jakarta.servlet.ServletOutputStream.print.

Writes a double value to the client, with no carriage return-line feed (CRLF) at the end.

Parameters

d:double: the double value to send to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println	back to summary
public void println() throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a carriage return-line feed (CRLF) to the client. Annotations @Override Exceptions IOException: if an input or output exception occurred

println

back to summary

public void println() throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a carriage return-line feed (CRLF) to the client.

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(String s) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a `String` to the client, followed by a carriage return-line feed (CRLF). Parameters s:String the `String` to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void println(String s) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a String to the client, followed by a carriage return-line feed (CRLF).

Parameters

s:String: the String to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(boolean b) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a `boolean` value to the client, followed by a carriage return-line feed (CRLF). Parameters b:boolean the `boolean` value to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void println(boolean b) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a boolean value to the client, followed by a carriage return-line feed (CRLF).

Parameters

b:boolean: the boolean value to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println	back to summary
public void println(char c) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a character to the client, followed by a carriage return-line feed (CRLF). Parameters c:char the character to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

println

back to summary

public void println(char c) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a character to the client, followed by a carriage return-line feed (CRLF).

Parameters

c:char: the character to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println	back to summary
public void println(int i) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes an int to the client, followed by a carriage return-line feed (CRLF) character. Parameters i:int the int to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

println

back to summary

public void println(int i) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes an int to the client, followed by a carriage return-line feed (CRLF) character.

Parameters

i:int: the int to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(long l) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a `long` value to the client, followed by a carriage return-line feed (CRLF). Parameters l:long the `long` value to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void println(long l) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a long value to the client, followed by a carriage return-line feed (CRLF).

Parameters

l:long: the long value to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(float f) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a `float` value to the client, followed by a carriage return-line feed (CRLF). Parameters f:float the `float` value to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void println(float f) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a float value to the client, followed by a carriage return-line feed (CRLF).

Parameters

f:float: the float value to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(double d) throws IOException Overrides jakarta.servlet.ServletOutputStream.println. Doc from jakarta.servlet.ServletOutputStream.println. Writes a `double` value to the client, followed by a carriage return-line feed (CRLF). Parameters d:double the `double` value to write to the client Annotations @Override Exceptions IOException: if an input or output exception occurred

public void println(double d) throws IOException

Overrides jakarta.servlet.ServletOutputStream.println.

Doc from jakarta.servlet.ServletOutputStream.println.

Writes a double value to the client, followed by a carriage return-line feed (CRLF).

Parameters

d:double: the double value to write to the client

Annotations

@Override

Exceptions

IOException:: if an input or output exception occurred

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) 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 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 void write(byte[] b) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream. The general contract for `write(b)` is that it should have exactly the same effect as the call `write(b, 0, b.length)`. Parameters b:byte[] the data. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

b:byte[]: the data.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public 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 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 ServletOutputStreamWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail