Tomcat 10.1.19 · jakarta.servlet.ServletOutputStream

Modifier and Type	Field and Description
private static final String	LSTRING_FILE
private static final ResourceBundle	lStrings

Access	Constructor and Description
protected	ServletOutputStream() Does nothing, because this is an abstract class.

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: `true` if data can be written, else `false` isReady() Checks if a non-blocking write will succeed.
public void	print(String the `String` to send to the client s) 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) 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) 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) 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) 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) 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) Writes a `double` value to the client, with no carriage return-line feed (CRLF) at the end.
public void	println() Writes a carriage return-line feed (CRLF) to the client.
public void	println(String the `String` to write to the client s) 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) 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) 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) 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) 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) 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) Writes a `double` value to the client, followed by a carriage return-line feed (CRLF).
public abstract void	setWriteListener(WriteListener The non-blocking IO write listener listener) Sets the `WriteListener` for this `ServletOutputStream` and thereby switches to non-blocking IO.

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

LSTRING_FILE	back to summary
private static final String LSTRING_FILE

lStrings	back to summary
private static final ResourceBundle lStrings

ServletOutputStream	back to summary
protected ServletOutputStream() Does nothing, because this is an abstract class.

Method Detail

isReady back to summary

isReady	back to summary
public abstract boolean isReady() Checks if a non-blocking write will succeed. If this returns `false`, it will cause a callback to `WriteListener#onWritePossible()` when the buffer has emptied. If this method returns `false` no further data must be written until the container calls `WriteListener#onWritePossible()`. Returns:boolean `true` if data can be written, else `false` Since Servlet 3.1

public abstract boolean isReady()

Checks if a non-blocking write will succeed. If this returns false, it will cause a callback to WriteListener#onWritePossible() when the buffer has emptied. If this method returns false no further data must be written until the container calls WriteListener#onWritePossible().

Returns:boolean: true if data can be written, else false
Since: Servlet 3.1

print back to summary

print	back to summary
public void print(String s) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void print(String s) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(boolean b) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void print(boolean b) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

print	back to summary
public void print(char c) throws IOException 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 Exceptions IOException: if an input or output exception occurred

back to summary

public void print(char c) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

print	back to summary
public void print(int i) throws IOException 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 Exceptions IOException: if an input or output exception occurred

back to summary

public void print(int i) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(long l) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void print(long l) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(float f) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void print(float f) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

print back to summary

print	back to summary
public void print(double d) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void print(double d) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

println	back to summary
public void println() throws IOException Writes a carriage return-line feed (CRLF) to the client. Exceptions IOException: if an input or output exception occurred

println

back to summary

public void println() throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

println back to summary

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

public void println(String s) throws IOException

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

Parameters

s:String: the String to write to the client

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(boolean b) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void println(boolean b) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

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

println

back to summary

public void println(char c) throws IOException

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

Parameters

c:char: the character to write to the client

Exceptions

IOException:: if an input or output exception occurred

println	back to summary
public void println(int i) throws IOException 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 Exceptions IOException: if an input or output exception occurred

println

back to summary

public void println(int i) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(long l) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void println(long l) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(float f) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void println(float f) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

println back to summary

println	back to summary
public void println(double d) throws IOException 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 Exceptions IOException: if an input or output exception occurred

public void println(double d) throws IOException

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

Exceptions

IOException:: if an input or output exception occurred

setWriteListener back to summary

setWriteListener	back to summary
public abstract void setWriteListener(WriteListener listener) Sets the `WriteListener` for this `ServletOutputStream` and thereby switches to non-blocking IO. It is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing. Parameters listener:WriteListener The non-blocking IO write listener Exceptions IllegalStateException: If this method is called if neither async nor HTTP upgrade is in progress or if the `WriteListener` has already been set NullPointerException: If listener is null Since Servlet 3.1

public abstract void setWriteListener(WriteListener listener)

Sets the WriteListener for this ServletOutputStream and thereby switches to non-blocking IO. It is only valid to switch to non-blocking IO within async processing or HTTP upgrade processing.

Parameters

listener:WriteListener: The non-blocking IO write listener

Exceptions

IllegalStateException:: If this method is called if neither async nor HTTP upgrade is in progress or if the WriteListener has already been set
NullPointerException:: If listener is null

Since

Servlet 3.1

public abstract Class ServletOutputStream

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail