blob: c8e6c134d4068a78b5606af3c5568b6c10812540 [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 Benkard4e8423d2021-12-19 22:56:09 +01005/**
Matthias Andreas Benkardaa294842021-12-28 01:31:56 +01006 * {@link eu.mulk.jgvariant.core.Decoder} instances for OSTree repositories.
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +01007 *
8 * <ul>
9 * <li><a href="#sect-overview">Overview</a>
10 * <li><a href="#sect-installation">Installation</a>
11 * </ul>
12 *
13 * <h2 id="sect-overview">Overview</h2>
14 *
15 * <p>The {@link eu.mulk.jgvariant.ostree} package contains record classes describing the elements
16 * of <a href="https://ostreedev.github.io/ostree/">OSTree</a> repositories and factory methods to
17 * create {@link eu.mulk.jgvariant.core.Decoder} instances for them.
18 *
19 * <h2 id="sect-installation">Installation</h2>
20 *
21 * <ul>
22 * <li><a href="#sect-installation-maven">Usage with Maven</a>
23 * <li><a href="#sect-installation-gradle">Usage with Gradle</a>
24 * </ul>
25 *
26 * <h3 id="sect-installation-maven">Usage with Maven</h3>
27 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020028 * {@snippet lang="xml" :
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010029 * <project>
30 * ...
31 *
32 * <dependencyManagement>
33 * ...
34 *
35 * <dependencies>
36 * <dependency>
37 * <groupId>eu.mulk.jgvariant</groupId>
38 * <artifactId>jgvariant-bom</artifactId>
Matthias Andreas Benkard52504582022-10-09 19:37:56 +020039 * <version>0.1.7</version>
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010040 * <type>pom</type>
41 * <scope>import</scope>
42 * </dependency>
43 * </dependencies>
44 *
45 * ...
46 * </dependencyManagement>
47 *
48 * <dependencies>
49 * ...
50 *
51 * <dependency>
52 * <groupId>eu.mulk.jgvariant</groupId>
53 * <artifactId>jgvariant-core</artifactId>
54 * </dependency>
55 * <dependency>
56 * <groupId>eu.mulk.jgvariant</groupId>
57 * <artifactId>jgvariant-ostree</artifactId>
58 * </dependency>
59 *
60 * ...
61 * </dependencies>
62 *
63 * ...
64 * </project>
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020065 * }
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010066 *
67 * <h3 id="sect-installation-gradle">Usage with Gradle</h3>
68 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020069 * {@snippet lang="groovy" :
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010070 * dependencies {
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020071 * // ...
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010072 *
Matthias Andreas Benkard52504582022-10-09 19:37:56 +020073 * implementation(platform("eu.mulk.jgvariant:jgvariant-bom:0.1.7"))
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010074 * implementation("eu.mulk.jgvariant:jgvariant-core")
75 * implementation("eu.mulk.jgvariant:jgvariant-ostree")
76 *
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020077 * // ...
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010078 * }
Matthias Andreas Benkard0239d322022-04-15 20:21:37 +020079 * }
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010080 */
Matthias Andreas Benkarda7e9d522021-12-28 01:37:47 +010081module eu.mulk.jgvariant.ostree {
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010082 requires transitive eu.mulk.jgvariant.core;
Matthias Andreas Benkarde0022372022-10-09 19:32:25 +020083
Matthias Andreas Benkard50a626d2021-12-30 19:13:49 +010084 requires org.tukaani.xz;
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010085
Matthias Andreas Benkarde0022372022-10-09 19:32:25 +020086 requires static com.google.errorprone.annotations;
87 requires static org.apiguardian.api;
88 requires static org.jetbrains.annotations;
89
Matthias Andreas Benkard4e8423d2021-12-19 22:56:09 +010090 exports eu.mulk.jgvariant.ostree;
91}