bit-badger/solutions.bitbadger.documents
1
0
Fork 0
Code Issues Pull Requests Packages Releases 1 Activity

Add API headings; add home content

Browse Source
This commit is contained in:
Daniel J. Summers 2025-04-16 08:05:25 -04:00
parent 5b321c498f
commit 1eec850724
2 changed files with 37 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
index.md
View File

@ -1,41 +1,56 @@
--- ---
_layout: landing _layout: landing
title: Welcome!
--- ---
Welcome! This project implements the [relational document](/) concepts for Java, Kotlin, Scala, and Groovy applications. Welcome! This project implements the [relational document](/) concepts for Java, Kotlin, Scala, and Groovy applications. It uses four different modules to provide an idiomatic developer experience across four major JVM languages.
## Modules ## Depend on Them
The coordinate structure for these packages is The coordinate structure for these packages is
```xml ```xml
<groupId>solutions.bitbadger.documents</groupId> <groupId>solutions.bitbadger.documents</groupId>
<artifactId>[package]</artifactId> <artifactId>[module]</artifactId>
<version>1.0.0-RC1</version> <version>1.0.0-RC1</version>
``` ```
### solutions.bitbadger.documents.core ### core &nbsp; [![Maven Central Version][core-badge]][core-mvn]
![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/core)
This module does most of the heavy lifting for all languages. It provides an optimal Java experience and an optimal Kotlin experience when using a reflection-based JSON serializer. Queries that can return one-or-none return an `Optional<T>` instance. This module also has Kotlin extensions on the <abbr title="Java Database Connectivity">JDBC</abbr> `Connection` type This module does most of the heavy lifting for all languages. It provides an optimal Java experience and an optimal Kotlin experience when using a reflection-based JSON serializer. Queries that can return one-or-none return an `Optional<T>` instance. This module also has Kotlin extensions on the <abbr title="Java Database Connectivity">JDBC</abbr> `Connection` type
### solutions.bitbadger.documents.groovy ### groovy &nbsp; [![Maven Central Version][groovy-badge]][groovy-mvn]
![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/groovy)
This far-out module provides Groovy-style extension methods on the `Connection` type. (Right on!) This far-out module provides Groovy-style extension methods on the `Connection` type. (Right on!)
### solutions.bitbadger.documents.scala ### scala &nbsp; [![Maven Central Version][scala-badge]][scala-mvn]
![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/scala)
This module provides a native Scala API for this library, using its collection types instead of the default Java collections, and returns the Scala `Option[A]` type for one-or-none queries. It also provides Scala extension methods for the `Connection` type. This module provides a native Scala API for this library, using its collection types instead of the default Java collections, and returns the Scala `Option[A]` type for one-or-none queries. It also provides Scala extension methods for the `Connection` type.
### solutions.bitbadger.documents.kotlinx ### kotlinx &nbsp; [![Maven Central Version][kotlinx-badge]][kotlinx-mvn]
![Maven Central Version](https://img.shields.io/maven-central/v/solutions.bitbadger.documents/kotlinx)
This module utilizes [`kotlix.serialization`][kotlinx] for its serialization and deserialization, which implements these actions without reflection. As its primary consumer is Kotlin, it returns `null` for one-or-none queries. This module utilizes [`kotlix.serialization`][kotlinx] for its serialization and deserialization, which implements these actions without reflection. As its primary consumer is Kotlin, it returns `null` for one-or-none queries.
## Read All about Them
- The "Docs" heading above will take you to the "Getting Started" page for these libraries, and is the entry point for all documentation (currently under active development).
- The "Core API" heading links to the JavaDoc for the `core` module. Groovy consumers can also review the `Connection` extension functions there.
- The "Scala API" heading links to the ScalaDoc for the `scala` module.
- The "KotlinX API" heading links to the JavaDoc for the `kotlinx` module.
## Talk about Them
Bit Badger Solutions' Git is not set up for account registration _(yet! -- Homer Simpson)_. However, the author can be reached as `@Bit_Badger` on Twitter, `daniel@fedi.summershome.org` on the Fediverse, or via e-mail as `daniel` at the parent domain to this site's domain. This project is open to the public, so you will be able to track the progress of any issues you may report.
[core-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/core
[core-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/core
[groovy-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/groovy
[groovy-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/groovy
[scala-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/scala
[scala-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/scala
[kotlinx-badge]: https://img.shields.io/maven-central/v/solutions.bitbadger.documents/kotlinx
[kotlinx-mvn]: https://central.sonatype.com/artifact/solutions.bitbadger.documents/kotlinx
[kotlinx]: https://github.com/Kotlin/kotlinx.serialization "KotlinX Serialization &bull; GitHub" [kotlinx]: https://github.com/Kotlin/kotlinx.serialization "KotlinX Serialization &bull; GitHub"

6
toc.yml
View File

@ -1,2 +1,8 @@
- name: Docs - name: Docs
href: docs/ href: docs/
- name: Core API
href: core/
- name: Scala API
href: scala/
- name: KotlinX API
href: kotlinx/