├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── build.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat └── src ├── main ├── java │ └── de │ │ └── bertilmuth │ │ └── javadataclass │ │ ├── Main.java │ │ ├── generate │ │ └── JavaDataClassGenerator.java │ │ ├── model │ │ ├── ClassSpecification.java │ │ └── FieldSpecification.java │ │ └── read │ │ └── YamlClassSpecificationReader.java └── resources │ └── javadataclass.ftl └── test ├── java └── de │ └── bertilmuth │ └── javadataclass │ ├── generate │ └── JavaDataClassGeneratorTest.java │ └── read │ └── YamlReaderTest.java └── resources └── javadataclass.ftl /.gitignore: -------------------------------------------------------------------------------- 1 | /.gradle/ 2 | bin 3 | .settings/org.eclipse.buildship.core.prefs 4 | .classpath 5 | .project 6 | src/test/resources/FieldlessClass.java 7 | src/test/resources/User.java 8 | /build/ 9 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | jdk: 3 | - openjdk8 4 | - openjdk14 5 | - oraclejdk14 6 | before_install: 7 | - chmod +x gradlew 8 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Javadataclass 2 | [![Build Status](https://travis-ci.com/bertilmuth/javadataclass.svg?branch=master)](https://travis-ci.com/bertilmuth/javadataclass) 3 | [![Gitter](https://badges.gitter.im/requirementsascode/community.svg)](https://gitter.im/requirementsascode/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) 4 | 5 | A simple Java source file generator, that takes a YAML file as an input. 6 | You find a description in this [article](https://dev.to/bertilmuth/generating-data-classes-in-java-4cef). 7 | Additionally, have a look at the [Main](https://github.com/bertilmuth/javadataclass/blob/master/src/main/java/de/bertilmuth/javadataclass/Main.java) class to see how to use this library. 8 | 9 | # Getting started 10 | Javadataclass is available on Maven Central. 11 | 12 | If you are using Maven, include the following in your POM, to use the core: 13 | 14 | ``` xml 15 | 16 | org.requirementsascode 17 | javadataclass 18 | 0.1 19 | 20 | ``` 21 | 22 | If you are using Gradle, include the following in your build.gradle, to use the core: 23 | 24 | ``` 25 | implementation 'org.requirementsascode:javadataclass:0.1' 26 | ``` 27 | 28 | At least Java 8 is required to use the library. 29 | 30 | # Example output 31 | 32 | Here's the content of an example YAML file: 33 | ``` yaml 34 | User: 35 | name: Name 36 | age: Integer 37 | 38 | Name: 39 | firstName: String 40 | lastName: String 41 | ``` 42 | 43 | From this file, 2 Java source files will be generated, `User.java` and `Name.java`. 44 | 45 | For the sake of simplicity, the Java source files will be generated in the same directory as the YAML file. 46 | 47 | The contents of these two files are: 48 | 49 | `User.java`: 50 | ``` java 51 | public class User{ 52 | private Name name; 53 | private Integer age; 54 | 55 | public User(){ 56 | } 57 | 58 | public Name getName(){ 59 | return name; 60 | } 61 | public void setName(Name name){ 62 | this.name = name; 63 | } 64 | public Integer getAge(){ 65 | return age; 66 | } 67 | public void setAge(Integer age){ 68 | this.age = age; 69 | } 70 | } 71 | ``` 72 | 73 | `Name.java`: 74 | ``` java 75 | public class Name{ 76 | private String firstName; 77 | private String lastName; 78 | 79 | public Name(){ 80 | } 81 | 82 | public String getFirstName(){ 83 | return firstName; 84 | } 85 | public void setFirstName(String firstName){ 86 | this.firstName = firstName; 87 | } 88 | public String getLastName(){ 89 | return lastName; 90 | } 91 | public void setLastName(String lastName){ 92 | this.lastName = lastName; 93 | } 94 | } 95 | ``` 96 | -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'java-library' 3 | id 'maven-publish' 4 | } 5 | 6 | group = 'org.requirementsascode' 7 | version = '0.1.1-SNAPSHOT' 8 | 9 | compileJava { 10 | sourceCompatibility = '1.8' 11 | targetCompatibility = '1.8' 12 | } 13 | 14 | repositories { 15 | mavenCentral() 16 | maven { 17 | url "https://oss.sonatype.org/content/repositories/snapshots/" 18 | } 19 | } 20 | 21 | dependencies { 22 | implementation 'org.freemarker:freemarker:2.3.31' 23 | implementation 'org.yaml:snakeyaml:1.28' 24 | testImplementation 'junit:junit:4.12' 25 | } 26 | 27 | jar { 28 | manifest { 29 | attributes 'Implementation-Title': 'javadataclass', 30 | 'Implementation-Version': archiveVersion 31 | } 32 | } 33 | 34 | task javadocJar(type: Jar) { 35 | from javadoc 36 | } 37 | 38 | task sourcesJar(type: Jar) { 39 | from sourceSets.main.allSource 40 | } 41 | 42 | artifacts { 43 | archives javadocJar, sourcesJar 44 | } 45 | 46 | if (project.hasProperty("signing.keyId")) { 47 | apply plugin: 'signing' 48 | publishing { 49 | publications { 50 | mavenJava(MavenPublication) { 51 | pom{ 52 | name = 'javadataclass' 53 | description = 'A simple Java source file generator, that takes a YAML file as an input.' 54 | url = 'http://requirementsascode.org/' 55 | packaging = 'jar' 56 | 57 | from components.java 58 | 59 | artifact javadocJar { 60 | classifier "javadoc" 61 | } 62 | 63 | artifact sourcesJar { 64 | classifier "sources" 65 | } 66 | 67 | licenses { 68 | license { 69 | name = 'The Apache Software License, Version 2.0' 70 | url = 'http://www.apache.org/licenses/LICENSE-2.0.txt' 71 | } 72 | } 73 | 74 | developers { 75 | developer { 76 | id = 'bertilmuth' 77 | name = 'Bertil Muth' 78 | } 79 | } 80 | 81 | scm { 82 | url = 'scm:git@github.com:bertilmuth/requirementsascode.git' 83 | connection = 'scm:git@github.com:bertilmuth/requirementsascode.git' 84 | developerConnection = 'scm:git@github.com:bertilmuth/requirementsascode.git' 85 | } 86 | } 87 | } 88 | } 89 | 90 | repositories { 91 | maven { 92 | credentials { 93 | username sonatypeUsername 94 | password sonatypePassword 95 | } 96 | 97 | def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/" 98 | def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/" 99 | url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl 100 | } 101 | } 102 | } 103 | 104 | signing { 105 | sign publishing.publications.mavenJava 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bertilmuth/javadataclass/5280daf1fe679cba785ed3e29c39c30c8bcf3635/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.2-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /src/main/java/de/bertilmuth/javadataclass/Main.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass; 2 | 3 | import java.io.File; 4 | import java.util.List; 5 | 6 | import de.bertilmuth.javadataclass.generate.JavaDataClassGenerator; 7 | import de.bertilmuth.javadataclass.model.ClassSpecification; 8 | import de.bertilmuth.javadataclass.read.YamlClassSpecificationReader; 9 | 10 | public class Main { 11 | 12 | public static void main(String[] args) throws Exception { 13 | // Make sure there is exactly one command line argument, the path to the YAML file 14 | if (args.length != 1) { 15 | System.out.println("Please supply exactly one argument, the absolute path of the YAML file."); 16 | return; 17 | } 18 | 19 | // Get the YAML file's handle, and the directory it's contained in 20 | // (generated files will be placed there) 21 | final String yamlFilePath = args[0]; 22 | final File yamlFile = new File(yamlFilePath); 23 | final File outputDirectory = yamlFile.getParentFile(); 24 | 25 | // Step 1: Read in the YAML file, into class specifications 26 | YamlClassSpecificationReader yamlReader = new YamlClassSpecificationReader(); 27 | List classSpecifications = yamlReader.read(yamlFile); 28 | 29 | // Step 2: Generate Java source files from the class specifications 30 | JavaDataClassGenerator javaDataClassGenerator = new JavaDataClassGenerator(); 31 | javaDataClassGenerator.generateJavaSourceFiles(classSpecifications, outputDirectory); 32 | 33 | System.out.println("Successfully generated files to: " + outputDirectory.getAbsolutePath()); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/de/bertilmuth/javadataclass/generate/JavaDataClassGenerator.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass.generate; 2 | 3 | import java.io.File; 4 | import java.io.FileWriter; 5 | import java.io.IOException; 6 | import java.io.Writer; 7 | import java.util.Collection; 8 | import java.util.HashMap; 9 | import java.util.Map; 10 | 11 | import de.bertilmuth.javadataclass.model.ClassSpecification; 12 | import freemarker.template.Configuration; 13 | import freemarker.template.Template; 14 | import freemarker.template.TemplateExceptionHandler; 15 | 16 | public class JavaDataClassGenerator { 17 | private Configuration configuration; 18 | 19 | public JavaDataClassGenerator() throws IOException { 20 | configuration = new Configuration(Configuration.VERSION_2_3_28); 21 | 22 | // Set the root of the class path ("") as the location to find templates 23 | configuration.setClassLoaderForTemplateLoading(getClass().getClassLoader(), ""); 24 | 25 | configuration.setDefaultEncoding("UTF-8"); 26 | configuration.setTemplateExceptionHandler(TemplateExceptionHandler.RETHROW_HANDLER); 27 | configuration.setLogTemplateExceptions(false); 28 | configuration.setWrapUncheckedExceptions(true); 29 | } 30 | 31 | public void generateJavaSourceFiles(Collection classSpecifications, File yamlFileDirectory) throws Exception { 32 | Map freemarkerDataModel = new HashMap<>(); 33 | 34 | // Get the template to generate Java source files 35 | Template template = configuration.getTemplate("javadataclass.ftl"); 36 | 37 | for (ClassSpecification classSpecification : classSpecifications) { 38 | // Put the classSpecification into the data model. 39 | // It can be accessed in the template through ${classSpecification} 40 | freemarkerDataModel.put("classSpecification", classSpecification); 41 | 42 | // The Java source file will be generated in the same directory as the YAML file 43 | File javaSourceFile = new File(yamlFileDirectory, classSpecification.getName() + ".java"); 44 | Writer javaSourceFileWriter = new FileWriter(javaSourceFile); 45 | 46 | // Generate the Java source file 47 | template.process(freemarkerDataModel, javaSourceFileWriter); 48 | } 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /src/main/java/de/bertilmuth/javadataclass/model/ClassSpecification.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass.model; 2 | 3 | import java.util.Collections; 4 | import java.util.List; 5 | 6 | public class ClassSpecification { 7 | private String name; 8 | private List fieldSpecifications; 9 | 10 | public ClassSpecification(String className, List fieldSpecifications) { 11 | this.name = className; 12 | this.fieldSpecifications = fieldSpecifications; 13 | } 14 | 15 | public String getName() { 16 | return name; 17 | } 18 | 19 | public List getFieldSpecifications() { 20 | return Collections.unmodifiableList(fieldSpecifications); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /src/main/java/de/bertilmuth/javadataclass/model/FieldSpecification.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass.model; 2 | 3 | public class FieldSpecification { 4 | private String name; 5 | private String type; 6 | 7 | public FieldSpecification(String fieldName, String fieldType) { 8 | this.name = fieldName; 9 | this.type = fieldType; 10 | } 11 | 12 | public String getName() { 13 | return name; 14 | } 15 | 16 | public String getType() { 17 | return type; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/de/bertilmuth/javadataclass/read/YamlClassSpecificationReader.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass.read; 2 | 3 | import static java.util.stream.Collectors.toList; 4 | import static java.util.stream.Collectors.toMap; 5 | 6 | import java.io.File; 7 | import java.io.FileNotFoundException; 8 | import java.io.FileReader; 9 | import java.io.Reader; 10 | import java.util.ArrayList; 11 | import java.util.HashMap; 12 | import java.util.List; 13 | import java.util.Map; 14 | import java.util.Map.Entry; 15 | import java.util.stream.Collectors; 16 | 17 | import org.yaml.snakeyaml.Yaml; 18 | 19 | import de.bertilmuth.javadataclass.model.ClassSpecification; 20 | import de.bertilmuth.javadataclass.model.FieldSpecification; 21 | 22 | public class YamlClassSpecificationReader { 23 | public List read(File yamlFile) throws FileNotFoundException { 24 | return read(new FileReader(yamlFile)); 25 | } 26 | 27 | public List read(Reader reader) { 28 | Map> yamlClassSpecifications = readYamlClassSpecifications(reader); 29 | List classSpecifications = createClassSpecificationsFrom(yamlClassSpecifications); 30 | return classSpecifications; 31 | } 32 | 33 | @SuppressWarnings("unchecked") 34 | private Map> readYamlClassSpecifications(Reader reader) { 35 | Yaml yaml = new Yaml(); 36 | 37 | // Read in the complete YAML file to a map of strings to a map of strings to strings 38 | Map> yamlClassSpecifications = 39 | (Map>) yaml.load(reader); 40 | 41 | return yamlClassSpecifications; 42 | } 43 | 44 | private List createClassSpecificationsFrom(Map> yamlClassSpecifications) { 45 | final Map> classNameToFieldSpecificationsMap 46 | = createClassNameToFieldSpecificationsMap(yamlClassSpecifications); 47 | 48 | List classSpecifications = 49 | classNameToFieldSpecificationsMap.entrySet().stream() 50 | .map(e -> new ClassSpecification(e.getKey(), e.getValue())) 51 | .collect(toList()); 52 | 53 | return classSpecifications; 54 | } 55 | 56 | private Map> createClassNameToFieldSpecificationsMap( 57 | Map> yamlClassSpecifications) { 58 | 59 | if (yamlClassSpecifications == null) return new HashMap<>(); 60 | 61 | return yamlClassSpecifications.entrySet().stream() 62 | .collect(toMap(this::className, this::fieldSpecifications)); 63 | } 64 | 65 | private String className(Entry> yamlOuterMapEntry) { 66 | return yamlOuterMapEntry.getKey(); 67 | } 68 | 69 | private List fieldSpecifications(Entry> yamlOuterMapEntry) { 70 | Map yamlFieldSpecifications = yamlOuterMapEntry.getValue(); 71 | 72 | if (yamlFieldSpecifications == null) return new ArrayList<>(); 73 | 74 | return yamlFieldSpecifications.entrySet().stream() 75 | .map(e -> new FieldSpecification(e.getKey(), e.getValue())) 76 | .collect(Collectors.toList()); 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /src/main/resources/javadataclass.ftl: -------------------------------------------------------------------------------- 1 | public class ${classSpecification.name}{ 2 | <#list classSpecification.fieldSpecifications as field> 3 | private ${field.type} ${field.name}; 4 | 5 | 6 | public ${classSpecification.name}(){ 7 | } 8 | 9 | <#list classSpecification.fieldSpecifications as field> 10 | public ${field.type} get${field.name?cap_first}(){ 11 | return ${field.name}; 12 | } 13 | public void set${field.name?cap_first}(${field.type} ${field.name}){ 14 | this.${field.name} = ${field.name}; 15 | } 16 | 17 | } -------------------------------------------------------------------------------- /src/test/java/de/bertilmuth/javadataclass/generate/JavaDataClassGeneratorTest.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass.generate; 2 | 3 | import static org.junit.Assert.assertTrue; 4 | 5 | import java.io.File; 6 | import java.nio.file.Files; 7 | import java.util.ArrayList; 8 | import java.util.Arrays; 9 | import java.util.List; 10 | 11 | import org.junit.Before; 12 | import org.junit.Test; 13 | 14 | import de.bertilmuth.javadataclass.model.ClassSpecification; 15 | import de.bertilmuth.javadataclass.model.FieldSpecification; 16 | 17 | public class JavaDataClassGeneratorTest { 18 | private static final String FIELDLESS_CLASS = "FieldlessClass"; 19 | private static final String USER_CLASS = "User"; 20 | 21 | private JavaDataClassGenerator javaDataClassGenerator; 22 | private File temporaryDirectory; 23 | 24 | @Before 25 | public void setUp() throws Exception { 26 | javaDataClassGenerator = new JavaDataClassGenerator(); 27 | temporaryDirectory = Files.createTempDirectory("JAVADATACLASS_").toFile(); 28 | } 29 | 30 | @Test 31 | public void generateTwoClasses() throws Exception { 32 | ClassSpecification fieldlessClassSpecification = new ClassSpecification(FIELDLESS_CLASS, new ArrayList<>()); 33 | 34 | List userFieldSpecifications = Arrays.asList(new FieldSpecification("name", "String"), 35 | new FieldSpecification("age", "Integer")); 36 | ClassSpecification userClassSpecification = new ClassSpecification(USER_CLASS, userFieldSpecifications); 37 | 38 | List classSpecifications = Arrays.asList(fieldlessClassSpecification, 39 | userClassSpecification); 40 | 41 | javaDataClassGenerator.generateJavaSourceFiles(classSpecifications, temporaryDirectory); 42 | 43 | assertTrue(new File(temporaryDirectory, USER_CLASS + ".java").exists()); 44 | assertTrue(new File(temporaryDirectory, FIELDLESS_CLASS + ".java").exists()); 45 | 46 | System.out.println("Successfully generated class files to: " + temporaryDirectory.getAbsolutePath()); 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/test/java/de/bertilmuth/javadataclass/read/YamlReaderTest.java: -------------------------------------------------------------------------------- 1 | package de.bertilmuth.javadataclass.read; 2 | 3 | import static org.junit.Assert.assertEquals; 4 | import static org.junit.Assert.assertTrue; 5 | 6 | import java.io.StringReader; 7 | import java.util.List; 8 | 9 | import org.junit.Test; 10 | 11 | import de.bertilmuth.javadataclass.model.ClassSpecification; 12 | import de.bertilmuth.javadataclass.model.FieldSpecification; 13 | 14 | public class YamlReaderTest { 15 | 16 | @Test 17 | public void readsEmptyClassSpecifications() { 18 | String emptyClasses = ""; 19 | List classSpecifications = readClassSpecifications(emptyClasses); 20 | assertTrue(classSpecifications.isEmpty()); 21 | } 22 | 23 | @Test 24 | public void readsSingleClassSpecificationWithoutFields() { 25 | String classSpecificationString = "Order:\r\n"; 26 | List classSpecifications = readClassSpecifications(classSpecificationString); 27 | assertEquals(1, classSpecifications.size()); 28 | assertEquals("Order", classSpecifications.get(0).getName()); 29 | } 30 | 31 | @Test 32 | public void readsTwoClassSpecificationWithoutFields() { 33 | String classSpecificationString = "Order:\r\nCustomer:\r\n"; 34 | List classSpecifications = readClassSpecifications(classSpecificationString); 35 | assertEquals(2, classSpecifications.size()); 36 | assertEquals("Order", classSpecifications.get(0).getName()); 37 | assertEquals("Customer", classSpecifications.get(1).getName()); 38 | } 39 | 40 | @Test 41 | public void readsSingleClassSpecificationWithSingleField() { 42 | String classSpecificationString = "Order:\r\n orderId: Long\r\n"; 43 | List classSpecifications = readClassSpecifications(classSpecificationString); 44 | List orderFields = classSpecifications.get(0).getFieldSpecifications(); 45 | assertEquals(1, orderFields.size()); 46 | assertEquals("orderId", orderFields.get(0).getName()); 47 | assertEquals("Long", orderFields.get(0).getType()); 48 | } 49 | 50 | @Test 51 | public void readsSingleClassSpecificationWithTwoFields() { 52 | String classSpecificationString = "Order:\r\n orderId: Long\r\n orderDate: Date"; 53 | List classSpecifications = readClassSpecifications(classSpecificationString); 54 | List orderFields = classSpecifications.get(0).getFieldSpecifications(); 55 | assertEquals(2, orderFields.size()); 56 | assertEquals("orderId", orderFields.get(0).getName()); 57 | assertEquals("Long", orderFields.get(0).getType()); 58 | assertEquals("orderDate", orderFields.get(1).getName()); 59 | assertEquals("Date", orderFields.get(1).getType()); 60 | } 61 | 62 | @Test 63 | public void readsTwoClassSpecificationsWithFields() { 64 | String classSpecificationString = "Order:\r\n orderId: Long\r\n orderDate: Date\r\nCustomer:\r\n firstName: String"; 65 | List classSpecifications = readClassSpecifications(classSpecificationString); 66 | List orderFields = classSpecifications.get(0).getFieldSpecifications(); 67 | List customerFields = classSpecifications.get(1).getFieldSpecifications(); 68 | 69 | assertEquals(2, orderFields.size()); 70 | assertEquals("orderId", orderFields.get(0).getName()); 71 | assertEquals("Long", orderFields.get(0).getType()); 72 | assertEquals("orderDate", orderFields.get(1).getName()); 73 | assertEquals("Date", orderFields.get(1).getType()); 74 | 75 | assertEquals(1, customerFields.size()); 76 | assertEquals("firstName", customerFields.get(0).getName()); 77 | assertEquals("String", customerFields.get(0).getType()); 78 | } 79 | 80 | private List readClassSpecifications(String dataClassString) { 81 | StringReader reader = new StringReader(dataClassString); 82 | List requirements = new YamlClassSpecificationReader().read(reader); 83 | return requirements; 84 | } 85 | } 86 | -------------------------------------------------------------------------------- /src/test/resources/javadataclass.ftl: -------------------------------------------------------------------------------- 1 | public class ${classSpecification.name}{ 2 | <#list classSpecification.fieldSpecifications as field> 3 | private ${field.type} ${field.name}; 4 | 5 | 6 | public ${classSpecification.name}(){ 7 | } 8 | 9 | <#list classSpecification.fieldSpecifications as field> 10 | public ${field.type} get${field.name?cap_first}(){ 11 | return ${field.name}; 12 | } 13 | public void set${field.name?cap_first}(${field.type} ${field.name}){ 14 | this.${field.name} = ${field.name}; 15 | } 16 | 17 | } --------------------------------------------------------------------------------