Add AppImageLayout.rootDirectory()

Author: alexeysemenyukoracle

src/jdk.jpackage/share/classes/jdk/jpackage/internal/model/AppImageLayout.java

@@ -55,6 +55,14 @@ public interface AppImageLayout {
      */
     Path runtimeDirectory();
 
+    /**
+     * Root directory of this app image.
+     * It should normally be equal to <code>Path.of("")</code> for unresolved layout.
+     *
+     * @return the root directory of this app image
+     */
+    Path rootDirectory();
+
     /**
      * Creates a copy of this app image resolved at the given root directory.
      *
@@ -66,11 +74,11 @@ public interface AppImageLayout {
     /**
      * Default implementation of {@link AppImageLayout} interface.
     */
-    record Stub(Path runtimeDirectory) implements AppImageLayout {
+    record Stub(Path rootDirectory, Path runtimeDirectory) implements AppImageLayout {
 
         @Override
         public AppImageLayout resolveAt(Path base) {
-            return new Stub(resolveNullablePath(base, runtimeDirectory));
+            return new Stub(resolveNullablePath(base, rootDirectory), resolveNullablePath(base, runtimeDirectory));
         }
     }
 
@@ -79,7 +87,8 @@ public AppImageLayout resolveAt(Path base) {
      * instance.
      *
      * It will call every non-static accessible method without parameters and with
-     * {@link Path} return type of the given {@link AppImageLayout} instance.
+     * {@link Path} return type of the given {@link AppImageLayout} instance except
+     * {@link #rootDirectory()} method.
      * <p>
      * For every call, it will save the return value in the output {@link PathGroup}
      * object under the key equals the name of a function used in the call.
@@ -98,6 +107,7 @@ public static PathGroup toPathGroup(AppImageLayout appImageLayout) {
                 .map(Class::getMethods)
                 .flatMap(Stream::of)
                 .filter(m -> !Modifier.isStatic(m.getModifiers()))
+                .filter(m -> !"rootDirectory".equals(m.getName()))
                 .filter(m -> {
                     return m.getReturnType().isAssignableFrom(Path.class) && m.getParameterCount() == 0;
                 }).<Map.Entry<String, Path>>mapMulti((m, consumer) -> {

src/jdk.jpackage/share/classes/jdk/jpackage/internal/model/ApplicationLayout.java

@@ -24,10 +24,11 @@
  */
 package jdk.jpackage.internal.model;
 
+import static jdk.jpackage.internal.util.PathUtils.resolveNullablePath;
+
 import java.nio.file.Path;
 import java.util.Objects;
 import jdk.jpackage.internal.util.CompositeProxy;
-import static jdk.jpackage.internal.util.PathUtils.resolveNullablePath;
 
 /**
  * Application app image layout.
@@ -72,6 +73,7 @@ private Builder() {
         }
 
         private Builder(ApplicationLayout appLayout) {
+            rootDirectory = appLayout.rootDirectory();
             launchersDirectory = appLayout.launchersDirectory();
             appDirectory = appLayout.appDirectory();
             runtimeDirectory = appLayout.runtimeDirectory();
@@ -82,6 +84,7 @@ private Builder(ApplicationLayout appLayout) {
 
         public ApplicationLayout create() {
 
+            Objects.requireNonNull(rootDirectory);
             Objects.requireNonNull(runtimeDirectory);
             Objects.requireNonNull(launchersDirectory);
             Objects.requireNonNull(appDirectory);
@@ -90,7 +93,7 @@ public ApplicationLayout create() {
             Objects.requireNonNull(contentDirectory);
 
             return ApplicationLayout.create(new AppImageLayout.Stub(
-                    runtimeDirectory), new ApplicationLayoutMixin.Stub(
+                    rootDirectory, runtimeDirectory), new ApplicationLayoutMixin.Stub(
                     launchersDirectory, appDirectory, appModsDirectory,
                     destktopIntegrationDirectory, contentDirectory));
         }
@@ -100,6 +103,7 @@ public Builder setAll(String path) {
         }
 
         public Builder setAll(Path path) {
+            rootDirectory(path);
             launchersDirectory(path);
             appDirectory(path);
             runtimeDirectory(path);
@@ -110,6 +114,7 @@ public Builder setAll(Path path) {
         }
 
         public Builder resolveAt(Path base) {
+            rootDirectory(resolveNullablePath(base, rootDirectory));
             launchersDirectory(resolveNullablePath(base, launchersDirectory));
             appDirectory(resolveNullablePath(base, appDirectory));
             runtimeDirectory(resolveNullablePath(base, runtimeDirectory));
@@ -119,6 +124,15 @@ public Builder resolveAt(Path base) {
             return this;
         }
 
+        public Builder rootDirectory(String v) {
+            return rootDirectory(Path.of(v));
+        }
+
+        public Builder rootDirectory(Path v) {
+            rootDirectory = v;
+            return this;
+        }
+
         public Builder launchersDirectory(String v) {
             return launchersDirectory(Path.of(v));
         }
@@ -173,6 +187,7 @@ public Builder contentDirectory(Path v) {
             return this;
         }
 
+        private Path rootDirectory = Path.of("");
         private Path launchersDirectory;
         private Path appDirectory;
         private Path runtimeDirectory;

src/jdk.jpackage/share/classes/jdk/jpackage/internal/model/RuntimeLayout.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019, 2024, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -24,20 +24,38 @@
  */
 package jdk.jpackage.internal.model;
 
+import static jdk.jpackage.internal.util.PathUtils.resolveNullablePath;
+
 import java.nio.file.Path;
 import jdk.jpackage.internal.util.CompositeProxy;
-import static jdk.jpackage.internal.util.PathUtils.resolveNullablePath;
 
 /**
  * Java runtime app image layout.
  * <p>
- * Use {@link #DEFAULT} to get the object implementing this interface.
+ * Use {@link #DEFAULT} field to get the default runtime app image layout or
+ * {@link #create(Path)} method to create custom runtime app image layout.
  */
 public interface RuntimeLayout extends AppImageLayout {
 
     @Override
     default RuntimeLayout resolveAt(Path root) {
-        return create(new AppImageLayout.Stub(resolveNullablePath(root, runtimeDirectory())));
+        return create(new AppImageLayout.Stub(resolveNullablePath(root, rootDirectory()),
+                resolveNullablePath(root, runtimeDirectory())));
+    }
+
+    /**
+     * Creates Java runtime app image layout.
+     * <p>
+     * {@link #runtimeDirectory()} method
+     * called on the created object will return the value of the
+     * <code>runtimeDirectory<code> parameter. {@link #rootDirectory()} method
+     * called on the created object will return <code>Path.of("")<code> value.
+     *
+     * @param runtimeDirectory Java runtime directory
+     * @return Java runtime app image layout
+     */
+    static RuntimeLayout create(Path runtimeDirectory) {
+        return create(new AppImageLayout.Stub(Path.of(""), runtimeDirectory));
     }
 
     private static RuntimeLayout create(AppImageLayout layout) {
@@ -51,5 +69,5 @@ private static RuntimeLayout create(AppImageLayout layout) {
      * the runtime directory is the same as the directory at which the layout is
      * resolved.
      */
-    static final RuntimeLayout DEFAULT = create(new AppImageLayout.Stub(Path.of("")));
+    static final RuntimeLayout DEFAULT = create(Path.of(""));
 }

test/jdk/tools/jpackage/junit/share/jdk.jpackage/jdk/jpackage/internal/model/AppImageLayoutTest.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package jdk.jpackage.internal.model;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotSame;
+
+import java.nio.file.Path;
+import java.util.List;
+import java.util.Set;
+import org.junit.jupiter.api.Test;
+
+
+public class AppImageLayoutTest {
+
+    @Test
+    public void testStub() {
+        final var root = Path.of("root");
+        final var runtime = Path.of("runtime");
+        final var layout = new AppImageLayout.Stub(root, runtime);
+
+        assertEquals(root, layout.rootDirectory());
+        assertEquals(runtime, layout.runtimeDirectory());
+    }
+
+    @Test
+    public void testPathGroup() {
+        final var layout = new AppImageLayout.Stub(Path.of("root"), Path.of("runtime"));
+
+        final var pathGroup = AppImageLayout.toPathGroup(layout);
+
+        assertEquals(Set.of("runtimeDirectory"), pathGroup.keys());
+        assertEquals(List.of(layout.runtimeDirectory()), pathGroup.paths());
+    }
+
+    @Test
+    public void testResolveAt() {
+        final var dir = Path.of("foo/bar");
+
+        final var layout = new AppImageLayout.Stub(Path.of(""), Path.of("runtime"));
+
+        final var resolvedLayout = layout.resolveAt(dir);
+
+        assertNotSame(layout, resolvedLayout);
+
+        assertEquals(dir.resolve(layout.rootDirectory()), resolvedLayout.rootDirectory());
+        assertEquals(dir.resolve(layout.runtimeDirectory()), resolvedLayout.runtimeDirectory());
+    }
+}