XBUP - eXtensible Binary Universal Protocol - Documentation
[Up]

# Java Implementation Documentation

Implementation in Java programming language was chosen as primary environment for prototype implementation. It is organized into modules and can be build using Gradle build tool.

## Libraries

There are basic libraries with functionality related to protocol itself and services, additional libraries with some degree of support for various data types and libraries related to editor tools used for demonstration purposes.

For the documentation of classes and methods please see JavaDoc.

## Basic Libraries

- xbup-core - Core library with basic support for XBUP encoding
- xbup-catalog - Library for catalog of types
- xbup-framework-client - Library for framework clients
- xbup-framework-service - Library for framework service
- xbup-parser-tree - Library for object model / tree parser
- xbup-parser-command - Library for command parser

## Additional Libraries

- xbup-plugin - Library for plugins support
- xbup-operation - Library for undo/redo and complex operations handling
- xbup-audio - Library for functionality related to audio data processing
- xbup-visual - Library for functionality related to visual data processing

## Editor-related Libraries

- xbup-editor-base - Library for editor modules handling
- xbup-editor-base-api - Library for editor modules handling API
- xbup-editor-module-frame - Library for editor main frame
- xbup-editor-module-java_help - Library for java help editor module
- xbup-editor-module-online_help - Library for online help editor module
- xbup-editor-module-service_manager - Library for service management editor module
- xbup-editor-module-xbdoc_editor - Library for xbup-encoded document editor module
- xbup-editor-module-text_editor - Library for text editor module
- xbup-editor-module-picture_editor - Library for picture editor module
- xbup-editor-module-wave_editor - Library for wave editor module

## Tools

Implementation includes following tools for manipulation with XBUP-encoded documents:

### Basic Tools

- XBEditor - Basic editor allowing to view and edit document as a tree or text file or in hexadecimal mode
- XBManager - Tool for accessing XBUP catalog or framework services
- XBService - Tool for service runtime control
- XBShell - Support for browsing content of document on the text command line
- XBCatalogWeb - Web service for accessing XBUP catalog or framework service

### Sample Editors

There are also demo applications available that allow work with some simple testing formats.

- LRUB 1 Demo - Demonstration application for number encoding
- XBTEditor - Simple text editor
- XBPEditor - Simple picture editor
- XBSEditor - Simple audio editor

Homepage: http://xbup.org
License: GNU Free Documentation License (FDL)