Package org.springframework.aot.hint
Class ResourceHints
java.lang.Object
org.springframework.aot.hint.ResourceHints
Gather the need for resources available at runtime.
- Since:
- 6.0
- Author:
- Stephane Nicoll, Sam Brannen
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionregisterPattern
(String include) Register that the resources matching the specified pattern should be made available at runtime.registerPattern
(Consumer<ResourcePatternHints.Builder> resourceHint) Register that the resources matching the specified pattern should be made available at runtime.registerPatternIfPresent
(ClassLoader classLoader, String location, Consumer<ResourcePatternHints.Builder> resourceHint) Register a pattern if the givenlocation
is available on the classpath.void
registerResource
(Resource resource) Register that the supplied resource should be made available at runtime.registerResourceBundle
(String baseName) Register that the resource bundle with the specified base name should be made available at runtime.registerResourceBundle
(String baseName, Consumer<ResourceBundleHint.Builder> resourceHint) Register that the resource bundle with the specified base name should be made available at runtime.registerType
(Class<?> type) Register that the bytecode of the specified type should be made available at runtime.registerType
(TypeReference type) Register that the bytecode of the type defined by the specifiedTypeReference
should be made available at runtime.Return the resource bundles that should be made available at runtime.Return the resources that should be made available at runtime.
-
Constructor Details
-
ResourceHints
public ResourceHints()
-
-
Method Details
-
resourcePatternHints
Return the resources that should be made available at runtime.- Returns:
- a stream of
ResourcePatternHints
-
resourceBundleHints
Return the resource bundles that should be made available at runtime.- Returns:
- a stream of
ResourceBundleHint
-
registerPatternIfPresent
public ResourceHints registerPatternIfPresent(@Nullable ClassLoader classLoader, String location, Consumer<ResourcePatternHints.Builder> resourceHint) Register a pattern if the givenlocation
is available on the classpath. This delegates toClassLoader.getResource(String)
which validates directories as well. The location is not included in the hint.- Parameters:
classLoader
- the classloader to uselocation
- a '/'-separated path name that should existresourceHint
- a builder to customize the resource pattern- Returns:
this
, to facilitate method chaining
-
registerPattern
Register that the resources matching the specified pattern should be made available at runtime.- Parameters:
resourceHint
- a builder to further customize the resource pattern- Returns:
this
, to facilitate method chaining
-
registerPattern
Register that the resources matching the specified pattern should be made available at runtime.- Parameters:
include
- a pattern of the resources to include (seeResourcePatternHint
documentation)- Returns:
this
, to facilitate method chaining
-
registerResource
Register that the supplied resource should be made available at runtime.- Parameters:
resource
- the resource to register- Throws:
IllegalArgumentException
- if the supplied resource is not aClassPathResource
or does not exist- See Also:
-
registerType
Register that the bytecode of the type defined by the specifiedTypeReference
should be made available at runtime.- Parameters:
type
- the type to include- Returns:
this
, to facilitate method chaining
-
registerType
Register that the bytecode of the specified type should be made available at runtime.- Parameters:
type
- the type to include- Returns:
this
, to facilitate method chaining
-
registerResourceBundle
public ResourceHints registerResourceBundle(String baseName, @Nullable Consumer<ResourceBundleHint.Builder> resourceHint) Register that the resource bundle with the specified base name should be made available at runtime.- Parameters:
baseName
- the base name of the resource bundleresourceHint
- a builder to further customize the resource bundle- Returns:
this
, to facilitate method chaining
-
registerResourceBundle
Register that the resource bundle with the specified base name should be made available at runtime.- Parameters:
baseName
- the base name of the resource bundle- Returns:
this
, to facilitate method chaining
-