org.n52.iceland.coding.encode

Interface ResponseWriter<T>

Type Parameters:

T - the entity type

All Superinterfaces:

Component<ResponseWriterKey>, Keyed<ResponseWriterKey>

All Known Implementing Classes:

AbstractResponseWriter, EXIResponseWriter, JSONResponseWriter, SoapChainResponseWriter, SoapResponseWriter, XmlResponseWriter

public interface ResponseWriter<T>
extends Component<ResponseWriterKey>

TODO JavaDoc

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
MediaType	getContentType() Get the current contentType
default MediaType	getEncodedContentType(ResponseFormat responseFormat)
default HTTPStatus	getForcedHttpStatus(T t)
default boolean	hasForcedHttpStatus(T t)
default boolean	isSetContentType() Check if contentType is set
void	setContentType(MediaType contentType) Set the contentType
boolean	supportsGZip(T t) Check if GZip is supported by this writer
void	write(T t, OutputStream out, ResponseProxy responseProxy) Write object t to OutputStream out

Methods inherited from interface org.n52.janmayen.component.Keyed

getKeys

Method Detail

getContentType

MediaType getContentType()

Get the current contentType

Returns:

the contenType

setContentType

void setContentType(MediaType contentType)

Set the contentType

Parameters:

contentType - to set

isSetContentType

default boolean isSetContentType()

Check if contentType is set

Returns:

true, if contentType is set

write

void write(T t,
           OutputStream out,
           ResponseProxy responseProxy)
    throws IOException,
           EncodingException

Write object t to OutputStream out

Parameters:

t - Object to write

out - OutputStream to be written to

responseProxy - ResponseProxy giving access to header and content length setters

Throws:

IOException - If an error occurs during writing

EncodingException - if an errors occurs during encoding

supportsGZip

boolean supportsGZip(T t)

Check if GZip is supported by this writer

Parameters:

t - Object to write

Returns:

true, if GZip is supported

getEncodedContentType

default MediaType getEncodedContentType(ResponseFormat responseFormat)

hasForcedHttpStatus

default boolean hasForcedHttpStatus(T t)

getForcedHttpStatus

default HTTPStatus getForcedHttpStatus(T t)