https://github.com/cubeengine/reflect
Typesafe serialization of data for Java
https://github.com/cubeengine/reflect
config cubeengine java library
Last synced: about 1 year ago
JSON representation
Typesafe serialization of data for Java
- Host: GitHub
- URL: https://github.com/cubeengine/reflect
- Owner: CubeEngine
- License: mit
- Created: 2013-10-19T14:06:04.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-21T00:05:56.000Z (over 1 year ago)
- Last Synced: 2025-03-21T01:21:54.056Z (over 1 year ago)
- Topics: config, cubeengine, java, library
- Language: Java
- Homepage: http://cubeisland.de
- Size: 755 KB
- Stars: 14
- Watchers: 8
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
=========
Typesafe serialization of data
[](http://mvnrepository.com/artifact/de.cubeisland.engine/reflect) (replace ```${reflectVersion}``` with this version)
[](https://travis-ci.org/CubeEngine/ReflecT)
# Using the library
## Dependencies
### Maven
To add the dependency using Maven just add the following section to your dependencies:
```xml
de.cubeisland.engine
reflect
${reflectVersion}
```
### Gradle
To add the dependency using Gradle just add the following line to your dependencies:
```groovy
compile 'de.cubeisland.engine:reflect:${reflectVersion}'
```
## Dependencies for Android
Using this library with Android is a little more difficult as the snakeyaml dependency
doesn't work with Android. Nevertheless you can use it by following these steps:
1. download the snakeyaml-android.jar from this page: [snakeyaml-android](http://code.google.com/p/snakeyaml/downloads/detail?name=snakeyaml-android-1.8-SNAPSHOT.jar&can=2&q=)
2. copy the file to your project/module
3. add the following section to your dependencies:
* Maven:
```xml
de.cubeisland.engine
reflect
${reflectVersion}
org.yaml
snakeyaml
org.yaml
snakeyaml
1.14
system
${basedir}/RELATIVE_PATH_TO_SNAKEYAML_ANDROID_JAR
```
* Gradle:
```groovy
compile ('de.cubeisland.engine:reflect:${reflectVersion}')
{
exclude group: 'org.yaml', module: 'snakeyaml'
}
compile files('RELATIVE_PATH_TO_SNAKEYAML_ANDROID_JAR')
```
(Please note: edit the "RELATIVE_PATH_TO_SNAKEYAML_ANDROID_JAR" part!)
## Usage example (in a Bukkit plugin) as a Configuration
```java
public class ExamplePlugin extends JavaPlugin
{
// Create the Factory
private Reflector factory = new Reflector();
private MyConfig config;
public void onEnable()
{
File file = new File(this.getDataFolder(), "config.yml");
// load the reflected using the factory (this will also save after loading)
config = factory.load(MyConfig.class, file);
// at any time you can reload the reflected object
config.reload(); // this will also save the reflected object!
// or save the reflected object
config.save();
}
// The Reflected Class
public class MyConfig extends ReflectedYaml // this is the same as extends Reflected
{
public transient boolean noSaving; // fields that are transient are ignored
// the path is generated from the field: lots-of-saving
public boolean lotsOfSaving = true; // set default values (will be set if not loaded OR field is missing in file)
@Name("default")
public String defaultString = "You can define the path with an annotation instead. e.g. if you want to use \"default\"";
// path will be: sub.section
@Comment({"You can comment every field.","Even with multiple lines\nand this linebreak works too"})
public SubSection sub_section; // You do not NEED to set the default here ; it is done automatically
// You can use sections instead of setting the whole path for every field
public class SubSection implements Section
{
// path will be: sub.section.an-int
public int anInt = 42;
// path will be: sub.section.a-long
public long aLong = 666;
}
}
}
```