README.md

Skema

A fast and simple Java object serialization library based on Ahead-of-Time schema generation.

Getting Started

This project hast been tested with the

• Java SE Development Kit 8 [Download]

Other versions may work but are not supported officially.

Features

• On-the-fly schema generation for unregistered classes
• Random instance initialization
• Partial serialization and deserialization
• Optional off-heap memory usage
• No implementation needed
• Simple API

Usage

// Enable auto registration
Skema.enableAutoRegistration();

// Create an instance of your object
MyObject original = new MyObject();

// Serialize the object using Skema
byte[] buffer = Skema.serialize(original);

// Create a new instance of your object using the serialized data
MyObject copy = Skema.deserialize(MyObject.class, buffer);

Download

repositories {
    maven {
        url "https://dl.bintray.com/hhu-bsinfo/dxram"
    }
}

dependencies {
    implementation 'de.hhu.bsinfo:skema:1.0.0'
}

Running the tests

Since this project uses the Gradle build system running all included tests is possible using the following command.

./gradlew skema:test

Running the benchmark

This project includes a set of JMH benchmarks which can be executed using the following command.

./benchmark.sh

Built With

• Gradle - Build System

Authors

• Filip Krakowski [filkra]

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU GPLv3 License - see the LICENSE.md file for details.