Skip to content

BlackRookSoftware/ArcheText

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Black Rook ArcheText

Copyright (c) 2016-2020 Black Rook Software.
https://github.com/BlackRookSoftware/ArcheText

Latest Release
Online Javadoc
Quick Guide

Required Libraries

NONE

Required Java Modules

java.base

Where to Get

Introduction

This library reads and writes structured, hierarchical, textual data and contains utilities to convert them to POJOs and back.

This project was designed to replace DL. Unlike DL, ArcheText maintains definition hierarchy and supports value expressions.

Why?

JSON and XML are okay for laying out hierarchical data, but not when that data can be similar to other data or if that data is redundant. ArcheText seeks to eliminate this, as well as providing a means to de-serialize that data into Java Objects.

Library

Contained in this release is a series of libraries that allow reading, writing, and extracting data in ArcheText Objects, found in the com.blackrook.archetext package.

The ArcheTextObject class is used for the manipulation of the data once it has been read into Java via ArcheTextReader.

Compiling with Maven

To install/compile this library and make all artifacts with Apache Maven, type:

mvn install

To compile this library, type:

mvn compile

To make Maven-compatible JARs of this library, type:

mvn jar:jar

To make Javadocs:

mvn javadoc:javadoc

To run tests, type:

mvn test

To generate a coverage report, type:

mvn test jacoco:report

To clean up everything:

mvn clean

Other

This program and the accompanying materials are made available under the terms of the GNU Lesser Public License v2.1 which accompanies this distribution, and is available at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html

A copy of the LGPL should have been included in this release (LICENSE.txt). If it was not, please contact us for a copy, or to notify us of a distribution that has not included it.

This contains code copied from Black Rook Base, under the terms of the MIT License (docs/LICENSE-BlackRookBase.txt).

About

This library reads and writes structured, hierarchical, textual data and contains utilities to convert them to POJOs.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages