Skip to content

Commit cd74698

Browse files
reda-alaouireda-alaoui
committed
Init
1 parent 4826429 commit cd74698

File tree

33 files changed

+1745
-1
lines changed

33 files changed

+1745
-1
lines changed

‎.github/dependabot.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "maven" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"

‎.github/workflows/ci.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
pull_request:
8+
branches:
9+
- '**'
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up JDK 17
18+
uses: actions/setup-java@v2
19+
with:
20+
java-version: '17'
21+
distribution: 'temurin'
22+
- name: Build with Maven
23+
run: ./mvnw --batch-mode clean verify

‎.gitignore‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Created by .ignore support plugin (hsz.mobi)
2+
### JetBrains template
3+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
4+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
5+
6+
# User-specific stuff:
7+
.idea
8+
9+
# Sensitive or high-churn files:
10+
.idea/dataSources.ids
11+
.idea/dataSources.xml
12+
.idea/dataSources.local.xml
13+
.idea/sqlDataSources.xml
14+
.idea/dynamic.xml
15+
.idea/uiDesigner.xml
16+
17+
# Gradle:
18+
.idea/gradle.xml
19+
.idea/libraries
20+
21+
# Mongo Explorer plugin:
22+
.idea/mongoSettings.xml
23+
24+
## File-based project format:
25+
*.iws
26+
*.iml
27+
28+
## Plugin-specific files:
29+
30+
# IntelliJ
31+
/out/
32+
33+
# mpeltonen/sbt-idea plugin
34+
.idea_modules/
35+
36+
# JIRA plugin
37+
atlassian-ide-plugin.xml
38+
39+
# Crashlytics plugin (for Android Studio and IntelliJ)
40+
com_crashlytics_export_strings.xml
41+
crashlytics.properties
42+
crashlytics-build.properties
43+
fabric.properties
44+
### Maven template
45+
target/
46+
pom.xml.tag
47+
pom.xml.releaseBackup
48+
pom.xml.versionsBackup
49+
pom.xml.next
50+
release.properties
51+
dependency-reduced-pom.xml
52+
buildNumber.properties
53+
.mvn/timing.properties
54+

‎.mvn/jvm.config‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.text=ALL-UNNAMED --add-opens=java.desktop/java.awt.font=ALL-UNNAMED

‎.mvn/wrapper/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
maven-wrapper.jar

‎.mvn/wrapper/maven-wrapper.properties‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# https://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.1/apache-maven-3.8.1-bin.zip
18+
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

‎README.md‎

Lines changed: 72 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,72 @@
1-
# json-schema-to-java-record
1+
[![Build Status](https://github.com/Cosium/json-schema-to-java-record/actions/workflows/ci.yml/badge.svg)](https://github.com/Cosium/json-schema-to-java-record/actions/workflows/ci.yml)
2+
[![Maven Central Version](https://img.shields.io/maven-central/v/com.cosium.json_schema_to_java_record/json-schema-to-java-record)](https://central.sonatype.com/artifact/com.cosium.json_schema_to_java_record/json-schema-to-java-record)
3+
4+
# JSON Schema To Java Record
5+
6+
An annotation processor converting JSON schemas to java records.
7+
8+
# Quick start
9+
10+
1. Import the BOM:
11+
```xml
12+
<dependencyManagement>
13+
<dependencies>
14+
<!-- ... -->
15+
<dependency>
16+
<groupId>com.cosium.json_schema_to_java_record</groupId>
17+
<artifactId>json-schema-to-java-record-bom</artifactId>
18+
<version>${json-schema-to-java-record.version}</version>
19+
<scope>import</scope>
20+
<type>pom</type>
21+
</dependency>
22+
<!-- ... -->
23+
</dependencies>
24+
</dependencyManagement>
25+
```
26+
2. Import the API:
27+
```xml
28+
<dependencies>
29+
<!-- ... -->
30+
<dependency>
31+
<groupId>com.cosium.json_schema_to_java_record</groupId>
32+
<artifactId>json-schema-to-java-record-api</artifactId>
33+
</dependency>
34+
<!-- ... -->
35+
</dependencies>
36+
```
37+
3. Import the annotation processor:
38+
```xml
39+
<plugin>
40+
<groupId>org.apache.maven.plugins</groupId>
41+
<artifactId>maven-compiler-plugin</artifactId>
42+
<configuration>
43+
<annotationProcessorPaths>
44+
<path>
45+
<groupId>com.cosium.json_schema_to_java_record</groupId>
46+
<artifactId>json-schema-to-java-record</artifactId>
47+
</path>
48+
</annotationProcessorPaths>
49+
</configuration>
50+
</plugin>
51+
```
52+
4. Add your JSON schema files to the class path:
53+
```
54+
src/main/resources/com/aqme
55+
└── foo.schema.json
56+
```
57+
5. Annotate a `package-info.java` file like this:
58+
```java
59+
@GenerateRecordsFromJsonSchemas(
60+
schemaRootFileLocations =
61+
@JsonSchemaFileLocation(
62+
moduleAndPackage = "com.aqme",
63+
relativeName = "foo.schema.json"
64+
)
65+
)
66+
package com.aqme;
67+
68+
import com.cosium.json_schema_to_java_record_api.GenerateRecordsFromJsonSchemas;
69+
import com.cosium.json_schema_to_java_record_api.JsonSchemaConfiguration;
70+
import com.cosium.json_schema_to_java_record_api.JsonSchemaFileLocation;
71+
```
72+
6. Compile to generate the java files

‎api/pom.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<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">
3+
<modelVersion>4.0.0</modelVersion>
4+
5+
<parent>
6+
<groupId>com.cosium.json_schema_to_java_record</groupId>
7+
<artifactId>json-schema-to-java-record-parent</artifactId>
8+
<version>1.0-SNAPSHOT</version>
9+
</parent>
10+
11+
<name>JSON schema to Java Record API</name>
12+
<artifactId>json-schema-to-java-record-api</artifactId>
13+
14+
</project>

‎api/src/main/java/com/cosium/json_schema_to_java_record_api/GenerateRecordsFromJsonSchemas.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
package com.cosium.json_schema_to_java_record_api;
2+
3+
import java.lang.annotation.ElementType;
4+
import java.lang.annotation.Target;
5+
6+
/**
7+
* @author Réda Housni Alaoui
8+
*/
9+
@Target({ElementType.PACKAGE})
10+
public @interface GenerateRecordsFromJsonSchemas {
11+
12+
JsonSchemaFileLocation[] schemaRootFileLocations();
13+
14+
JsonSchemaConfiguration[] schemaConfigurations() default {};
15+
}

‎api/src/main/java/com/cosium/json_schema_to_java_record_api/JsonSchemaConfiguration.java‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
package com.cosium.json_schema_to_java_record_api;
2+
3+
/**
4+
* @author Réda Housni Alaoui
5+
*/
6+
public @interface JsonSchemaConfiguration {
7+
8+
/**
9+
* @return A value that should match the JSON schema $id attribute.
10+
*/
11+
String schemaId();
12+
13+
/**
14+
* Allows forcing the java type qualified name of the schema. If the type already exists, it will
15+
* be used as is.
16+
*
17+
* <p>E.g. "com.aqme.Foo"
18+
*/
19+
String javaTypeQualifiedName() default "";
20+
21+
/**
22+
* @return The interfaces that the generated record must implement.
23+
*/
24+
String[] javaInterfaceQualifiedNames() default {};
25+
}

0 commit comments

Comments
 (0)