Skip to content

Commit

Permalink
added meta-info module
Browse files Browse the repository at this point in the history
  • Loading branch information
hohwille committed Dec 12, 2023
1 parent 5027141 commit 2ba5e10
Show file tree
Hide file tree
Showing 19 changed files with 1,460 additions and 3 deletions.
66 changes: 65 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,13 @@ The module `io.github.mmm.base` (artifactId `mmm-base`) provides a minimal set o
This library offers the following features:

* `ApplicationException` for exceptions with `UUID`, `code`, and distinction between user and technical errors.
* `CharFilter` interface
* `CharFilter` interface and implementations
* `Justification` to justify strings
* Placements such as `Alignment`, `Direction`, `Orientation`, etc.
* Converter and parser for `Temporal` values
* `CompareOperator` to compate strings, numbers, temporals, or any other comparable object
* `CaseHelper` to deal with lower/upper case
* etc.

== Usage

Expand All @@ -37,3 +38,66 @@ Module Dependency:
```java
requires transitive io.github.mmm.base;
```

= mmm-base-metainfo

image:https://img.shields.io/maven-central/v/io.github.m-m-m/mmm-base-metainfo.svg?label=Maven%20Central["Maven Central",link=https://search.maven.org/search?q=g:io.github.m-m-m]
image:https://javadoc.io/badge2/io.github.m-m-m/mmm-base-metainfo/javadoc.svg["base JavaDoc", link=https://javadoc.io/doc/io.github.m-m-m/mmm-base-metainfo]

The module `io.github.mmm.base.metainfo` (artifactId `mmm-base-metainfo`) provides a minimal set of APIs for dealing with meta-information.

== Features

This library offers the following features:

* `MetaInfo` interface to instantiate and access meta-information.
* `MetaInfos` to annotate meta-information.

== Usage

Maven Dependency:
```xml
<dependency>
<groupId>io.github.m-m-m</groupId>
<artifactId>mmm-base-metainfo</artifactId>
<version>${mmm.base.version}</version>
</dependency>
```

Module Dependency:
```java
requires transitive io.github.mmm.base.metainfo;
```

= mmm-base-placement

image:https://img.shields.io/maven-central/v/io.github.m-m-m/mmm-base-placement.svg?label=Maven%20Central["Maven Central",link=https://search.maven.org/search?q=g:io.github.m-m-m]
image:https://javadoc.io/badge2/io.github.m-m-m/mmm-base-placement/javadoc.svg["base JavaDoc", link=https://javadoc.io/doc/io.github.m-m-m/mmm-base-placement]

The module `io.github.mmm.base.placement` (artifactId `mmm-base-placement`) provides a enums for placement.

== Features

This library offers the following enums:

* `Alignment` for 2-D alignments.
* `Direction` for 2-D direction.
* `HorizontalAlignment` for horizontal alignment (1-D).
* `Orientation` with `HORIZONTAL` and `VERTICAL`.
* `VerticalAlignment` for vertical alignment (1-D).

== Usage

Maven Dependency:
```xml
<dependency>
<groupId>io.github.m-m-m</groupId>
<artifactId>mmm-base-placement</artifactId>
<version>${mmm.base.version}</version>
</dependency>
```

Module Dependency:
```java
requires transitive io.github.mmm.base.placement;
```
20 changes: 20 additions & 0 deletions metainfo/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>io.github.m-m-m</groupId>
<artifactId>mmm-base-parent</artifactId>
<version>${revision}</version>
</parent>
<artifactId>mmm-base-metainfo</artifactId>
<packaging>jar</packaging>
<name>${project.artifactId}</name>
<description>Representation of generic metadata.</description>
<dependencies>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>mmm-base</artifactId>
</dependency>
</dependencies>
</project>
Loading

0 comments on commit 2ba5e10

Please sign in to comment.