Package javax.servlet
Class ServletOutputStream
java.lang.Object
java.io.OutputStream
javax.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
ModifierConstructorDescriptionprotected
Does nothing, because this is an abstract class. -
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
isReady()
This method can be used to determine if data can be written without blocking.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
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
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 writeMethods 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 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
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
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 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
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
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
Writes a carriage return-line feed (CRLF) to the client.- Throws:
IOException
- if an input or output exception occurred
-
println
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
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
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 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
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
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()This method can be used to determine if data can be written without blocking.- Returns:
true
if a write to thisServletOutputStream
will succeed, otherwise returnsfalse
.- Since:
- Servlet 3.1
-
setWriteListener
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
-