Spring Core 6.1.4 · org.springframework.aot.hint.ResourceHints

Modifier and Type	Field and Description
private final Set<ResourceBundleHint>	resourceBundleHints
private final List<ResourcePatternHints>	resourcePatternHints
private final Set<TypeReference>	types

Access	Constructor and Description
public	ResourceHints()

Method Summary

Modifier and Type	Method and Description
public ResourceHints	Returns: `this`, to facilitate method chaining registerPattern(Consumer<ResourcePatternHints.Builder> a builder to further customize the resource pattern resourceHint) Register that the resources matching the specified pattern should be made available at runtime.
public ResourceHints	Returns: `this`, to facilitate method chaining registerPattern(String a pattern of the resources to include (see `ResourcePatternHint` documentation) include) Register that the resources matching the specified pattern should be made available at runtime.
public ResourceHints	Returns: `this`, to facilitate method chaining registerPatternIfPresent(ClassLoader the classloader to use classLoader, String a '/'-separated path name that should exist location, Consumer<ResourcePatternHints.Builder> a builder to customize the resource pattern resourceHint) Register a pattern if the given `location` is available on the classpath.
public void	registerResource(Resource the resource to register resource) Register that the supplied resource should be made available at runtime.
public ResourceHints	Returns: `this`, to facilitate method chaining registerResourceBundle(String the base name of the resource bundle baseName, Consumer<ResourceBundleHint.Builder> a builder to further customize the resource bundle resourceHint) Register that the resource bundle with the specified base name should be made available at runtime.
public ResourceHints	Returns: `this`, to facilitate method chaining registerResourceBundle(String the base name of the resource bundle baseName) Register that the resource bundle with the specified base name should be made available at runtime.
public ResourceHints	Returns: `this`, to facilitate method chaining registerType(TypeReference the type to include type) Register that the bytecode of the type defined by the specified `TypeReference` should be made available at runtime.
public ResourceHints	Returns: `this`, to facilitate method chaining registerType(Class<?> the type to include type) Register that the bytecode of the specified type should be made available at runtime.
public Stream<ResourceBundleHint>	Returns: a stream of `ResourceBundleHint` resourceBundleHints() Return the resource bundles that should be made available at runtime.
public Stream<ResourcePatternHints>	Returns: a stream of `ResourcePatternHints` resourcePatternHints() Return the resources that should be made available at runtime.
private String	toIncludePattern(TypeReference type)
private ResourcePatternHints	typesPatternResourceHint()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

resourceBundleHints	back to summary
private final Set<ResourceBundleHint> resourceBundleHints

resourcePatternHints	back to summary
private final List<ResourcePatternHints> resourcePatternHints

types	back to summary
private final Set<TypeReference> types

ResourceHints	back to summary
public ResourceHints()

Method Detail

registerPattern back to summary

registerPattern	back to summary
public ResourceHints registerPattern(Consumer<ResourcePatternHints.Builder> resourceHint) Register that the resources matching the specified pattern should be made available at runtime. Parameters resourceHint:Consumer<ResourcePatternHints.Builder> a builder to further customize the resource pattern Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerPattern(Consumer<ResourcePatternHints.Builder> resourceHint)

Parameters

resourceHint:Consumer<ResourcePatternHints.Builder>: a builder to further customize the resource pattern

Returns:ResourceHints

this, to facilitate method chaining

registerPattern back to summary

registerPattern	back to summary
public ResourceHints registerPattern(String include) Register that the resources matching the specified pattern should be made available at runtime. Parameters include:String a pattern of the resources to include (see `ResourcePatternHint` documentation) Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerPattern(String include)

Parameters

include:String: a pattern of the resources to include (see ResourcePatternHint documentation)

Returns:ResourceHints

this, to facilitate method chaining

registerPatternIfPresent back to summary

registerPatternIfPresent	back to summary
public ResourceHints registerPatternIfPresent(ClassLoader classLoader, String location, Consumer<ResourcePatternHints.Builder> resourceHint) Register a pattern if the given `location` is available on the classpath. This delegates to `ClassLoader#getResource(String)` which validates directories as well. The location is not included in the hint. Parameters classLoader:ClassLoader the classloader to use location:String a '/'-separated path name that should exist resourceHint:Consumer<ResourcePatternHints.Builder> a builder to customize the resource pattern Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerPatternIfPresent(ClassLoader classLoader, String location, Consumer<ResourcePatternHints.Builder> resourceHint)

Register a pattern if the given location is available on the classpath. This delegates to ClassLoader#getResource(String) which validates directories as well. The location is not included in the hint.

Parameters

classLoader:ClassLoader: the classloader to use
location:String: a '/'-separated path name that should exist
resourceHint:Consumer<ResourcePatternHints.Builder>: a builder to customize the resource pattern

Returns:ResourceHints

this, to facilitate method chaining

registerResource back to summary

registerResource	back to summary
public void registerResource(Resource resource) Register that the supplied resource should be made available at runtime. Parameters resource:Resource the resource to register Exceptions IllegalArgumentException: if the supplied resource is not a `ClassPathResource` or does not exist See Also `registerPattern(String)`, `ClassPathResource#getPath()`

public void registerResource(Resource resource)

Parameters

resource:Resource: the resource to register

Exceptions

IllegalArgumentException:: if the supplied resource is not a ClassPathResource or does not exist

registerResourceBundle back to summary

registerResourceBundle	back to summary
public ResourceHints registerResourceBundle(String baseName, Consumer<ResourceBundleHint.Builder> resourceHint) Register that the resource bundle with the specified base name should be made available at runtime. Parameters baseName:String the base name of the resource bundle resourceHint:Consumer<ResourceBundleHint.Builder> a builder to further customize the resource bundle Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerResourceBundle(String baseName, Consumer<ResourceBundleHint.Builder> resourceHint)

Parameters

baseName:String: the base name of the resource bundle
resourceHint:Consumer<ResourceBundleHint.Builder>: a builder to further customize the resource bundle

Returns:ResourceHints

this, to facilitate method chaining

registerResourceBundle back to summary

registerResourceBundle	back to summary
public ResourceHints registerResourceBundle(String baseName) Register that the resource bundle with the specified base name should be made available at runtime. Parameters baseName:String the base name of the resource bundle Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerResourceBundle(String baseName)

Parameters

baseName:String: the base name of the resource bundle

Returns:ResourceHints

this, to facilitate method chaining

registerType back to summary

registerType	back to summary
public ResourceHints registerType(TypeReference type) Register that the bytecode of the type defined by the specified `TypeReference` should be made available at runtime. Parameters type:TypeReference the type to include Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerType(TypeReference type)

Parameters

type:TypeReference: the type to include

Returns:ResourceHints

this, to facilitate method chaining

registerType back to summary

registerType	back to summary
public ResourceHints registerType(Class<?> type) Register that the bytecode of the specified type should be made available at runtime. Parameters type:Class<?> the type to include Returns:ResourceHints `this`, to facilitate method chaining

public ResourceHints registerType(Class<?> type)

Parameters

type:Class<?>: the type to include

Returns:ResourceHints

this, to facilitate method chaining

resourceBundleHints back to summary

resourceBundleHints	back to summary
public Stream<ResourceBundleHint> resourceBundleHints() Return the resource bundles that should be made available at runtime. Returns:Stream<ResourceBundleHint> a stream of `ResourceBundleHint`

public Stream<ResourceBundleHint> resourceBundleHints()

Return the resource bundles that should be made available at runtime.

Returns:Stream<ResourceBundleHint>: a stream of ResourceBundleHint

resourcePatternHints back to summary

resourcePatternHints	back to summary
public Stream<ResourcePatternHints> resourcePatternHints() Return the resources that should be made available at runtime. Returns:Stream<ResourcePatternHints> a stream of `ResourcePatternHints`

public Stream<ResourcePatternHints> resourcePatternHints()

Return the resources that should be made available at runtime.

Returns:Stream<ResourcePatternHints>: a stream of ResourcePatternHints

toIncludePattern	back to summary
private String toIncludePattern(TypeReference type)

typesPatternResourceHint	back to summary
private ResourcePatternHints typesPatternResourceHint()

public Class ResourceHints

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail