com.sdl.context.image.transformation.response

Class TransformedImageResponse

java.lang.Object

com.sdl.context.image.transformation.response.TransformedImageResponse

All Implemented Interfaces:

TransformedResponse

public class TransformedImageResponse
extends Object
implements TransformedResponse

Provides the details of an image which has been transformed.

Constructor Summary

Constructors

Constructor and Description
TransformedImageResponse()
TransformedImageResponse(ClarifiedImage transformedImage)

Method Summary

Modifier and Type	Method and Description
void	addMeta(String name, String value) Add meta data for the response.
void	addResponseHeader(String name, String value) Add/updates an entry in the the HTTP header details.
TransformedImageResponse	clearHeaders() Clear the HTTP headers.
String	getMeta(String name)
ResponseError	getResponseError() Get the HTTP error details to be returned.
Collection<ResponseHeader>	getResponseHeaders() Returns the HTTP header details which should be included in the HTTPResponse.
ClarifiedImage	getTransformedImage() Get the transformed image.
void	removeResponseHeader(String name) Removes an entry from the HTTP header details.
void	setResponseError(ResponseError responseError) Set the HTTP error details to be returned.
void	setTransformedImage(ClarifiedImage transformedImage) Set the transformed image.

Methods inherited from class java.lang.Object

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

Constructor Detail

TransformedImageResponse

public TransformedImageResponse(ClarifiedImage transformedImage)

TransformedImageResponse

public TransformedImageResponse()

Method Detail

getResponseHeaders

public Collection<ResponseHeader> getResponseHeaders()

Returns the HTTP header details which should be included in the HTTPResponse.

Specified by:

getResponseHeaders in interface TransformedResponse

Returns:

the response header information

getTransformedImage

public ClarifiedImage getTransformedImage()

Get the transformed image.

Returns:

the transformed image

setTransformedImage

public void setTransformedImage(ClarifiedImage transformedImage)

Set the transformed image.

Parameters:

transformedImage - the transformed image

addMeta

public void addMeta(String name,
                    String value)

Add meta data for the response.

Parameters:

name - the name of the meta to add or update

value - the value

getMeta

public String getMeta(String name)

addResponseHeader

public void addResponseHeader(String name,
                              String value)

Add/updates an entry in the the HTTP header details.

Parameters:

name - the name of the header to add/update

value - the value

removeResponseHeader

public void removeResponseHeader(String name)

Removes an entry from the HTTP header details.

Parameters:

name - the name of the header to remove

getResponseError

public ResponseError getResponseError()

Get the HTTP error details to be returned.

Returns:

the error

setResponseError

public void setResponseError(ResponseError responseError)

Set the HTTP error details to be returned.

Parameters:

responseError - the error

clearHeaders

public TransformedImageResponse clearHeaders()

Clear the HTTP headers.

Returns:

the response (so that this method call can be chained)