Package org.springdoc.ui

Record Class AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig

java.lang.Object

java.lang.Record

org.springdoc.ui.AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig

Record Components:

cacheResources - whether to cache resources.

patterns - the patterns to match.

locations - the locations to use.

Enclosing class:

AbstractSwaggerConfigurer

protected static record AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig(boolean cacheResources, String[] patterns, String[] locations)
extends Record

The type Swagger resource handler config.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SwaggerResourceHandlerConfig(boolean cacheResources, String[] patterns, String[] locations)	Creates an instance of a SwaggerResourceHandlerConfig record class.

Method Summary

Modifier and Type	Method	Description
boolean	cacheResources()	Returns the value of the cacheResources record component.
static AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig	createCached()	Create a Swagger resource handler config with resource caching enabled.
static AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig	createUncached()	Create a Swagger resource handler config with resource caching disabled.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String[]	locations()	Returns the value of the locations record component.
String[]	patterns()	Returns the value of the patterns record component.
AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig	setLocations(String... locations)	Sets the locations.
AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig	setPatterns(String... patterns)	Sets the patterns.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SwaggerResourceHandlerConfig

protected SwaggerResourceHandlerConfig(boolean cacheResources,
 String[] patterns,
 String[] locations)

Creates an instance of a SwaggerResourceHandlerConfig record class.

Parameters:

cacheResources - the value for the cacheResources record component

patterns - the value for the patterns record component

locations - the value for the locations record component

Method Details

setPatterns

public AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig setPatterns(String... patterns)

Sets the patterns.

Parameters:

patterns - the patterns to match.

Returns:

the updated config.

setLocations

public AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig setLocations(String... locations)

Sets the locations.

Parameters:

locations - the locations to use.

Returns:

the updated config.

createCached

public static AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig createCached()

Create a Swagger resource handler config with resource caching enabled.

createUncached

public static AbstractSwaggerConfigurer.SwaggerResourceHandlerConfig createUncached()

Create a Swagger resource handler config with resource caching disabled.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

cacheResources

public boolean cacheResources()

Returns the value of the cacheResources record component.

Returns:

the value of the cacheResources record component

patterns

public String[] patterns()

Returns the value of the patterns record component.

Returns:

the value of the patterns record component

locations

public String[] locations()

Returns the value of the locations record component.

Returns:

the value of the locations record component