Package jakarta.servlet
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 SummaryConstructorsModifierConstructorDescriptionprotectedDoes nothing, because this is an abstract class.
- 
Method SummaryModifier 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.OutputStreamclose, flush, nullOutputStream, write, write, write
- 
Constructor Details- 
ServletOutputStreamprotected ServletOutputStream()Does nothing, because this is an abstract class.
 
- 
- 
Method Details- 
printWrites aStringto the client, without a carriage return-line feed (CRLF) character at the end.- Parameters:
- s- the- Stringto send to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printWrites abooleanvalue to the client, with no carriage return-line feed (CRLF) character at the end.- Parameters:
- b- the- booleanvalue to send to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printWrites 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
 
- 
printWrites 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
 
- 
printWrites alongvalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
- l- the- longvalue to send to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printWrites afloatvalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
- f- the- floatvalue to send to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printWrites adoublevalue to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
- d- the- doublevalue to send to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printlnWrites a carriage return-line feed (CRLF) to the client.- Throws:
- IOException- if an input or output exception occurred
 
- 
printlnWrites aStringto the client, followed by a carriage return-line feed (CRLF).- Parameters:
- s- the- Stringto write to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printlnWrites abooleanvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
- b- the- booleanvalue to write to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printlnWrites 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
 
- 
printlnWrites 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
 
- 
printlnWrites alongvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
- l- the- longvalue to write to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printlnWrites afloatvalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
- f- the- floatvalue to write to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
printlnWrites adoublevalue to the client, followed by a carriage return-line feed (CRLF).- Parameters:
- d- the- doublevalue to write to the client
- Throws:
- IOException- if an input or output exception occurred
 
- 
isReadypublic 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, else- false
- Since:
- Servlet 3.1
 
- 
setWriteListenerSets 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 the- WriteListenerhas already been set
- NullPointerException- If listener is null
- Since:
- Servlet 3.1
 
 
-