You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2022/08/10 10:55:00 UTC

[isis] branch master updated: ISIS-3087: rename former 'Style' -> 'LayoutExportStyle'

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/master by this push:
     new 65835f0fac ISIS-3087: rename former 'Style' -> 'LayoutExportStyle'
65835f0fac is described below

commit 65835f0facd584ef44a3334aa9b85eca110a2054
Author: Andi Huber <ah...@apache.org>
AuthorDate: Wed Aug 10 12:54:54 2022 +0200

    ISIS-3087: rename former 'Style' -> 'LayoutExportStyle'
---
 .../isis/applib/mixins/layout/Object_downloadLayoutXml.java  | 12 ++++++------
 .../org/apache/isis/applib/services/grid/GridService.java    | 10 +++++-----
 .../layout/{LayoutFormat.java => LayoutExportStyle.java}     |  4 ++--
 .../apache/isis/applib/services/layout/LayoutService.java    |  4 ++--
 .../isis/applib/services/layout/LayoutServiceMenu.java       |  8 ++++----
 .../core/metamodel/services/grid/GridServiceDefault.java     |  4 ++--
 .../core/metamodel/services/layout/LayoutServiceDefault.java | 10 +++++-----
 .../isis/core/metamodel/services/grid/GridLoadingTest.java   |  4 ++--
 8 files changed, 28 insertions(+), 28 deletions(-)

diff --git a/api/applib/src/main/java/org/apache/isis/applib/mixins/layout/Object_downloadLayoutXml.java b/api/applib/src/main/java/org/apache/isis/applib/mixins/layout/Object_downloadLayoutXml.java
index 39620ad38b..00ebb6144b 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/mixins/layout/Object_downloadLayoutXml.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/mixins/layout/Object_downloadLayoutXml.java
@@ -29,7 +29,7 @@ import org.apache.isis.applib.annotation.RestrictTo;
 import org.apache.isis.applib.annotation.SemanticsOf;
 import org.apache.isis.applib.layout.LayoutConstants;
 import org.apache.isis.applib.mixins.dto.DtoMixinConstants;
-import org.apache.isis.applib.services.layout.LayoutFormat;
+import org.apache.isis.applib.services.layout.LayoutExportStyle;
 import org.apache.isis.applib.services.layout.LayoutService;
 import org.apache.isis.applib.value.Clob;
 import org.apache.isis.applib.value.NamedWithMimeType.CommonMimeType;
@@ -71,9 +71,9 @@ public class Object_downloadLayoutXml {
                     named = DtoMixinConstants.FILENAME_PROPERTY_NAME,
                     describedAs = DtoMixinConstants.FILENAME_PROPERTY_DESCRIPTION)
             final String fileName,
-            final LayoutFormat format) {
+            final LayoutExportStyle style) {
 
-        val xmlString = layoutService.toXml(holder.getClass(), format);
+        val xmlString = layoutService.toXml(holder.getClass(), style);
         return Clob.of(fileName, CommonMimeType.XML, xmlString);
     }
 
@@ -85,10 +85,10 @@ public class Object_downloadLayoutXml {
     }
 
     /**
-     * Default style is {@link LayoutFormat#MINIMAL}.
+     * Default style is {@link LayoutExportStyle#MINIMAL}.
      */
-    @MemberSupport public LayoutFormat default1Act() {
-        return LayoutFormat.defaults();
+    @MemberSupport public LayoutExportStyle default1Act() {
+        return LayoutExportStyle.defaults();
     }
 
     @Inject LayoutService layoutService;
diff --git a/api/applib/src/main/java/org/apache/isis/applib/services/grid/GridService.java b/api/applib/src/main/java/org/apache/isis/applib/services/grid/GridService.java
index 2e01ce50e8..0ac8a1ba1d 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/services/grid/GridService.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/services/grid/GridService.java
@@ -23,7 +23,7 @@ import org.apache.isis.applib.annotation.CollectionLayout;
 import org.apache.isis.applib.annotation.DomainObjectLayout;
 import org.apache.isis.applib.annotation.PropertyLayout;
 import org.apache.isis.applib.layout.grid.Grid;
-import org.apache.isis.applib.services.layout.LayoutFormat;
+import org.apache.isis.applib.services.layout.LayoutExportStyle;
 import org.apache.isis.commons.internal.exceptions._Exceptions;
 
 /**
@@ -158,20 +158,20 @@ public interface GridService {
 
     default Grid toGridForExport(
             final Class<?> domainClass,
-            final LayoutFormat format) {
+            final LayoutExportStyle style) {
 
         // don't use the grid from the facet, because it will be modified subsequently.
         Grid grid = load(domainClass);
         if(grid == null) {
             grid = defaultGridFor(domainClass);
         }
-        if (format == LayoutFormat.COMPLETE) {
+        if (style == LayoutExportStyle.COMPLETE) {
             return complete(grid);
         }
-        if (format == LayoutFormat.MINIMAL) {
+        if (style == LayoutExportStyle.MINIMAL) {
             return minimal(grid);
         }
-        throw _Exceptions.unmatchedCase(format);
+        throw _Exceptions.unmatchedCase(style);
     }
 
 }
diff --git a/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutFormat.java b/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutExportStyle.java
similarity index 96%
rename from api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutFormat.java
rename to api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutExportStyle.java
index 3264f038ed..f049fa5d92 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutFormat.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutExportStyle.java
@@ -34,7 +34,7 @@ import org.apache.isis.applib.layout.grid.Grid;
  */
 @Named(IsisModuleApplib.NAMESPACE + ".services.layout.LayoutFormat")
 @Value
-public enum LayoutFormat {
+public enum LayoutExportStyle {
 
     /**
      * Format that yields a full representation for the <code>layout.xml</code>,
@@ -53,7 +53,7 @@ public enum LayoutFormat {
      */
     MINIMAL,;
 
-    public static LayoutFormat defaults() {
+    public static LayoutExportStyle defaults() {
         return MINIMAL;
     }
 
diff --git a/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutService.java b/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutService.java
index 4984fcce2b..28d7c6be39 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutService.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutService.java
@@ -31,12 +31,12 @@ public interface LayoutService {
     /**
      * Obtains the serialized XML form of the layout (grid) for the specified domain class.
      */
-    String toXml(Class<?> domainClass, LayoutFormat format);
+    String toXml(Class<?> domainClass, LayoutExportStyle style);
 
     /**
      * Obtains a zip file of the serialized XML of the layouts (grids) of all domain entities and view models.
      */
-    byte[] toZip(final LayoutFormat format);
+    byte[] toZip(final LayoutExportStyle style);
 
     /**
      * Obtains the serialized XML form of the menu bars layout ({@link MenuBarsService}).
diff --git a/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutServiceMenu.java b/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutServiceMenu.java
index a85653b505..f47d3d4994 100644
--- a/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutServiceMenu.java
+++ b/api/applib/src/main/java/org/apache/isis/applib/services/layout/LayoutServiceMenu.java
@@ -81,15 +81,15 @@ public class LayoutServiceMenu {
 
         public class ActionDomainEvent extends LayoutServiceMenu.ActionDomainEvent<downloadLayouts> {}
 
-        @MemberSupport public Blob act(final LayoutFormat format) {
+        @MemberSupport public Blob act(final LayoutExportStyle style) {
 
-            final String fileName = "layouts." + format.name().toLowerCase() + ".zip";
+            final String fileName = "layouts." + style.name().toLowerCase() + ".zip";
 
-            final byte[] zipBytes = layoutService.toZip(format);
+            final byte[] zipBytes = layoutService.toZip(style);
             return new Blob(fileName, mimeTypeApplicationZip, zipBytes);
         }
 
-        @MemberSupport public LayoutFormat default0Act() { return LayoutFormat.defaults(); }
+        @MemberSupport public LayoutExportStyle default0Act() { return LayoutExportStyle.defaults(); }
     }
 
 
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/grid/GridServiceDefault.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/grid/GridServiceDefault.java
index f19a4a8633..396b514fb2 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/grid/GridServiceDefault.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/grid/GridServiceDefault.java
@@ -89,14 +89,14 @@ public class GridServiceDefault implements GridService {
 
     @Override
     public Grid defaultGridFor(final Class<?> domainClass) {
-
         for (val gridSystemService : gridSystemServices()) {
             val grid = gridSystemService.defaultGrid(domainClass);
             if(grid != null) {
                 return grid;
             }
         }
-        throw new IllegalStateException("No GridSystemService available to create grid for '" + domainClass.getName() + "'");
+        throw new IllegalStateException(
+                "No GridSystemService available to create grid for '" + domainClass.getName() + "'");
     }
 
     @Override
diff --git a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/layout/LayoutServiceDefault.java b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/layout/LayoutServiceDefault.java
index 4eeefee856..3e3605ac3f 100644
--- a/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/layout/LayoutServiceDefault.java
+++ b/core/metamodel/src/main/java/org/apache/isis/core/metamodel/services/layout/LayoutServiceDefault.java
@@ -33,7 +33,7 @@ import org.apache.isis.applib.layout.grid.Grid;
 import org.apache.isis.applib.layout.menubars.MenuBars;
 import org.apache.isis.applib.services.grid.GridService;
 import org.apache.isis.applib.services.jaxb.JaxbService;
-import org.apache.isis.applib.services.layout.LayoutFormat;
+import org.apache.isis.applib.services.layout.LayoutExportStyle;
 import org.apache.isis.applib.services.layout.LayoutService;
 import org.apache.isis.applib.services.menu.MenuBarsService;
 import org.apache.isis.applib.util.ZipWriter;
@@ -58,8 +58,8 @@ public class LayoutServiceDefault implements LayoutService {
     private final MenuBarsService menuBarsService;
 
     @Override
-    public String toXml(final Class<?> domainClass, final LayoutFormat format) {
-        final Grid grid = gridService.toGridForExport(domainClass, format);
+    public String toXml(final Class<?> domainClass, final LayoutExportStyle style) {
+        final Grid grid = gridService.toGridForExport(domainClass, style);
         return jaxbService.toXml(grid,
                 _Maps.unmodifiable(
                         Marshaller.JAXB_SCHEMA_LOCATION,
@@ -68,7 +68,7 @@ public class LayoutServiceDefault implements LayoutService {
     }
 
     @Override
-    public byte[] toZip(final LayoutFormat format) {
+    public byte[] toZip(final LayoutExportStyle style) {
         val domainObjectSpecs = specificationLoader.snapshotSpecifications()
         .filter(spec ->
                 !spec.isAbstract()
@@ -78,7 +78,7 @@ public class LayoutServiceDefault implements LayoutService {
 
         for (val objectSpec : domainObjectSpecs) {
             val domainClass = objectSpec.getCorrespondingClass();
-            val grid = gridService.toGridForExport(domainClass, format);
+            val grid = gridService.toGridForExport(domainClass, style);
             if(grid != null) {
                 zipWriter.nextEntry(zipEntryNameFor(objectSpec), writer->{
 
diff --git a/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/grid/GridLoadingTest.java b/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/grid/GridLoadingTest.java
index b9c19c546a..825eec1a5b 100644
--- a/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/grid/GridLoadingTest.java
+++ b/core/metamodel/src/test/java/org/apache/isis/core/metamodel/services/grid/GridLoadingTest.java
@@ -27,7 +27,7 @@ import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertSame;
 
 import org.apache.isis.applib.services.grid.GridLoaderService;
-import org.apache.isis.applib.services.layout.LayoutFormat;
+import org.apache.isis.applib.services.layout.LayoutExportStyle;
 import org.apache.isis.applib.services.layout.LayoutService;
 import org.apache.isis.core.metamodel.MetaModelTestAbstract;
 import org.apache.isis.core.metamodel.facetapi.Facet.Precedence;
@@ -55,7 +55,7 @@ extends MetaModelTestAbstract {
         val domainClassAndLayout = new GridLoaderServiceDefault.DomainClassAndLayout(Bar.class, null);
         gridLoaderService.loadXml(domainClassAndLayout);
 
-        val xml = layoutService.toXml(Bar.class, LayoutFormat.MINIMAL);
+        val xml = layoutService.toXml(Bar.class, LayoutExportStyle.MINIMAL);
         System.out.println(xml);
     }