com.yanzhenjie.andserver.framework.body

Class StreamBody

java.lang.Object

com.yanzhenjie.andserver.framework.body.StreamBody

All Implemented Interfaces:

ResponseBody

public class StreamBody
extends java.lang.Object
implements ResponseBody

Created by Zhenjie Yan on 2018/9/7.

Constructor Summary

Constructors

Constructor and Description
StreamBody(java.io.InputStream stream)
StreamBody(java.io.InputStream stream, boolean chunked, long length, MediaType mediaType)
StreamBody(java.io.InputStream stream, long length)
StreamBody(java.io.InputStream stream, long length, MediaType mediaType)
StreamBody(java.io.InputStream stream, MediaType mediaType)

Method Summary

Modifier and Type	Method and Description
long	contentLength() Get the content-length of the message body, if the length is unknown, return a negative value.
MediaType	contentType() Get the content-type of the message body, including charset.
boolean	isChunked() Tells about chunked encoding for this entity.
boolean	isRepeatable() Can it be reused?
void	writeTo(java.io.OutputStream output) Write the body to the output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StreamBody

public StreamBody(java.io.InputStream stream)

StreamBody

public StreamBody(java.io.InputStream stream,
                  long length)

StreamBody

public StreamBody(java.io.InputStream stream,
                  MediaType mediaType)

StreamBody

public StreamBody(java.io.InputStream stream,
                  long length,
                  MediaType mediaType)

StreamBody

public StreamBody(java.io.InputStream stream,
                  boolean chunked,
                  long length,
                  MediaType mediaType)

Method Detail

isRepeatable

public boolean isRepeatable()

Description copied from interface: ResponseBody

Can it be reused?

Specified by:

isRepeatable in interface ResponseBody

Returns:

true, otherwise is false.

isChunked

public boolean isChunked()

Description copied from interface: ResponseBody

Tells about chunked encoding for this entity.

The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

Specified by:

isChunked in interface ResponseBody

Returns:

true if chunked encoding is preferred for this entity, or false if it is not

contentLength

public long contentLength()

Description copied from interface: ResponseBody

Get the content-length of the message body, if the length is unknown, return a negative value.

Specified by:

contentLength in interface ResponseBody

Returns:

message length.

contentType

public MediaType contentType()

Description copied from interface: ResponseBody

Get the content-type of the message body, including charset.

Specified by:

contentType in interface ResponseBody

Returns:

e.g. application/json; charset=utf-8.

writeTo

public void writeTo(java.io.OutputStream output)
             throws java.io.IOException

Description copied from interface: ResponseBody

Write the body to the output stream.

Specified by:

writeTo in interface ResponseBody

Parameters:

output - the output stream to write the body.

Throws:

java.io.IOException