Class ApiVersionHolder

java.lang.Object

org.springframework.web.accept.ApiVersionHolder

public final class ApiVersionHolder
extends Object

Simple container of the API version for a request (possibly null), or an exception that resulted from trying to resolve, parse, and validate the version.

While an API version needs to be initialized early, given that each HandlerMapping may or may not expect an API version, it is important to defer raising API version errors until it is known if the HandlerMapping will handle the request.

Since:

7.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field	Description
static final ApiVersionHolder	EMPTY	Static instance for a request without an API version.

Method Summary

Modifier and Type	Method	Description
static ApiVersionHolder	fromError(@Nullable RuntimeException ex)
static ApiVersionHolder	fromVersion(@Nullable Comparable<?> version)
RuntimeException	getError()
Comparable<?>	getVersion()
@Nullable Comparable<?>	getVersionIfPresent()
boolean	hasError()
boolean	hasVersion()

Methods inherited from class Object

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

Field Details

EMPTY

public static final ApiVersionHolder EMPTY

Static instance for a request without an API version.

Method Details

hasVersion

public boolean hasVersion()

hasError

public boolean hasError()

getVersion

public Comparable<?> getVersion()

getVersionIfPresent

public @Nullable Comparable<?> getVersionIfPresent()

getError

public RuntimeException getError()

fromVersion

public static ApiVersionHolder fromVersion(@Nullable Comparable<?> version)

fromError

public static ApiVersionHolder fromError(@Nullable RuntimeException ex)