sanj0 / sanjo

Java library to read and write key-value pairs organized into classes specified by the sanjo format

sanjo

sanjo is a specification for an "object-orientated" key-value text format. "object orientated" as in: each key-value pair belongs to a class, classes can have subclasses. This repository also contains a java library for reading and writing sanjo data.

The format

:class
    .key=value
    .list[]=1,2,3,4
    :subclass
        .key=value
    .key=value
    :subclass
        :subclass
            .key=value

Class-affiliation is based on indention; every class and key-value pair with zero indention is a direct child of the default class. As of version 0.2, classes start with either : or >, values start with either . or ? and assignemts are either = or :

The sanjo java library

The library is built using maven, adding it as a dependency is thus as simple as adding the following snippet to your project's pom.xml file:

<dependencies>
    <dependency>
        <groupId>de.edgelord</groupId>
        <artifactId>sanjo</artifactId>
        <version>0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

Reading examples

import de.edgelord.sanjo.*;

public static void main(String[] args) {
    // parsing a sanjo dom from a list of sanjo "lines"
    final Parser listParser = new Parser();
    final SJClass listDataRoot.parse(Arrays.asList(".key=value"));

    // parsing a sanjo file
    final SanjoFile file = new SanjoFile("/path/to/file.sj");
    final Parser fileParser = file.parser();
    final SJClass fileDataRoot = fileParser.parse();

    // the SJClass return by Parser#parse(*)
    // is the data's "default" class, therefore 
    // every key-value pair and every defined class
    // is a direct of indirect child of the return "dataRoot"
    // said class can for example be used as follows:
    final SJValue value1 = listDataRoot.getValue("key");
    System.out.println(value1.string() + " is the value of key \"key\""");
    final int num = fileDataRoot.getChild("subclass").getValue("num")
        .intValue(); // SJValue extends class Number, therefore
                     // longValue(), doubleValue() and floatValue()
                     // are also available
    final SJValue value2 = SJAddress.forString(":subclass:subclass2.key")
        .apply(fileDataRoot);
    final SJClass subclass2 = SJAddress.forString(":subclass:subclass2")
        .apply(fileDataRoot);
}

Writing examples

import de.edgelord.sanjo.*;

public static void main(String[] args) {
    final SJClass generated = new SJClass("generated");
    generated.addValue("key", "value");
    generated.addChild("subclass").addValue("key", "value");
    System.out.println(generated.write());
    // output:
    /*
    *.key=value
    *:subclass
    *    .key=value
    */
}