xpipe-mirror/core/README.md

29 lines
1.6 KiB
Markdown
Raw Normal View History

2022-11-24 07:43:30 +00:00
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.xpipe/xpipe-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.xpipe/xpipe-core)
[![javadoc](https://javadoc.io/badge2/io.xpipe/xpipe-core/javadoc.svg)](https://javadoc.io/doc/io.xpipe/xpipe-core)
2022-03-10 18:38:57 +00:00
2023-05-20 14:23:36 +00:00
## XPipe Core
2022-03-09 21:51:04 +00:00
2023-05-20 14:23:36 +00:00
The XPipe core module contains all the shared core classes used by the API, beacon, and daemon implementation.
2022-11-24 07:43:30 +00:00
It contains the following packages:
2022-03-09 21:51:04 +00:00
2022-11-24 07:43:30 +00:00
- [charsetter](src/main/java/io/xpipe/core/charsetter): Classes for handling all things charset
related such as detection and handling of data streams with BOMs.
2022-03-09 21:51:04 +00:00
2022-11-24 07:43:30 +00:00
- [data](src/main/java/io/xpipe/core/data): Contains all definitions of the
2023-05-20 14:23:36 +00:00
internal XPipe data model and all the IO functionality to read and write these data structures.
For more information, see [XPipe data model](https://xpipe-io.readthedocs.io/en/latest/dev/model.html)
2022-03-09 21:51:04 +00:00
2022-11-24 07:43:30 +00:00
- [dialog](src/main/java/io/xpipe/core/dialog): In API to create server/daemon side CLI dialogs.
These are used by extensions for data source and data store configuration from the command line.
- [source](src/main/java/io/xpipe/core/source): The basic data source classes that are used by every data source implementation.
- [store](src/main/java/io/xpipe/core/store): The basic data store classes that are used by every data store implementation.
- [util](src/main/java/io/xpipe/core/source): A few utility classes for serialization and more.
2022-03-09 21:51:04 +00:00
Every class is expected to be potentially used in the context of files and message exchanges.
2022-11-24 07:43:30 +00:00
As a result, essentially all objects must be serializable/deserializable with jackson.
2022-06-17 22:29:41 +00:00