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

Class ReadResponseBuilderImpl

java.lang.Object

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

All Implemented Interfaces:

ReadResponseBuilder, ResponseBuilder

public class ReadResponseBuilderImpl
extends Object
implements ReadResponseBuilder

Constructor Summary

Constructors

Constructor and Description
ReadResponseBuilderImpl()

Method Summary

Modifier and Type	Method and Description
ReadResponseBuilder	addHeader(String name, String value) Adds a header with the specified name and value in the ReadResponseBuilder object.
ReadResponseBuilder	addHeaders(Map<String,List<String>> headers) Adds headers in the ReadResponseBuilder object.
ReadResponseBuilder	audit(boolean enable) Deprecated.
ReadResponse	response() Returns an instance of ReadResponse object.
ReadResponseBuilder	setData(EntityData entityData) Sets an EntityData object corresponding to the read entity in the ReadResponseBuilder object.
ReadResponseBuilder	setData(Map<String,Object> data) Sets key-value pairs representing the properties of the read entity in the ReadResponseBuilder object.
ReadResponseBuilder	setData(Object pojoData) Sets a POJO object corresponding to the read entity in the ReadResponseBuilder object.
ReadResponseBuilder	setHeader(String name, String value) Sets a header with the specified name and value in the ReadResponseBuilder object.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadResponseBuilderImpl

public ReadResponseBuilderImpl()

Method Detail

addHeaders

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

Description copied from interface: ReadResponseBuilder

Adds headers in the ReadResponseBuilder object. If headers are already present in the ReadResponseBuilder 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 ReadResponseBuilder

Parameters:

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

Returns:

A ReadResponseBuilder object containing the added headers

setHeader

public ReadResponseBuilder setHeader(String name,
                                     String value)

Description copied from interface: ReadResponseBuilder

Sets a header with the specified name and value in the ReadResponseBuilder object. If the header is already present in the ReadResponseBuilder 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 ReadResponseBuilder

Parameters:

name - A String containing the name of the header

value - A String containing the header value

Returns:

A ReadResponseBuilder object containing the newly added or updated header

addHeader

public ReadResponseBuilder addHeader(String name,
                                     String value)

Description copied from interface: ReadResponseBuilder

Adds a header with the specified name and value in the ReadResponseBuilder object. If the header is already present in the ReadResponseBuilder 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 ReadResponseBuilder

Parameters:

name - A String containing the name of the header

value - A String containing the additional header value

Returns:

A ReadResponseBuilder object containing the additional header

setData

public ReadResponseBuilder setData(Map<String,Object> data)

Description copied from interface: ReadResponseBuilder

Sets key-value pairs representing the properties of the read entity in the ReadResponseBuilder object.

Specified by:

setData in interface ReadResponseBuilder

Parameters:

data - A Map object that represents the read entity

Returns:

A ReadResponseBuilder object containing the read entity

setData

public ReadResponseBuilder setData(EntityData entityData)

Description copied from interface: ReadResponseBuilder

Sets an EntityData object corresponding to the read entity in the ReadResponseBuilder object.

Specified by:

setData in interface ReadResponseBuilder

Parameters:

entityData - An EntityData object that represents the read entity

Returns:

A ReadResponseBuilder object containing the read entity

setData

public ReadResponseBuilder setData(Object pojoData)

Description copied from interface: ReadResponseBuilder

Sets a POJO object corresponding to the read entity in the ReadResponseBuilder object.

Specified by:

setData in interface ReadResponseBuilder

Parameters:

pojoData - A POJO Object that represents the read entity

Returns:

A ReadResponseBuilder object containing the read entity

response

public ReadResponse response()

Description copied from interface: ReadResponseBuilder

Returns an instance of ReadResponse object.

Specified by:

response in interface ReadResponseBuilder

Returns:

A ReadResponse object

audit

@Deprecated
public ReadResponseBuilder audit(boolean enable)

Deprecated.

Description copied from interface: ReadResponseBuilder

Enables auditing for read operation. Please note that auditing is disabled by default.

Specified by:

audit in interface ReadResponseBuilder

Parameters:

enable - A boolean to enable or disable auditing

Returns:

A ReadResponseBuilder object containing the updated auditing attribute