Class ServletOutputStream
java.lang.Object
java.io.OutputStream
jakarta.servlet.ServletOutputStream
- All Implemented Interfaces:
Closeable,Flushable,AutoCloseable
Provides an output stream for sending binary data to the client. A
ServletOutputStream object is
normally retrieved via the ServletResponse.getOutputStream() method.
This is an abstract class that the servlet container implements. Subclasses of this class must implement the
java.io.OutputStream.write(int) method.
- See Also:
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDoes nothing, because this is an abstract class. -
Method Summary
Modifier and TypeMethodDescriptionabstract booleanisReady()Checks if a non-blocking write will succeed.voidprint(boolean b) Writes abooleanvalue to the client, with no carriage return-line feed (CRLF) character at the end.voidprint(char c) Writes a character to the client, with no carriage return-line feed (CRLF) at the end.voidprint(double d) Writes adoublevalue to the client, with no carriage return-line feed (CRLF) at the end.voidprint(float f) Writes afloatvalue to the client, with no carriage return-line feed (CRLF) at the end.voidprint(int i) Writes an int to the client, with no carriage return-line feed (CRLF) at the end.voidprint(long l) Writes alongvalue to the client, with no carriage return-line feed (CRLF) at the end.voidWrites aStringto the client, without a carriage return-line feed (CRLF) character at the end.voidprintln()Writes a carriage return-line feed (CRLF) to the client.voidprintln(boolean b) Writes abooleanvalue to the client, followed by a carriage return-line feed (CRLF).voidprintln(char c) Writes a character to the client, followed by a carriage return-line feed (CRLF).voidprintln(double d) Writes adoublevalue to the client, followed by a carriage return-line feed (CRLF).voidprintln(float f) Writes afloatvalue to the client, followed by a carriage return-line feed (CRLF).voidprintln(int i) Writes an int to the client, followed by a carriage return-line feed (CRLF) character.voidprintln(long l) Writes alongvalue to the client, followed by a carriage return-line feed (CRLF).voidWrites aStringto the client, followed by a carriage return-line feed (CRLF).abstract voidsetWriteListener(WriteListener listener) Sets theWriteListenerfor thisServletOutputStreamand thereby switches to non-blocking IO.Methods inherited from class java.io.OutputStream
close, flush, nullOutputStream, write, write, write
-
Constructor Details
-
ServletOutputStream
protected ServletOutputStream()Does nothing, because this is an abstract class.
-
-
Method Details
-
print
Writes aStringto the client, without a carriage return-line feed (CRLF) character at the end.- Parameters:
s- theStringto send to the client- Throws:
IOException- if an input or output exception occurred
-
print
Writes abooleanvalue to the client, with no carriage return-line feed (CRLF) character at the end.- Parameters:
b- thebooleanvalue to send to the client- Throws:
IOException- if an input or output exception occurred
-
print
Writes a character to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
c- the character to send to the client- Throws:
IOException- if an input or output exception occurred
-
print
Writes an int to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
i- the int to send to the client- Throws:
IOException- if an input or output exception occurred
-
print
Writes alongvalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
l- thelongvalue to send to the client- Throws:
IOException- if an input or output exception occurred
-
print
Writes afloatvalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
f- thefloatvalue to send to the client- Throws:
IOException- if an input or output exception occurred
-
print
Writes adoublevalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
d- thedoublevalue to send to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes a carriage return-line feed (CRLF) to the client.- Throws:
IOException- if an input or output exception occurred
-
println
Writes aStringto the client, followed by a carriage return-line feed (CRLF).- Parameters:
s- theStringto write to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes abooleanvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
b- thebooleanvalue to write to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes a character to the client, followed by a carriage return-line feed (CRLF).- Parameters:
c- the character to write to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes an int to the client, followed by a carriage return-line feed (CRLF) character.- Parameters:
i- the int to write to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes alongvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
l- thelongvalue to write to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes afloatvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
f- thefloatvalue to write to the client- Throws:
IOException- if an input or output exception occurred
-
println
Writes adoublevalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
d- thedoublevalue to write to the client- Throws:
IOException- if an input or output exception occurred
-
isReady
public abstract boolean isReady()Checks if a non-blocking write will succeed. If this returnsfalse, it will cause a callback toWriteListener.onWritePossible()when the buffer has emptied. If this method returnsfalseno further data must be written until the container callsWriteListener.onWritePossible().- Returns:
trueif data can be written, elsefalse- Since:
- Servlet 3.1
-
setWriteListener
Sets theWriteListenerfor thisServletOutputStreamand 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- The non-blocking IO write listener- Throws:
IllegalStateException- If this method is called if neither async nor HTTP upgrade is in progress or if theWriteListenerhas already been setNullPointerException- If listener is null- Since:
- Servlet 3.1
-