initial commit

.gitignore

@@ -0,0 +1,3 @@
+/.idea/
+/**/.gradle/
+/**/build/

README

@@ -0,0 +1,45 @@
+:samples-dir: /home/tcagent1/agent/work/64493a816be20d5a/promote-projects/gradle/build/git-checkout/subprojects/docs/build/working/samples/install/java-modules-multi-project
+:gradle-version: 7.5.1-20220727220835+0000
+
+= Building Java Modules Sample
+
+[.download]
+- link:zips/sample_java_modules_multi_project-groovy-dsl.zip[icon:download[] Groovy DSL]
+- link:zips/sample_java_modules_multi_project-kotlin-dsl.zip[icon:download[] Kotlin DSL]
+
+NOTE: You can open this sample inside an IDE using the https://www.jetbrains.com/help/idea/gradle.html#gradle_import_project_start[IntelliJ's Gradle import] or https://projects.eclipse.org/projects/tools.buildship[Eclipse Buildship].
+
+This sample shows how to create a multi-project containing https://www.oracle.com/corporate/features/understanding-java-9-modules.html[Java Modules].
+Java Modules are a feature of Java itself, available since Java 9, that allows for better encapsulation.
+
+In Gradle, each _source set_ containing Java sources can be turned into a module by adding a `module-info.java` file.
+Typically, in a project with Java Modules like this one, the _main_ source set of a subproject represents a module.
+
+```
+src
+└── main
+    └── java
+        └── module-info.java
+```
+
+In the `module-info.java` file you define dependencies to other modules using keywords like `requires` or `requires transitive`.
+These correspond to the `implementation` and `api` dependencies defined in the Gradle build file.
+In addition, a module `exports` packages that should be visible to consumers.
+Other packages are not visible outside of the module.
+
+```
+module org.gradle.sample.utilities {
+    requires transitive org.gradle.sample.list;
+    exports org.gradle.sample.utilities;
+}
+```
+
+Unit (whitebox) tests that need to access the internals of a module can be written in the traditional way by **not** adding a `module-info.java` to the test source set.
+In test execution, the modules are then treated as standard Java libraries with the encapsulation deactivated.
+
+Blackbox (e.g. integration) tests, which should also follow the encapsulation rules during test execution, can be written by turning the corresponding test sources set itself into a module by adding a `module-info.java`.
+This is shown in link:sample_java_modules_multi_project_with_integration_tests.html[this extended sample].
+
+For more information, see link:{userManualPath}/java_library_plugin.html#sec:java_library_modular[Java Module support in the Java Library Plugin],
+link:{userManualPath}/application_plugin.html#sec:application_modular[Java Module support in the Application Plugin] and
+link:{userManualPath}/java_testing.html#sec:java_testing_modular[testing Java Modules].

application/build.gradle

@@ -0,0 +1,13 @@
+plugins {
+    id 'myproject.java-conventions'
+    id 'application'
+}
+
+dependencies {
+    implementation project(':utilities')
+}
+
+application {
+    mainModule = 'org.gradle.sample.app'
+    mainClass = 'org.gradle.sample.app.Main'
+}

application/src/main/java/module-info.java

@@ -0,0 +1,4 @@
+module org.gradle.sample.app {
+    exports org.gradle.sample.app;
+    requires org.gradle.sample.utilities;
+}

application/src/main/java/org/gradle/sample/app/Main.java

@@ -0,0 +1,15 @@
+package org.gradle.sample.app;
+
+import org.gradle.sample.list.LinkedList;
+
+import static org.gradle.sample.utilities.StringUtils.join;
+import static org.gradle.sample.utilities.StringUtils.split;
+import static org.gradle.sample.app.MessageUtils.getMessage;
+
+public class Main {
+    public static void main(String[] args) {
+        LinkedList tokens;
+        tokens = split(getMessage());
+        System.out.println(join(tokens));
+    }
+}

application/src/main/java/org/gradle/sample/app/MessageUtils.java

@@ -0,0 +1,7 @@
+package org.gradle.sample.app;
+
+class MessageUtils {
+    public static String getMessage() {
+        return "Hello,      World!";
+    }
+}

application/src/test/java/org/gradle/sample/app/MessageUtilsTest.java

@@ -0,0 +1,11 @@
+package org.gradle.sample.app;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class MessageUtilsTest {
+    @Test public void testGetMessage() {
+        assertEquals("Hello,      World!", MessageUtils.getMessage());
+    }
+}

buildSrc/build.gradle

@@ -0,0 +1,3 @@
+plugins {
+    id 'groovy-gradle-plugin'
+}

buildSrc/src/main/groovy/myproject.java-conventions.gradle

@@ -0,0 +1,18 @@
+plugins {
+    id 'java'
+}
+
+version = '1.0.2'
+group = 'org.gradle.sample'
+
+repositories {
+    mavenCentral()
+}
+
+tasks.named("test") {
+    useJUnitPlatform()
+}
+
+dependencies {
+    testImplementation 'org.junit.jupiter:junit-jupiter:5.7.1'
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,5 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.5.1-bin.zip
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,240 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+
+APP_NAME="Gradle"
+APP_BASE_NAME=${0##*/}
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,91 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo.
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo.
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
+echo.
+echo Please set the JAVA_HOME variable in your environment to match the
+echo location of your Java installation.
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

list/build.gradle

@@ -0,0 +1,4 @@
+plugins {
+    id 'myproject.java-conventions'
+    id 'java-library'
+}

list/src/main/java/module-info.java

@@ -0,0 +1,3 @@
+module org.gradle.sample.list {
+    exports org.gradle.sample.list;
+}

list/src/main/java/org/gradle/sample/list/LinkedList.java

@@ -0,0 +1,78 @@
+package org.gradle.sample.list;
+
+public class LinkedList {
+    private Node head;
+
+    public void add(String element) {
+        Node newNode = new Node(element);
+
+        Node it = tail(head);
+        if (it == null) {
+            head = newNode;
+        } else {
+            it.next = newNode;
+        }
+    }
+
+    private static Node tail(Node head) {
+        Node it;
+
+        for (it = head; it != null && it.next != null; it = it.next) {}
+
+        return it;
+    }
+
+    public boolean remove(String element) {
+        boolean result = false;
+        Node previousIt = null;
+        Node it = null;
+        for (it = head; !result && it != null; previousIt = it, it = it.next) {
+            if (0 == element.compareTo(it.data)) {
+                result = true;
+                unlink(previousIt, it);
+                break;
+            }
+        }
+
+        return result;
+    }
+
+    private void unlink(Node previousIt, Node currentIt) {
+        if (currentIt == head) {
+            head = currentIt.next;
+        } else {
+            previousIt.next = currentIt.next;
+        }
+    }
+
+    public int size() {
+        int size = 0;
+
+        for (Node it = head; it != null; ++size, it = it.next) {}
+
+        return size;
+    }
+
+    public String get(int index) {
+        Node it = head;
+        while (index > 0 && it != null) {
+            it = it.next;
+            index--;
+        }
+
+        if (it == null) {
+            throw new IndexOutOfBoundsException("Index is out of range");
+        }
+
+        return it.data;
+    }
+
+    private static class Node {
+        final String data;
+        Node next;
+
+        Node(String data) {
+            this.data = data;
+        }
+    }
+}

list/src/test/java/org/gradle/sample/list/LinkedListTest.java

@@ -0,0 +1,47 @@
+package org.gradle.sample.list;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+public class LinkedListTest {
+    @Test public void testConstructor() {
+        LinkedList list = new LinkedList();
+        assertEquals(0, list.size());
+    }
+
+    @Test public void testAdd() {
+        LinkedList list = new LinkedList();
+
+        list.add("one");
+        assertEquals(1, list.size());
+        assertEquals("one", list.get(0));
+
+        list.add("two");
+        assertEquals(2, list.size());
+        assertEquals("two", list.get(1));
+    }
+
+    @Test public void testRemove() {
+        LinkedList list = new LinkedList();
+
+        list.add("one");
+        list.add("two");
+        assertTrue(list.remove("one"));
+
+        assertEquals(1, list.size());
+        assertEquals("two", list.get(0));
+
+        assertTrue(list.remove("two"));
+        assertEquals(0, list.size());
+    }
+
+    @Test public void testRemoveMissing() {
+        LinkedList list = new LinkedList();
+
+        list.add("one");
+        list.add("two");
+        assertFalse(list.remove("three"));
+        assertEquals(2, list.size());
+    }
+}

settings.gradle

@@ -0,0 +1,2 @@
+rootProject.name = 'modules-multi-project'
+include 'application', 'list', 'utilities'

utilities/build.gradle

@@ -0,0 +1,8 @@
+plugins {
+    id 'myproject.java-conventions'
+    id 'java-library'
+}
+
+dependencies {
+    api project(':list')
+}

utilities/src/main/java/module-info.java

@@ -0,0 +1,4 @@
+module org.gradle.sample.utilities {
+    requires transitive org.gradle.sample.list;
+    exports org.gradle.sample.utilities;
+}

utilities/src/main/java/org/gradle/sample/utilities/JoinUtils.java

@@ -0,0 +1,17 @@
+package org.gradle.sample.utilities;
+
+import org.gradle.sample.list.LinkedList;
+
+class JoinUtils {
+    public static String join(LinkedList source) {
+        StringBuilder result = new StringBuilder();
+        for (int i = 0; i < source.size(); ++i) {
+            if (result.length() > 0) {
+                result.append(" ");
+            }
+            result.append(source.get(i));
+        }
+
+        return result.toString();
+    }
+}

utilities/src/main/java/org/gradle/sample/utilities/SplitUtils.java

@@ -0,0 +1,36 @@
+package org.gradle.sample.utilities;
+
+import org.gradle.sample.list.LinkedList;
+
+class SplitUtils {
+    public static LinkedList split(String source) {
+        int lastFind = 0;
+        int currentFind = 0;
+        LinkedList result = new LinkedList();
+
+        while ((currentFind = source.indexOf(" ", lastFind)) != -1) {
+            String token = source.substring(lastFind);
+            if (currentFind != -1) {
+                token = token.substring(0, currentFind - lastFind);
+            }
+
+            addIfValid(token, result);
+            lastFind = currentFind + 1;
+        }
+
+        String token = source.substring(lastFind);
+        addIfValid(token, result);
+
+        return result;
+    }
+
+    private static void addIfValid(String token, LinkedList list) {
+        if (isTokenValid(token)) {
+            list.add(token);
+        }
+    }
+
+    private static boolean isTokenValid(String token) {
+        return !token.isEmpty();
+    }
+}

utilities/src/main/java/org/gradle/sample/utilities/StringUtils.java

@@ -0,0 +1,13 @@
+package org.gradle.sample.utilities;
+
+import org.gradle.sample.list.LinkedList;
+
+public class StringUtils {
+    public static String join(LinkedList source) {
+        return JoinUtils.join(source);
+    }
+
+    public static LinkedList split(String source) {
+        return SplitUtils.split(source);
+    }
+}