diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/markdown/snippets/jar-resources.md | 34 | ||||
| -rw-r--r-- | docs/yaml/functions/jar.yaml | 4 |
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/markdown/snippets/jar-resources.md b/docs/markdown/snippets/jar-resources.md new file mode 100644 index 0000000..12b0c81 --- /dev/null +++ b/docs/markdown/snippets/jar-resources.md @@ -0,0 +1,34 @@ +## JAR Resources + +The ability to add resources to a JAR has been added. Use the `java_resources` +keyword argument. It takes a `sturctured_src` object. + +```meson +jar( + meson.project_name(), + sources, + main_class: 'com.mesonbuild.Resources', + java_resources: structured_sources( + files('resources/resource1.txt'), + { + 'subdir': files('resources/subdir/resource2.txt'), + } + ) +) +``` + +To access these resources in your Java application: + +```java +try (InputStreamReader reader = new InputStreamReader( + Resources.class.getResourceAsStream("/resource1.txt"), + StandardCharsets.UTF_8)) { + // ... +} + +try (InputStreamReader reader = new InputStreamReader( + Resources.class.getResourceAsStream("/subdir/resource2.txt"), + StandardCharsets.UTF_8)) { + // ... +} +``` diff --git a/docs/yaml/functions/jar.yaml b/docs/yaml/functions/jar.yaml index 6e8e5dd..52f66e5 100644 --- a/docs/yaml/functions/jar.yaml +++ b/docs/yaml/functions/jar.yaml @@ -14,3 +14,7 @@ kwargs: main_class: type: str description: Main class for running the built jar + java_resources: + type: structured_src + since: 0.62.0 + description: Resources to be added to the jar |