carm/EasyConfiguration
carm/EasyConfiguration
1
Fork 0
mirror of https://github.com/CarmJos/EasyConfiguration.git synced 2024-09-19 20:25:51 +00:00
Code Issues Releases Activity

docs(sample): Add sample codes. 🥚

Browse Source
This commit is contained in:
Carm Jos 2024-01-04 21:20:56 +08:00
parent 9647591b0d
commit 0d19dc236e
3 changed files with 58 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -49,10 +49,8 @@ Check out all code demonstrations [HERE](demo/src/main/java/cc/carm/lib/configur
For more examples, see the [Development Guide](.doc/README.md).
```java
public class Sample {
@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {
@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {
@InlineComment("Enabled?") // Inline comment
ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);
@ -73,8 +71,11 @@ public class Sample {
ConfiguredValue<Integer> AGE = ConfiguredValue.of(24);
}
}
}
```
```java
public class Sample {
public static void main(String[] args) {
// 1. Make a configuration provider from a file.
ConfigurationProvider<?> provider = EasyConfiguration.from("config.yml");
@ -84,7 +85,6 @@ public class Sample {
SampleConfig.ENABLED.set(false);
System.out.println("Your name is " + SampleConfig.INFO.NAME.getNotNull() + " !");
}
}
```

16
README_CN.md
View File

@ -42,11 +42,10 @@ README LANGUAGES [ [English](README.md) | [**中文**](README_CN.md) ]
您可以 [点击这里](demo/src/main/java/cc/carm/lib/configuration/demo) 直接查看现有的代码演示，更多复杂情况演示详见 [开发介绍](.doc/README.md) 。
```java
public class Sample {
@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {
```java
@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {
@InlineComment("Enabled?") // 行内注释
ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);
@ -65,9 +64,13 @@ public class Sample {
@ConfigPath("year") // 自定义配置路径，若不定义，则按照默认规则生成
ConfiguredValue<Integer> AGE = ConfiguredValue.of(24);
}
}
}
}
```
```java
public class Sample {
public static void main(String[] args) {
// 1. 生成一个 “Provider” 用于给配置类提供源配置的文件。
ConfigurationProvider<?> provider = EasyConfiguration.from("config.yml");
@ -77,7 +80,6 @@ public class Sample {
SampleConfig.ENABLED.set(false);
System.out.println("Your name is " + SampleConfig.INFO.NAME.getNotNull() + " !");
}
}
```

10
impl/yaml/src/test/java/config/Sample.java
View File

@ -11,10 +11,8 @@ import cc.carm.lib.configuration.core.value.type.ConfiguredValue;
import java.util.UUID;
public class Sample {
@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {
@HeaderComment("Configurations for sample")
interface SampleConfig extends Configuration {
@InlineComment("Enabled?") // Inline comment
ConfiguredValue<Boolean> ENABLED = ConfiguredValue.of(true);
@ -34,7 +32,9 @@ public class Sample {
ConfiguredValue<Integer> AGE = ConfiguredValue.of(24);
}
}
}
public class Sample {
public static void main(String[] args) {
// 1. Make a configuration provider from a file.