Class PropertiesApiVersionInserter

java.lang.Object

org.springframework.boot.http.client.autoconfigure.PropertiesApiVersionInserter

All Implemented Interfaces:

ApiVersionInserter

public final class PropertiesApiVersionInserter
extends Object
implements ApiVersionInserter

ApiVersionInserter to apply ApiversionProperties.

Since:

4.0.0

Author:

Phillip Webb

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.web.client.ApiVersionInserter

ApiVersionInserter.Builder

Method Summary

Modifier and Type	Method	Description
static @Nullable ApiVersionInserter	get(@Nullable ApiVersionInserter apiVersionInserter, @Nullable ApiVersionFormatter apiVersionFormatter, Stream<ApiversionProperties> propertiesStream)	Factory method that returns an ApiVersionInserter to apply the given properties and delegate.
static @Nullable ApiVersionInserter	get(@Nullable ApiVersionInserter apiVersionInserter, @Nullable ApiVersionFormatter apiVersionFormatter, ApiversionProperties... properties)	Factory method that returns an ApiVersionInserter to apply the given properties and delegate.
URI	insertVersion(Object version, URI uri)
void	insertVersion(Object version, HttpHeaders headers)

Methods inherited from class java.lang.Object

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

Method Details

insertVersion

public URI insertVersion(Object version,
 URI uri)

Specified by:

insertVersion in interface ApiVersionInserter

insertVersion

public void insertVersion(Object version,
 HttpHeaders headers)

Specified by:

insertVersion in interface ApiVersionInserter

get

public static @Nullable ApiVersionInserter get(@Nullable ApiVersionInserter apiVersionInserter,
 @Nullable ApiVersionFormatter apiVersionFormatter,
 ApiversionProperties... properties)

Factory method that returns an ApiVersionInserter to apply the given properties and delegate.

Parameters:

apiVersionInserter - a delegate ApiVersionInserter that should also apply (may be null)

apiVersionFormatter - the version formatter to use or null

properties - the properties that should be applied

Returns:

an ApiVersionInserter or null if no API version should be inserted

get

public static @Nullable ApiVersionInserter get(@Nullable ApiVersionInserter apiVersionInserter,
 @Nullable ApiVersionFormatter apiVersionFormatter,
 Stream<ApiversionProperties> propertiesStream)

Factory method that returns an ApiVersionInserter to apply the given properties and delegate.

Parameters:

apiVersionInserter - a delegate ApiVersionInserter that should also apply (may be null)

apiVersionFormatter - the version formatter to use or null

propertiesStream - the properties that should be applied

Returns:

an ApiVersionInserter or null if no API version should be inserted