ConfigurationAPI

A Configuration API for Java

Лицензия

Лицензия

The MIT License (MIT)
Категории

Категории

Configuration Библиотеки уровня приложения config
Группа

Группа

de.cubeisland.engine
Идентификатор

Идентификатор

configuration
Последняя версия

Последняя версия

1.0.3
Дата

Дата

Тип

Тип

jar
Описание

Описание

ConfigurationAPI
A Configuration API for Java
Система контроля версий

Система контроля версий

https://github.com/CubeEngineDev/ConfigurationAPI

Скачать configuration

Как подключить последнюю версию

<!-- https://jarcasting.com/artifacts/de.cubeisland.engine/configuration/ -->
<dependency>
    <groupId>de.cubeisland.engine</groupId>
    <artifactId>configuration</artifactId>
    <version>1.0.3</version>
</dependency>
// https://jarcasting.com/artifacts/de.cubeisland.engine/configuration/
implementation 'de.cubeisland.engine:configuration:1.0.3'
// https://jarcasting.com/artifacts/de.cubeisland.engine/configuration/
implementation ("de.cubeisland.engine:configuration:1.0.3")
'de.cubeisland.engine:configuration:jar:1.0.3'
<dependency org="de.cubeisland.engine" name="configuration" rev="1.0.3">
  <artifact name="configuration" type="jar" />
</dependency>
@Grapes(
@Grab(group='de.cubeisland.engine', module='configuration', version='1.0.3')
)
libraryDependencies += "de.cubeisland.engine" % "configuration" % "1.0.3"
[de.cubeisland.engine/configuration "1.0.3"]

Зависимости

compile (1)

Идентификатор библиотеки Тип Версия
org.yaml : snakeyaml jar 1.12

test (1)

Идентификатор библиотеки Тип Версия
junit : junit jar 4.11

Модули Проекта

Данный проект не имеет модулей.

Reflec<T>

Typesafe serialization of data

Maven Central (replace ${reflectVersion} with this version)

Build Status

Using the library

Dependencies

Maven

To add the dependency using Maven just add the following section to your dependencies:

<dependency>
    <groupId>de.cubeisland.engine</groupId>
    <artifactId>reflect</artifactId>
    <version>${reflectVersion}</version>
</dependency>

Gradle

To add the dependency using Gradle just add the following line to your dependencies:

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

  2. copy the file to your project/module

  3. add the following section to your dependencies:

    • Maven:
    <dependency>
        <groupId>de.cubeisland.engine</groupId>
        <artifactId>reflect</artifactId>
        <version>${reflectVersion}</version>
        <exclusions>
            <exclusion>
                <groupId>org.yaml</groupId>
                <artifactId>snakeyaml</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <dependency>
        <artifactId>org.yaml</artifactId>
        <groupId>snakeyaml</groupId>
        <version>1.14</version>
        <scope>system</scope>
        <systemPath>${basedir}/RELATIVE_PATH_TO_SNAKEYAML_ANDROID_JAR</systemPath>
    </dependency>
    • Gradle:
    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

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<YamlCodec>
    {
        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;
        }
    }
}

Версии библиотеки

Версия
1.0.3
1.0.2
1.0.1
1.0.0
0.1.0
0.0.3
0.0.2