Refactor model classes to use Java records

Converted model classes (FileEntry, FileInformation, MigrationResult, Model, Version) to Java records for improved immutability and conciseness. Added AspectModelResult record. Updated ModelService and ModelController to use new record types and adjusted method signatures and usages accordingly. Minor dependency update in pom.xml for @usebruno/cli.

Author: michelu89

aspect-model-editor-runtime/pom.xml

@@ -446,7 +446,7 @@
                         </goals>
                         <configuration>
                            <workingDirectory>${project.build.directory}</workingDirectory>
-                           <arguments>install . @usebruno/cli</arguments>
+                           <arguments>install --ignore-scripts . @usebruno/cli@2.15.0</arguments>
                         </configuration>
                      </execution>
                   </executions>

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/ModelService.java

@@ -20,14 +20,14 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
-import java.util.Optional;
 import java.util.function.Supplier;
 
 import org.eclipse.esmf.ame.exceptions.CreateFileException;
 import org.eclipse.esmf.ame.exceptions.FileHandlingException;
 import org.eclipse.esmf.ame.exceptions.FileNotFoundException;
 import org.eclipse.esmf.ame.exceptions.FileReadException;
 import org.eclipse.esmf.ame.exceptions.InvalidAspectModelException;
+import org.eclipse.esmf.ame.services.models.AspectModelResult;
 import org.eclipse.esmf.ame.services.models.MigrationResult;
 import org.eclipse.esmf.ame.services.models.Version;
 import org.eclipse.esmf.ame.services.utils.ModelGroupingUtils;
@@ -47,12 +47,9 @@
 import org.eclipse.esmf.aspectmodel.urn.AspectModelUrn;
 import org.eclipse.esmf.aspectmodel.validation.services.AspectModelValidator;
 import org.eclipse.esmf.metamodel.AspectModel;
-import org.eclipse.esmf.metamodel.Namespace;
 import org.eclipse.esmf.samm.KnownVersion;
 
 import io.micronaut.http.multipart.CompletedFileUpload;
-import io.vavr.Tuple;
-import io.vavr.Tuple2;
 import jakarta.inject.Singleton;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -78,39 +75,25 @@ public ModelService( final AspectModelValidator aspectModelValidator, final Aspe
       this.modelPath = modelPath;
    }
 
-   public Tuple2<Optional<String>, String> getModel( final AspectModelUrn aspectModelUrn, final String filePath ) {
+   public AspectModelResult getModel( final AspectModelUrn aspectModelUrn, final String filePath ) {
       try {
          final AspectModel aspectModel = ( filePath != null ) ?
                ModelUtils.loadModelFromFile( modelPath, filePath, aspectModelLoader ) :
                loadModelFromUrn( aspectModelUrn );
          validateModel( aspectModel );
 
-         return aspectModel.files().stream().filter( a -> a.elements().stream().anyMatch( e -> e.urn().equals( aspectModelUrn ) ) )
-               .findFirst().map( aspectModelFile -> Tuple.of( aspectModelFile.filename(),
+         return aspectModel.files().stream()
+               .filter( a -> a.elements().stream().anyMatch( e -> e.urn().equals( aspectModelUrn ) ) )
+               .findFirst()
+               .map( aspectModelFile -> new AspectModelResult(
+                     aspectModelFile.filename(),
                      AspectSerializer.INSTANCE.aspectModelFileToString( aspectModelFile ) ) )
                .orElseThrow( () -> new FileNotFoundException( "Aspect Model not found" ) );
       } catch ( final ModelResolutionException e ) {
          throw new FileNotFoundException( e.getMessage(), e );
       }
    }
 
-   public String getModelNamespace( final AspectModelUrn aspectModelUrn, final String filePath ) {
-      try {
-         final AspectModel aspectModel = ( filePath != null ) ?
-               ModelUtils.loadModelFromFile( modelPath, filePath, aspectModelLoader ) :
-               loadModelFromUrn( aspectModelUrn );
-         validateModel( aspectModel );
-
-         final Namespace first = aspectModel.namespaces().getFirst();
-
-         return aspectModel.files().stream().filter( a -> a.elements().stream().anyMatch( e -> e.urn().equals( aspectModelUrn ) ) )
-               .findFirst().map( AspectSerializer.INSTANCE::aspectModelFileToString )
-               .orElseThrow( () -> new FileNotFoundException( "Aspect Model not found" ) );
-      } catch ( final ModelResolutionException e ) {
-         throw new FileNotFoundException( e.getMessage(), e );
-      }
-   }
-
    private AspectModel loadModelFromUrn( final AspectModelUrn aspectModelUrn ) {
       final Supplier<AspectModel> aspectModelSupplier = ModelUtils.getAspectModelSupplier( aspectModelUrn, aspectModelLoader );
       return aspectModelSupplier.get();
@@ -213,16 +196,16 @@ public MigrationResult migrateWorkspace( final boolean setNewVersion, final Path
 
    private void processVersion( final String namespace, final Version version, final boolean setNewVersion, final List<String> errors,
          final Path metaModelStoragePath ) {
-      version.getModels().forEach( model -> {
+      version.models().forEach( model -> {
          try {
-            final boolean isNotLatestKnownVersion = KnownVersion.fromVersionString( model.getVersion() )
+            final boolean isNotLatestKnownVersion = KnownVersion.fromVersionString( model.version() )
                   .filter( v -> KnownVersion.getLatest().equals( v ) ).isPresent();
 
             if ( isNotLatestKnownVersion ) {
                return;
             }
 
-            final Path aspectModelPath = ModelUtils.constructModelPath( modelPath, namespace, version.getVersion(), model.getModel() );
+            final Path aspectModelPath = ModelUtils.constructModelPath( modelPath, namespace, version.version(), model.model() );
             final AspectModel aspectModel = aspectModelLoader.load( aspectModelPath.toFile() );
 
             if ( setNewVersion ) {
@@ -232,7 +215,7 @@ private void processVersion( final String namespace, final Version version, fina
 
             AspectSerializer.INSTANCE.write( aspectModel );
          } catch ( final Exception e ) {
-            errors.add( String.format( "Error processing model: %s", model.getModel() ) );
+            errors.add( String.format( "Error processing model: %s", model.model() ) );
          }
       } );
    }

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/AspectModelResult.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for
+ * additional information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.ame.services.models;
+
+import java.util.Optional;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import io.micronaut.core.annotation.Introspected;
+import io.micronaut.serde.annotation.Serdeable;
+
+/**
+ * Represents the result of an aspect model operation.
+ *
+ * @param filename the optional name of the file associated with the model result
+ * @param content the content of the model result
+ */
+@Serdeable
+@Introspected
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record AspectModelResult( Optional<String> filename, String content ) {}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/FileEntry.java

@@ -13,60 +13,28 @@
 
 package org.eclipse.esmf.ame.services.models;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import io.micronaut.core.annotation.Introspected;
 import io.micronaut.serde.annotation.Serdeable;
 
 /**
- * Represents a single migration result with success and erros.
+ * Represents a file entry with aspect model information.
+ *
+ * @param absoluteName the absolute path of the file
+ * @param fileName the name of the file
+ * @param aspectModelUrn the URN of the aspect model
+ * @param modelVersion the version of the model
  */
 @Serdeable
 @Introspected
-public class FileEntry {
-   private String absoluteName;
-   private String fileName;
-   private String aspectModelUrn;
-   private String modelVersion;
-
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record FileEntry( String absoluteName, String fileName, String aspectModelUrn, String modelVersion ) {
+   /**
+    * Creates a FileEntry with only the aspect model URN.
+    *
+    * @param aspectModelUrn the URN of the aspect model
+    */
    public FileEntry( final String aspectModelUrn ) {
-      this.aspectModelUrn = aspectModelUrn;
-   }
-
-   public FileEntry( final String absoluteName, final String fileName, final String aspectModelUrn, final String modelVersion ) {
-      this.absoluteName = absoluteName;
-      this.fileName = fileName;
-      this.aspectModelUrn = aspectModelUrn;
-      this.modelVersion = modelVersion;
-   }
-
-   public String getAbsoluteName() {
-      return absoluteName;
-   }
-
-   public void setAbsoluteName( final String absoluteName ) {
-      this.absoluteName = absoluteName;
-   }
-
-   public String getFileName() {
-      return fileName;
-   }
-
-   public void setFileName( final String fileName ) {
-      this.fileName = fileName;
-   }
-
-   public String getAspectModelUrn() {
-      return aspectModelUrn;
-   }
-
-   public void setAspectModelUrn( final String aspectModelUrn ) {
-      this.aspectModelUrn = aspectModelUrn;
-   }
-
-   public String getModelVersion() {
-      return modelVersion;
-   }
-
-   public void setModelVersion( final String modelVersion ) {
-      this.modelVersion = modelVersion;
+      this( null, null, aspectModelUrn, null );
    }
-}
+}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/FileInformation.java

@@ -13,67 +13,26 @@
 
 package org.eclipse.esmf.ame.services.models;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import io.micronaut.core.annotation.Introspected;
 import io.micronaut.serde.annotation.Serdeable;
 
 /**
- * Represents a single migration result with success and erros.
+ * Represents information about an Aspect Model file.
+ *
+ * @param absoluteName the absolute path of the file
+ * @param aspectModelUrn the URN of the aspect model
+ * @param modelVersion the version of the model
+ * @param aspectModel the aspect model content
+ * @param fileName the name of the file
  */
 @Serdeable
 @Introspected
-public class FileInformation {
-   private String absoluteName;
-   private String aspectModelUrn;
-   private String modelVersion;
-   private String aspectModel;
-   private String fileName;
-
-   public FileInformation( final String absoluteName, final String aspectModelUrn, final String modelVersion, final String aspectModel,
-         final String fileName ) {
-      this.absoluteName = absoluteName;
-      this.aspectModelUrn = aspectModelUrn;
-      this.modelVersion = modelVersion;
-      this.aspectModel = aspectModel;
-      this.fileName = fileName;
-   }
-
-   public String getAbsoluteName() {
-      return absoluteName;
-   }
-
-   public void setAbsoluteName( final String absoluteName ) {
-      this.absoluteName = absoluteName;
-   }
-
-   public String getAspectModelUrn() {
-      return aspectModelUrn;
-   }
-
-   public void setAspectModelUrn( final String aspectModelUrn ) {
-      this.aspectModelUrn = aspectModelUrn;
-   }
-
-   public String getModelVersion() {
-      return modelVersion;
-   }
-
-   public void setModelVersion( final String modelVersion ) {
-      this.modelVersion = modelVersion;
-   }
-
-   public String getAspectModel() {
-      return aspectModel;
-   }
-
-   public void setAspectModel( final String aspectModel ) {
-      this.aspectModel = aspectModel;
-   }
-
-   public String getFileName() {
-      return fileName;
-   }
-
-   public void setFileName( final String fileName ) {
-      this.fileName = fileName;
-   }
-}
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record FileInformation(
+      String absoluteName,
+      String aspectModelUrn,
+      String modelVersion,
+      String aspectModel,
+      String fileName
+) {}

aspect-model-editor-service/src/main/java/org/eclipse/esmf/ame/services/models/MigrationResult.java

@@ -15,39 +15,20 @@
 
 import java.util.List;
 
+import com.fasterxml.jackson.annotation.JsonInclude;
 import io.micronaut.core.annotation.Introspected;
 import io.micronaut.serde.annotation.Serdeable;
 
 /**
- * Represents a single migration result with success and erros.
+ * Represents the result of a migration operation.
+ *
+ * @param success indicates whether the migration was successful
+ * @param errors list of error messages encountered during migration, empty if successful
  */
 @Serdeable
 @Introspected
-public class MigrationResult {
-   private boolean success;
-   private List<String> errors;
-
-   public MigrationResult() {
-   }
-
-   public MigrationResult( final boolean success, final List<String> errors ) {
-      this.success = success;
-      this.errors = errors;
-   }
-
-   public boolean isSuccess() {
-      return success;
-   }
-
-   public void setSuccess( final boolean success ) {
-      this.success = success;
-   }
-
-   public List<String> getErrors() {
-      return errors;
-   }
-
-   public void setErrors( final List<String> errors ) {
-      this.errors = errors;
-   }
-}
+@JsonInclude( JsonInclude.Include.ALWAYS )
+public record MigrationResult(
+      boolean success,
+      List<String> errors
+) {}