Package org.springframework.web.client

Class DefaultApiVersionInserter.Builder

java.lang.Object

org.springframework.web.client.DefaultApiVersionInserter.Builder

Enclosing class:

DefaultApiVersionInserter

public static final class DefaultApiVersionInserter.Builder
extends Object

A builder for DefaultApiVersionInserter.

Method Summary

Modifier and Type	Method	Description
ApiVersionInserter	build()	Build the inserter.
DefaultApiVersionInserter.Builder	fromHeader(@Nullable String header)	Configure the inserter to set a header.
DefaultApiVersionInserter.Builder	fromPathSegment(@Nullable Integer pathSegmentIndex)	Configure the inserter to insert a path segment.
DefaultApiVersionInserter.Builder	fromQueryParam(@Nullable String queryParam)	Configure the inserter to set a query parameter.
DefaultApiVersionInserter.Builder	withVersionFormatter(ApiVersionFormatter versionFormatter)	Format the version Object into a String using the given ApiVersionFormatter.

Methods inherited from class java.lang.Object

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

Method Details

fromHeader

public DefaultApiVersionInserter.Builder fromHeader(@Nullable String header)

Configure the inserter to set a header.

Parameters:

header - the name of the header to hold the version

fromQueryParam

public DefaultApiVersionInserter.Builder fromQueryParam(@Nullable String queryParam)

Configure the inserter to set a query parameter.

Parameters:

queryParam - the name of the query parameter to hold the version

fromPathSegment

public DefaultApiVersionInserter.Builder fromPathSegment(@Nullable Integer pathSegmentIndex)

Configure the inserter to insert a path segment.

Parameters:

pathSegmentIndex - the index of the path segment to hold the version

withVersionFormatter

public DefaultApiVersionInserter.Builder withVersionFormatter(ApiVersionFormatter versionFormatter)

Format the version Object into a String using the given ApiVersionFormatter.

By default, the version is formatted with Object.toString().

Parameters:

versionFormatter - the formatter to use

build

public ApiVersionInserter build()

Build the inserter.