xpipe/core/README.md

21 lines
1 KiB
Markdown
Raw Normal View History

2022-03-11 07:38:57 +13:00
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.xpipe/core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.xpipe/core)
[![javadoc](https://javadoc.io/badge2/io.xpipe/core/javadoc.svg)](https://javadoc.io/doc/io.xpipe/core)
2022-03-10 10:51:04 +13:00
## X-Pipe Core
2022-06-18 10:29:41 +12:00
The X-Pipe core module contains all the shared core classes used by the API, beacon, and daemon implementation.
2022-03-10 10:51:04 +13:00
2022-06-18 10:29:41 +12:00
The main component is the [data package](src/main/java/io/xpipe/core/data).
2022-03-10 10:51:04 +13:00
It contains all definitions of the internal X-Pipe data model and all IO functionality for these data structures.
2022-06-18 10:29:41 +12:00
The [source package](src/main/java/io/xpipe/core/source) contains the basic data source classes,
which are used by every data source implementation.
2022-03-10 10:51:04 +13:00
2022-06-18 10:29:41 +12:00
The [store package](src/main/java/io/xpipe/core/store) contains the basic data store classes,
which are used by every data store implementation.
2022-03-10 10:51:04 +13:00
Every class is expected to be potentially used in the context of files and message exchanges.
2022-06-18 10:29:41 +12:00
As a result, all data structures exchanged must be serializable/deserializable with jackson.