Package io.quarkus.deployment.builditem.nativeimage

Class NativeImageResourcePatternsBuildItem

java.lang.Object

io.quarkus.builder.item.BuildItem

io.quarkus.builder.item.MultiBuildItem

io.quarkus.deployment.builditem.nativeimage.NativeImageResourcePatternsBuildItem

public final class NativeImageResourcePatternsBuildItem
extends io.quarkus.builder.item.MultiBuildItem

A build item that indicates that a set of resource paths defined by regular expression patterns or globs should be included in the native image.

Globs passed to the includeGlob*() methods of the NativeImageResourcePatternsBuildItem.Builder are transformed to regular expressions internally. See NativeConfig.ResourcesConfig.includes() for the supported glob syntax.

The patterns are passed to the native image builder using resource-config.json. The same mechanism (and regular expression syntax) is used by native-image's -H:ResourceConfigurationFiles, -H:IncludeResources and -H:ExcludeResources (since GraalVM 20.3.0) command line options.

Related build items:

• Use NativeImageResourceBuildItem if you need to add a single resource
• Use NativeImageResourceDirectoryBuildItem if you need to add a directory of resources

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NativeImageResourcePatternsBuildItem.Builder

Method Summary

Modifier and Type	Method	Description
static NativeImageResourcePatternsBuildItem.Builder	builder()
List<String>	getExcludePatterns()	Deprecated, for removal: This API element is subject to removal in a future version. Excluding resources is not supported in the new reachability-metadata.json file used with Mandrel/GraalVM 25.0 and onwards.
List<String>	getIncludePatterns()

Methods inherited from class java.lang.Object

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

Method Details

getExcludePatterns

@Deprecated(since="3.29",
            forRemoval=true)
public List<String> getExcludePatterns()

Deprecated, for removal: This API element is subject to removal in a future version.

Excluding resources is not supported in the new reachability-metadata.json file used with Mandrel/GraalVM 25.0 and onwards. Quarkus plans to adopt the use of reachability-metadata.json for Mandrel/GraalVM 23.1 for JDK 21 as well (see https://github.com/quarkusio/quarkus/issues/41016)

getIncludePatterns

public List<String> getIncludePatterns()

builder

public static NativeImageResourcePatternsBuildItem.Builder builder()