Package jakarta.servlet
Class ServletOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- jakarta.servlet.ServletOutputStream
-
- All Implemented Interfaces:
java.io.Closeable,java.io.Flushable,java.lang.AutoCloseable
public abstract class ServletOutputStream extends java.io.OutputStreamProvides an output stream for sending binary data to the client. AServletOutputStreamobject is normally retrieved via theServletResponse.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:
ServletResponse
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedServletOutputStream()Does nothing, because this is an abstract class.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract 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.voidprint(java.lang.String s)Writes 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).voidprintln(java.lang.String s)Writes aStringto the client, followed by a carriage return-line feed (CRLF).abstract voidsetWriteListener(WriteListener listener)Sets theWriteListenerfor thisServletOutputStreamand thereby switches to non-blocking IO.
-
-
-
Method Detail
-
print
public void print(java.lang.String s) throws java.io.IOExceptionWrites aStringto the client, without a carriage return-line feed (CRLF) character at the end.- Parameters:
s- theStringto send to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
print
public void print(boolean b) throws java.io.IOExceptionWrites abooleanvalue to the client, with no carriage return-line feed (CRLF) character at the end.- Parameters:
b- thebooleanvalue to send to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
print
public void print(char c) throws java.io.IOExceptionWrites 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:
java.io.IOException- if an input or output exception occurred
-
print
public void print(int i) throws java.io.IOExceptionWrites 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:
java.io.IOException- if an input or output exception occurred
-
print
public void print(long l) throws java.io.IOExceptionWrites alongvalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
l- thelongvalue to send to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
print
public void print(float f) throws java.io.IOExceptionWrites afloatvalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
f- thefloatvalue to send to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
print
public void print(double d) throws java.io.IOExceptionWrites adoublevalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
d- thedoublevalue to send to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println() throws java.io.IOExceptionWrites a carriage return-line feed (CRLF) to the client.- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(java.lang.String s) throws java.io.IOExceptionWrites aStringto the client, followed by a carriage return-line feed (CRLF).- Parameters:
s- theStringto write to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(boolean b) throws java.io.IOExceptionWrites abooleanvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
b- thebooleanvalue to write to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(char c) throws java.io.IOExceptionWrites a character to the client, followed by a carriage return-line feed (CRLF).- Parameters:
c- the character to write to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(int i) throws java.io.IOExceptionWrites an int to the client, followed by a carriage return-line feed (CRLF) character.- Parameters:
i- the int to write to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(long l) throws java.io.IOExceptionWrites alongvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
l- thelongvalue to write to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(float f) throws java.io.IOExceptionWrites afloatvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
f- thefloatvalue to write to the client- Throws:
java.io.IOException- if an input or output exception occurred
-
println
public void println(double d) throws java.io.IOExceptionWrites adoublevalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
d- thedoublevalue to write to the client- Throws:
java.io.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
public abstract void setWriteListener(WriteListener listener)
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:
java.lang.IllegalStateException- If this method is called if neither async nor HTTP upgrade is in progress or if theWriteListenerhas already been setjava.lang.NullPointerException- If listener is null- Since:
- Servlet 3.1
-
-