Package jakarta.servlet
Class ServletOutputStream
- java.lang.Object
-
- java.io.OutputStream
-
- jakarta.servlet.ServletOutputStream
-
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
public abstract class ServletOutputStream extends OutputStream
Provides an output stream for sending binary data to the client. AServletOutputStream
object 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.- Author:
- Various
- See Also:
ServletResponse
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ServletOutputStream()
Does nothing, because this is an abstract class.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract boolean
isReady()
Returns true if data can be written without blocking else returns false.void
print(boolean b)
Writes aboolean
value to the client, with no carriage return-line feed (CRLF) character at the end.void
print(char c)
Writes a character to the client, with no carriage return-line feed (CRLF) at the end.void
print(double d)
Writes adouble
value to the client, with no carriage return-line feed (CRLF) at the end.void
print(float f)
Writes afloat
value to the client, with no carriage return-line feed (CRLF) at the end.void
print(int i)
Writes an int to the client, with no carriage return-line feed (CRLF) at the end.void
print(long l)
Writes along
value to the client, with no carriage return-line feed (CRLF) at the end.void
print(String s)
Writes aString
to the client, without a carriage return-line feed (CRLF) character at the end.void
println()
Writes a carriage return-line feed (CRLF) to the client.void
println(boolean b)
Writes aboolean
value to the client, followed by a carriage return-line feed (CRLF).void
println(char c)
Writes a character to the client, followed by a carriage return-line feed (CRLF).void
println(double d)
Writes adouble
value to the client, followed by a carriage return-line feed (CRLF).void
println(float f)
Writes afloat
value to the client, followed by a carriage return-line feed (CRLF).void
println(int i)
Writes an int to the client, followed by a carriage return-line feed (CRLF) character.void
println(long l)
Writes along
value to the client, followed by a carriage return-line feed (CRLF).void
println(String s)
Writes aString
to the client, followed by a carriage return-line feed (CRLF).abstract void
setWriteListener(WriteListener writeListener)
Instructs theServletOutputStream
to invoke the providedWriteListener
when it is possible to write-
Methods inherited from class java.io.OutputStream
close, flush, nullOutputStream, write, write, write
-
-
-
-
Method Detail
-
print
public void print(String s) throws IOException
Writes aString
to the client, without a carriage return-line feed (CRLF) character at the end.- Parameters:
s
- theString
to send to the client- Throws:
IOException
- if an input or output exception occurred
-
print
public void print(boolean b) throws IOException
Writes aboolean
value to the client, with no carriage return-line feed (CRLF) character at the end.- Parameters:
b
- theboolean
value to send to the client- Throws:
IOException
- if an input or output exception occurred
-
print
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
- the character to send to the client- Throws:
IOException
- if an input or output exception occurred
-
print
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
- the int to send to the client- Throws:
IOException
- if an input or output exception occurred
-
print
public void print(long l) throws IOException
Writes along
value to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
l
- thelong
value to send to the client- Throws:
IOException
- if an input or output exception occurred
-
print
public void print(float f) throws IOException
Writes afloat
value to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
f
- thefloat
value to send to the client- Throws:
IOException
- if an input or output exception occurred
-
print
public void print(double d) throws IOException
Writes adouble
value to the client, with no carriage return-line feed (CRLF) at the end.- Parameters:
d
- thedouble
value to send to the client- Throws:
IOException
- if an input or output exception occurred
-
println
public void println() throws IOException
Writes a carriage return-line feed (CRLF) to the client.- Throws:
IOException
- if an input or output exception occurred
-
println
public void println(String s) throws IOException
Writes aString
to the client, followed by a carriage return-line feed (CRLF).- Parameters:
s
- theString
to write to the client- Throws:
IOException
- if an input or output exception occurred
-
println
public void println(boolean b) throws IOException
Writes aboolean
value to the client, followed by a carriage return-line feed (CRLF).- Parameters:
b
- theboolean
value to write to the client- Throws:
IOException
- if an input or output exception occurred
-
println
public void println(char c) throws IOException
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
public void println(int i) throws IOException
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
public void println(long l) throws IOException
Writes along
value to the client, followed by a carriage return-line feed (CRLF).- Parameters:
l
- thelong
value to write to the client- Throws:
IOException
- if an input or output exception occurred
-
println
public void println(float f) throws IOException
Writes afloat
value to the client, followed by a carriage return-line feed (CRLF).- Parameters:
f
- thefloat
value to write to the client- Throws:
IOException
- if an input or output exception occurred
-
println
public void println(double d) throws IOException
Writes adouble
value to the client, followed by a carriage return-line feed (CRLF).- Parameters:
d
- thedouble
value to write to the client- Throws:
IOException
- if an input or output exception occurred
-
isReady
public abstract boolean isReady()
Returns true if data can be written without blocking else returns false.If this method returns false and a
WriteListener
has been set withsetWriteListener(WriteListener)
, then container will subsequently invokeWriteListener.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:
true
if data can be written without blocking, otherwise returnsfalse
.- Since:
- Servlet 3.1
- See Also:
WriteListener
-
setWriteListener
public abstract void setWriteListener(WriteListener writeListener)
Instructs theServletOutputStream
to invoke the providedWriteListener
when it is possible to write- Parameters:
writeListener
- theWriteListener
that should be notified when it's possible to write- Throws:
IllegalStateException
- if one of the following conditions is true- the associated request is neither upgraded nor the async started
- setWriteListener is called more than once within the scope of the same request.
NullPointerException
- if writeListener is null- Since:
- Servlet 3.1
-
-