com.sap.cloud.sdk.service.prov.api.response.impl

Class OperationResponseBuilderImpl

java.lang.Object

com.sap.cloud.sdk.service.prov.api.response.impl.OperationResponseBuilderImpl

All Implemented Interfaces:

OperationResponseBuilder, ResponseBuilder

public class OperationResponseBuilderImpl
extends Object
implements OperationResponseBuilder

Constructor Summary

Constructors

Constructor and Description
OperationResponseBuilderImpl()

Method Summary

Modifier and Type	Method and Description
OperationResponseBuilder	addHeader(String name, String value) Adds a header with the specified name and value in the OperationResponseBuilder object.
OperationResponseBuilder	addHeaders(Map<String,List<String>> headers) Adds headers in the OperationResponseBuilder object.
OperationResponse	response() Use this method to build the OperationResponse from the builder.
OperationResponseBuilder	setComplexData(List<Map<String,Object>> data) Can be used to set the response Complex Types, Array of ComplexTypes.
OperationResponseBuilder	setData(List data) Can be used to set the response Entity, Array of Entities where the entity is represented by a POJO.
OperationResponseBuilder	setEntityData(List<EntityData> data) Can be used to set the response Entity, Array of Entities.
OperationResponseBuilder	setHeader(String name, String value) Sets a header with the specified name and value in the OperationResponseBuilder object.
OperationResponseBuilder	setPrimitiveData(List<Object> data) Can be used to set the response single primitive type or collection of primitive types.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationResponseBuilderImpl

public OperationResponseBuilderImpl()

Method Detail

setEntityData

public OperationResponseBuilder setEntityData(List<EntityData> data)

Description copied from interface: OperationResponseBuilder

Can be used to set the response Entity, Array of Entities. If returning a single entity, create a list with single element. If returning a collection of entities, create a list of entities.

Specified by:

setEntityData in interface OperationResponseBuilder

Returns:

OperationResponseBuilder to build the response

setData

public OperationResponseBuilder setData(List data)

Description copied from interface: OperationResponseBuilder

Can be used to set the response Entity, Array of Entities where the entity is represented by a POJO. If returning a single entity, create a list with a single POJO. If returning a collection of entities, create a list of POJOs.

Specified by:

setData in interface OperationResponseBuilder

Returns:

OperationResponseBuilder to build the response

setComplexData

public OperationResponseBuilder setComplexData(List<Map<String,Object>> data)

Description copied from interface: OperationResponseBuilder

Can be used to set the response Complex Types, Array of ComplexTypes. If returning a single complex type, create a list with single Map. If returning a collection of complex types, create a list of complex type maps.

Specified by:

setComplexData in interface OperationResponseBuilder

Returns:

OperationResponseBuilder to build the response

setPrimitiveData

public OperationResponseBuilder setPrimitiveData(List<Object> data)

Description copied from interface: OperationResponseBuilder

Can be used to set the response single primitive type or collection of primitive types. If returning a single primitive type, create a list with single primitive type. If returning a collection of primitive types, create a list of primitive types.

Specified by:

setPrimitiveData in interface OperationResponseBuilder

Returns:

OperationResponseBuilder to build the response

addHeaders

public OperationResponseBuilder addHeaders(Map<String,List<String>> headers)

Description copied from interface: OperationResponseBuilder

Adds headers in the OperationResponseBuilder object. If headers are already present in the OperationResponseBuilder object, the specified headers are added to the existing ones. The header name is case-insensitive. Note: The SDK framework might overwrite the values you add to the header in the final response that gets created.

Specified by:

addHeaders in interface OperationResponseBuilder

Parameters:

headers - A java.util.Map> containing the headers to be added

Returns:

A OperationResponseBuilder object containing the added headers

setHeader

public OperationResponseBuilder setHeader(String name,
                                          String value)

Description copied from interface: OperationResponseBuilder

Sets a header with the specified name and value in the OperationResponseBuilder object. If the header is already present in the OperationResponseBuilder object, the new value overwrites the previous one. The header name is case-insensitive. Note: The SDK framework might overwrite the value you set in the header in the final response that gets created.

Specified by:

setHeader in interface OperationResponseBuilder

Parameters:

name - A String containing the name of the header

value - A String containing the header value

Returns:

A OperationResponseBuilder object containing the newly added or updated header

addHeader

public OperationResponseBuilder addHeader(String name,
                                          String value)

Description copied from interface: OperationResponseBuilder

Adds a header with the specified name and value in the OperationResponseBuilder object. If the header is already present in the OperationResponseBuilder object, the specified value is added to the existing values. The header name is case-insensitive. Note: The SDK framework might overwrite the value you add to the header in the final response that gets created.

Specified by:

addHeader in interface OperationResponseBuilder

Parameters:

name - A String containing the name of the header

value - A String containing the additional header value

Returns:

A OperationResponseBuilder object containing the additional header

response

public OperationResponse response()

Description copied from interface: OperationResponseBuilder

Use this method to build the OperationResponse from the builder.

Specified by:

response in interface OperationResponseBuilder

Returns:

OperationResponse which can be returned