Package com.sap.cloud.sdk.cloudplatform.requestheader

Class DefaultRequestHeaderContainer.Builder

java.lang.Object

com.sap.cloud.sdk.cloudplatform.requestheader.DefaultRequestHeaderContainer.Builder

All Implemented Interfaces:

RequestHeaderContainer.Builder

Enclosing class:

DefaultRequestHeaderContainer

@Beta
public static class DefaultRequestHeaderContainer.Builder
extends Object
implements RequestHeaderContainer.Builder

Implementation of the RequestHeaderContainer.Builder interface that is able to construct and manipulate DefaultRequestHeaderContainers.

Method Summary

Modifier and Type	Method	Description
RequestHeaderContainer	build()	Initializes a new instance of RequestHeaderContainer from the HTTP headers and cookies contained in this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	clear()	Removes all HTTP headers and cookies from this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	replaceHeader(String name, RequestHeaderContainer headerContainer)	Replaces an HTTP header in this RequestHeaderContainer.Builder by copying the HTTP header of the given headerContainer.
RequestHeaderContainer.Builder	replaceHeader(String name, Iterable<String> values)	Replaces an HTTP header in this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	replaceHeader(String name, String firstValue, String... furtherValues)	Replaces an HTTP header in this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	withHeader(String name, RequestHeaderContainer headerContainer)	Copies the HTTP header with the given name - including all it's values - from the headerContainer.
RequestHeaderContainer.Builder	withHeader(String name, Iterable<String> values)	Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	withHeader(String name, String firstValue, String... furtherValues)	Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.
RequestHeaderContainer.Builder	withHeaders(RequestHeaderContainer headerContainer)	Copies all existing headers from the given RequestHeaderContainer.
RequestHeaderContainer.Builder	withoutHeader(String name)	Removes an HTTP header from this RequestHeaderContainer.Builder.

Methods inherited from class java.lang.Object

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

Method Details

withHeaders

@Nonnull
public RequestHeaderContainer.Builder withHeaders(@Nonnull
 RequestHeaderContainer headerContainer)

Description copied from interface: RequestHeaderContainer.Builder

Copies all existing headers from the given RequestHeaderContainer.

Specified by:

withHeaders in interface RequestHeaderContainer.Builder

Parameters:

headerContainer - The RequestHeaderContainer to copy the headers from.

Returns:

This RequestHeaderContainer.Builder instance.

withHeader

@Nonnull
public RequestHeaderContainer.Builder withHeader(@Nonnull
 String name,
 @Nonnull
 String firstValue,
 @Nonnull
 String... furtherValues)

Description copied from interface: RequestHeaderContainer.Builder

Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.

If the header does already exist, all given values will be added to it.

Specified by:

withHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The name of the HTTP header. This is treated case insensitively.

firstValue - The first value of the HTTP header.

furtherValues - Further values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

withHeader

@Nonnull
public RequestHeaderContainer.Builder withHeader(@Nonnull
 String name,
 @Nonnull
 Iterable<String> values)

Description copied from interface: RequestHeaderContainer.Builder

Adds a new HTTP header with the given values to this RequestHeaderContainer.Builder.

If the header does already exist, all given values will be added to it.

Specified by:

withHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The name of the HTTP header. This is treated case insensitively.

values - The values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

withHeader

@Nonnull
public RequestHeaderContainer.Builder withHeader(@Nonnull
 String name,
 @Nonnull
 RequestHeaderContainer headerContainer)

Description copied from interface: RequestHeaderContainer.Builder

Copies the HTTP header with the given name - including all it's values - from the headerContainer.

Specified by:

withHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The name of the HTTP header.

headerContainer - The RequestHeaderContainer to copy the HTTP header from.

Returns:

This RequestHeaderContainer.Builder instance.

withoutHeader

@Nonnull
public RequestHeaderContainer.Builder withoutHeader(@Nonnull
 String name)

Description copied from interface: RequestHeaderContainer.Builder

Removes an HTTP header from this RequestHeaderContainer.Builder.

Specified by:

withoutHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The case insensitive name of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

replaceHeader

@Nonnull
public RequestHeaderContainer.Builder replaceHeader(@Nonnull
 String name,
 @Nonnull
 String firstValue,
 @Nonnull
 String... furtherValues)

Description copied from interface: RequestHeaderContainer.Builder

Replaces an HTTP header in this RequestHeaderContainer.Builder.

This method is semantically equivalent to withoutHeader(name).withHeader(name, firstValue, furtherValues).

Specified by:

replaceHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The case insensitive name of the HTTP header.

firstValue - The first new value of the HTTP header.

furtherValues - Further new values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

replaceHeader

@Nonnull
public RequestHeaderContainer.Builder replaceHeader(@Nonnull
 String name,
 @Nonnull
 Iterable<String> values)

Description copied from interface: RequestHeaderContainer.Builder

Replaces an HTTP header in this RequestHeaderContainer.Builder.

This method is semantically equivalent to withoutHeader(name).withHeader(name, values).

Specified by:

replaceHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The case insensitive name of the HTTP header.

values - The new values of the HTTP header.

Returns:

This RequestHeaderContainer.Builder instance.

replaceHeader

@Nonnull
public RequestHeaderContainer.Builder replaceHeader(@Nonnull
 String name,
 @Nonnull
 RequestHeaderContainer headerContainer)

Description copied from interface: RequestHeaderContainer.Builder

Replaces an HTTP header in this RequestHeaderContainer.Builder by copying the HTTP header of the given headerContainer.

This method is equivalent to withoutHeader(name).withHeader(name, headerContainer).

Specified by:

replaceHeader in interface RequestHeaderContainer.Builder

Parameters:

name - The case insensitive name of the HTTP header.

headerContainer - The RequestHeaderContainer to copy the HTTP header from.

Returns:

This RequestHeaderContainer.Builder instance.

clear

@Nonnull
public RequestHeaderContainer.Builder clear()

Description copied from interface: RequestHeaderContainer.Builder

Removes all HTTP headers and cookies from this RequestHeaderContainer.Builder.

Specified by:

clear in interface RequestHeaderContainer.Builder

Returns:

This RequestHeaderContainer.Builder instance.

build

@Nonnull
public RequestHeaderContainer build()

Description copied from interface: RequestHeaderContainer.Builder

Initializes a new instance of RequestHeaderContainer from the HTTP headers and cookies contained in this RequestHeaderContainer.Builder.

Specified by:

build in interface RequestHeaderContainer.Builder

Returns:

A new instance of RequestHeaderContainer.