zpiddock/extremely-simple-storage

A simple library for handling serialization in a project.

Extremely Simple Storage

A Java library for saving data in an extremely simple way.

UPDATE

Version 1.1 includes api breaking changes, currently this is just a refactor in to a new package structure however in the future may include other changes!

Click HERE to view stable branch

Source Code

The latest source code for this project can be found on GitHub. If you are using Git, you can clone the project using the following command git clone https://github.com/ShadowChild/Extremely-Simple-Storage.

Building from Source

This project can be built using the Gradle Wrapper included in the repository. When the gradlew build command is executed from within the repo directory, a compiled JAR will be created in ~/build/libs. Sources and Javadocs will also be generated in the same directory. Alternatively the latest builds of Extremely Simple Storage along with Sources and Javadocs can be found here.

Contributing

This project is open to contributions from the public. If you would like to contribute to this project you can open an issue or create a new pull request. Pull requests are held to a high standard so please make sure to read the Contributing Guidelines before hand.

Quick Start

Extremely Simple Storage is very easy to use and understand. DataCompound objects can be created at any time, and hold information using string keys. Using the tools provided, these objects can then be written to file. The following code block shows an example of how this looks.

    // Creates a new DataCompound with various data stored.
    DataCompound data = new DataCompound();
    data.setValue("TestInteger", 1337);
    data.setValue("TestString", "Hello World!");
    data.setValue("TestIntegerArray", new int[] { 200, 200, 208, 208, 203, 205, 203, 205, 48, 30 });
    // Writes the DataCompound to a new file called Example.dat. Any extension can be used. 
    ESSFile.writeCompound(data, "Example.dat");
    Reads the DataCompound from the Example.dat file.
    data = ESSHelper.readCompound("Example.dat");

Dependency Management

If you are using Maven to manage your dependencies. Add the following into your pom.xml file. Make sure to update the version from time to time.

<repositories>
    <repository>
        <id>Innoxium</id>
        <url>https://repo.repsy.io/mvn/innoxium/innoxium/</url>
    </repository>
</repositories>

<dependency>
     <groupId>uk.co.innoxium.util</groupId>
     <artifactId>ExtremelySimpleStorage</artifactId>
     <version>1.0</version>
</dependency>

If you are using Gradle to manage your dependencies, add the following into your build.gradle file. Make sure to update the version from time to time.

repositories {

    maven {

        name 'Innoxium Repo'
        url "https://repo.repsy.io/mvn/innoxium/innoxium/"
    }
}

dependencies {

    compile "co.uk.innoxium.util:ExtremelySimpleStorage:1.0"
}

Legal Information

Extremely Simple Storage is licensed under the LGPL 2.1. Please see the LICENSE.txt for more details.

Credits

• Darkhax - Original Maintainer of Extremely Simple Storage.
• Lclc98 - Original Maintainer of build system and gradle setup.