Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akkinoc/yaml-resource-bundle
Java ResourceBundle for YAML format.
https://github.com/akkinoc/yaml-resource-bundle
java java-library kotlin kotlin-library yaml
Last synced: 7 days ago
JSON representation
Java ResourceBundle for YAML format.
- Host: GitHub
- URL: https://github.com/akkinoc/yaml-resource-bundle
- Owner: akkinoc
- License: apache-2.0
- Created: 2015-08-14T07:01:17.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T23:45:38.000Z (2 months ago)
- Last Synced: 2024-10-24T13:22:00.458Z (2 months ago)
- Topics: java, java-library, kotlin, kotlin-library, yaml
- Language: Kotlin
- Homepage:
- Size: 706 KB
- Stars: 53
- Watchers: 4
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# yaml-resource-bundle
[![maven central badge]][maven central]
[![javadoc badge]][javadoc]
[![release badge]][release]
[![build badge]][build]
[![codecov badge]][codecov]
[![license badge]][license]
[![sponsor badge]][sponsor]
[maven central]: https://maven-badges.herokuapp.com/maven-central/dev.akkinoc.util/yaml-resource-bundle
[maven central badge]: https://maven-badges.herokuapp.com/maven-central/dev.akkinoc.util/yaml-resource-bundle/badge.svg
[javadoc]: https://javadoc.io/doc/dev.akkinoc.util/yaml-resource-bundle
[javadoc badge]: https://javadoc.io/badge2/dev.akkinoc.util/yaml-resource-bundle/javadoc.svg
[release]: https://github.com/akkinoc/yaml-resource-bundle/releases
[release badge]: https://img.shields.io/github/v/release/akkinoc/yaml-resource-bundle?color=brightgreen&sort=semver
[build]: https://github.com/akkinoc/yaml-resource-bundle/actions/workflows/build.yml
[build badge]: https://github.com/akkinoc/yaml-resource-bundle/actions/workflows/build.yml/badge.svg
[codecov]: https://codecov.io/gh/akkinoc/yaml-resource-bundle
[codecov badge]: https://codecov.io/gh/akkinoc/yaml-resource-bundle/branch/main/graph/badge.svg
[license]: LICENSE.txt
[license badge]: https://img.shields.io/github/license/akkinoc/yaml-resource-bundle?color=blue
[sponsor]: https://github.com/sponsors/akkinoc
[sponsor badge]: https://img.shields.io/static/v1?logo=github&label=sponsor&message=%E2%9D%A4&color=db61a2
[Java ResourceBundle] for YAML format.
[Java ResourceBundle]: https://docs.oracle.com/javase/8/docs/api/java/util/ResourceBundle.html
## Features
* Accesses YAML-formatted resources via ResourceBundle.
* Supports locale-specific resources according to the ResourceBundle specification.
* Supports YAML values nested in a map or list.
* Supports YAML anchors and aliases indicated by `&` and `*`.
* Supports multiple YAML documents separated by `---`.
## Dependencies
Depends on:
* Java 8, 11, 17 or 21
* Kotlin 1.9
* SnakeYAML 2.2
## Usage
### Adding the Dependency
The artifact is published on [Maven Central Repository][maven central].
If you are using Maven, add the following dependency.
```xml
dev.akkinoc.util
yaml-resource-bundle
${yaml-resource-bundle.version}
```
### Creating Resource Files
Create a YAML-formatted resource file on the classpath.
Also, create locale-specific resource files as needed.
For example (resource.yml, resource_en.yml, resource_fr.yml, etc):
```yaml
fruits:
apple: Apple
orange: Orange
grape: Grape
colors:
- Red
- Orange
- Purple
```
### Accessing the Resource
Access the resource via YamlResourceBundle.
For example in Java:
```java
import dev.akkinoc.util.YamlResourceBundle;
```
```java
// Gets the resource bundle
// YamlResourceBundle.Control is specified for ResourceBundle.Control
ResourceBundle bundle = ResourceBundle.getBundle(
"resource", YamlResourceBundle.Control.INSTANCE);
// Gets the map values
System.out.println(bundle.getString("fruits.apple")); // => "Apple" or localized value
System.out.println(bundle.getString("fruits.orange")); // => "Orange" or localized value
System.out.println(bundle.getString("fruits.grape")); // => "Grape" or localized value
// Gets the list values
System.out.println(bundle.getString("colors[0]")); // => "Red" or localized value
System.out.println(bundle.getString("colors[1]")); // => "Orange" or localized value
System.out.println(bundle.getString("colors[2]")); // => "Purple" or localized value
// Gets the list values as an array
System.out.println(Arrays.toString(bundle.getStringArray("colors")));
// => "[Red, Orange, Purple]" or localized values
// Gets the all keys
System.out.println(bundle.keySet());
// => "[fruits.apple, fruits.orange, fruits.grape,
// colors, colors[0], colors[1], colors[2]]" (not sorted)
```
## API Reference
Please refer to the [Javadoc][javadoc].
## Release Notes
Please refer to the [Releases][release] page.
## License
Licensed under the [Apache License, Version 2.0][license].
## Support the Project
If this project is useful to you, I appreciate giving a ⭐ star to this repository.
I would also appreciate if you would consider 💖 [sponsoring][sponsor] as well.
Your support is my biggest motive force. Thanks ✨