Interface ApiVersionInserter.Builder

Enclosing interface:

ApiVersionInserter

public static interface ApiVersionInserter.Builder

Builder for ApiVersionInserter.

Since:

7.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method	Description
ApiVersionInserter	build()	Build the ApiVersionInserter instance.
ApiVersionInserter.Builder	useHeader(@Nullable String header)	Configure the inserter to set a header.
ApiVersionInserter.Builder	useMediaTypeParam(@Nullable String param)	Create an inserter to set a MediaType parameter on the "Content-Type" header.
ApiVersionInserter.Builder	usePathSegment(@Nullable Integer pathSegmentIndex)	Configure the inserter to insert a path segment.
ApiVersionInserter.Builder	useQueryParam(@Nullable String queryParam)	Configure the inserter to set a query parameter.
ApiVersionInserter.Builder	withVersionFormatter(ApiVersionFormatter versionFormatter)	Format the version Object into a String using the given ApiVersionFormatter.

Method Details

useHeader

ApiVersionInserter.Builder useHeader(@Nullable String header)

Configure the inserter to set a header.

Parameters:

header - the name of the header to hold the version

useQueryParam

ApiVersionInserter.Builder useQueryParam(@Nullable String queryParam)

Configure the inserter to set a query parameter.

Parameters:

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

useMediaTypeParam

ApiVersionInserter.Builder useMediaTypeParam(@Nullable String param)

Create an inserter to set a MediaType parameter on the "Content-Type" header.

Parameters:

param - the name of the media type parameter to hold the version

usePathSegment

ApiVersionInserter.Builder usePathSegment(@Nullable Integer pathSegmentIndex)

Configure the inserter to insert a path segment.

Parameters:

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

withVersionFormatter

ApiVersionInserter.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

ApiVersionInserter build()

Build the ApiVersionInserter instance.