blob: 0ba7fb617798d9c07c3de098f9e55710a817d170 [file] [log] [blame]
Matthias Andreas Benkardb5d657a2022-02-03 21:14:30 +01001// SPDX-FileCopyrightText: © 2021 Matthias Andreas Benkard <code@mail.matthias.benkard.de>
2//
3// SPDX-License-Identifier: LGPL-3.0-or-later
4
Matthias Andreas Benkard15456c82024-07-20 10:52:54 +02005import org.jspecify.annotations.NullMarked;
6
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +01007/**
Matthias Andreas Benkardaa294842021-12-28 01:31:56 +01008 * {@link eu.mulk.jgvariant.core.Decoder} instances for OSTree repositories.
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +01009 *
10 * <ul>
11 * <li><a href="#sect-overview">Overview</a>
12 * <li><a href="#sect-installation">Installation</a>
13 * </ul>
14 *
15 * <h2 id="sect-overview">Overview</h2>
16 *
17 * <p>The {@link eu.mulk.jgvariant.ostree} package contains record classes describing the elements
18 * of <a href="https://ostreedev.github.io/ostree/">OSTree</a> repositories and factory methods to
19 * create {@link eu.mulk.jgvariant.core.Decoder} instances for them.
20 *
21 * <h2 id="sect-installation">Installation</h2>
22 *
23 * <ul>
24 * <li><a href="#sect-installation-maven">Usage with Maven</a>
25 * <li><a href="#sect-installation-gradle">Usage with Gradle</a>
26 * </ul>
27 *
28 * <h3 id="sect-installation-maven">Usage with Maven</h3>
29 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020030 * {@snippet lang="xml" :
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010031 * <project>
32 * ...
33 *
34 * <dependencyManagement>
35 * ...
36 *
37 * <dependencies>
38 * <dependency>
39 * <groupId>eu.mulk.jgvariant</groupId>
40 * <artifactId>jgvariant-bom</artifactId>
Matthias Andreas Benkard15310a22024-07-22 06:34:17 +020041 * <version>0.1.10</version>
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010042 * <type>pom</type>
43 * <scope>import</scope>
44 * </dependency>
45 * </dependencies>
46 *
47 * ...
48 * </dependencyManagement>
49 *
50 * <dependencies>
51 * ...
52 *
53 * <dependency>
54 * <groupId>eu.mulk.jgvariant</groupId>
55 * <artifactId>jgvariant-core</artifactId>
56 * </dependency>
57 * <dependency>
58 * <groupId>eu.mulk.jgvariant</groupId>
59 * <artifactId>jgvariant-ostree</artifactId>
60 * </dependency>
61 *
62 * ...
63 * </dependencies>
64 *
65 * ...
66 * </project>
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020067 * }
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010068 *
69 * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
70 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020071 * {@snippet lang="groovy" :
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010072 * dependencies {
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020073 * // ...
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010074 *
Matthias Andreas Benkard15310a22024-07-22 06:34:17 +020075 * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.10"))
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010076 * implementation("eu.mulk.jgvariant:jgvariant-core")
77 * implementation("eu.mulk.jgvariant:jgvariant-ostree")
78 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020079 * // ...
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010080 * }
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020081 * }
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010082 */
Matthias Andreas Benkard15456c82024-07-20 10:52:54 +020083@NullMarked
Matthias Andreas Benkarda7e9d522021-12-28 01:37:47 +010084module eu.mulk.jgvariant.ostree {
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010085 requires transitive eu.mulk.jgvariant.core;
Matthias Andreas Benkarde0022372022-10-09 19:32:25 +020086
Matthias Andreas Benkard50a626d2021-12-30 19:13:49 +010087 requires org.tukaani.xz;
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010088
Matthias Andreas Benkarde0022372022-10-09 19:32:25 +020089 requires static com.google.errorprone.annotations;
90 requires static org.apiguardian.api;
91 requires static org.jetbrains.annotations;
Matthias Andreas Benkard15456c82024-07-20 10:52:54 +020092 requires static org.jspecify;
Matthias Andreas Benkarde0022372022-10-09 19:32:25 +020093
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010094 exports eu.mulk.jgvariant.ostree;
95}