Introduce common StringArtifact class and clean up

Author: atextor

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/docu/DocumentationArtifact.java

@@ -13,24 +13,10 @@
 
 package org.eclipse.esmf.aspectmodel.generator.docu;
 
-import org.eclipse.esmf.aspectmodel.generator.Artifact;
-
-public class DocumentationArtifact implements Artifact<String, String> {
-   private final String id;
-   private final String content;
+import org.eclipse.esmf.aspectmodel.generator.StringArtifact;
 
+public class DocumentationArtifact extends StringArtifact {
    public DocumentationArtifact( final String id, final String content ) {
-      this.id = id;
-      this.content = content;
-   }
-
-   @Override
-   public String getId() {
-      return "";
-   }
-
-   @Override
-   public String getContent() {
-      return "";
+      super( id, content );
    }
 }

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/SqlArtifact.java

@@ -13,27 +13,13 @@
 
 package org.eclipse.esmf.aspectmodel.generator.sql;
 
-import org.eclipse.esmf.aspectmodel.generator.Artifact;
+import org.eclipse.esmf.aspectmodel.generator.StringArtifact;
 
 /**
  * Represents a generated SQL script.
  */
-public class SqlArtifact implements Artifact<String, String> {
-   private final String id;
-   private final String content;
-
+public class SqlArtifact extends StringArtifact {
    public SqlArtifact( final String id, final String content ) {
-      this.id = id;
-      this.content = content;
-   }
-
-   @Override
-   public String getId() {
-      return id;
-   }
-
-   @Override
-   public String getContent() {
-      return content;
+      super( id, content );
    }
 }

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/zip/AspectModelNamespacePackageCreator.java

@@ -16,9 +16,17 @@
 import org.eclipse.esmf.aspectmodel.serializer.AspectSerializer;
 import org.eclipse.esmf.metamodel.AspectModel;
 
+/**
+ * Generator for Namespace Packages as described in <a
+ * href="https://github.com/eclipse-esmf/esmf-semantic-aspect-meta-model/blob/main/documentation/decisions/0009-namespace-packages.md">
+ * ADR-0009</a>.
+ */
 public class AspectModelNamespacePackageCreator
       extends Generator<AspectModel, String, byte[], NamespacePackageGenerationConfig, NamespacePackageArtifact> {
    public static final NamespacePackageGenerationConfig DEFAULT_CONFIG = NamespacePackageGenerationConfigBuilder.builder().build();
+   /**
+    * @deprecated Use {@link #AspectModelNamespacePackageCreator(AspectModel, NamespacePackageGenerationConfig)} instead
+    */
    @Deprecated( forRemoval = true )
    public static final AspectModelNamespacePackageCreator INSTANCE = new AspectModelNamespacePackageCreator( null );
    private static final String BASE_ARCHIVE_FORMAT_PATH = "aspect-models/";

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/AspectGenerator.java

@@ -24,12 +24,11 @@
  *
  * @param <I> the type that uniquely identifies the artifact in the scope of the generation process
  * @param <T> the artifact's content type, e.g. String or byte[]
- * @param <C> the config object for the genererator
+ * @param <C> the config object for the generator
  * @param <A> the type of the artifact that is generated
  */
 public abstract class AspectGenerator<I, T, C extends GenerationConfig, A extends Artifact<I, T>>
       extends Generator<Aspect, I, T, C, A> {
-
    protected AspectGenerator( final Aspect aspect, final C config ) {
       super( aspect, config );
    }
@@ -46,7 +45,7 @@ protected <E extends ModelElement> Stream<E> elements( final Class<E> clazz ) {
             .distinct();
    }
 
-   protected <E extends ModelElement> Stream<A> applyTemplate(
+   protected <E extends ModelElement> Stream<A> applyArtifactGenerator(
          final Class<E> clazz, final ArtifactGenerator<I, T, E, C, A> artifactGenerator, final C config ) {
       return elements( clazz ).map( element -> artifactGenerator.apply( element, config ) );
    }

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/BinaryArtifact.java

@@ -4,6 +4,9 @@
 
 package org.eclipse.esmf.aspectmodel.generator;
 
+/**
+ * Abstract base class for {@link Artifact}s that have content represented as byte[]
+ */
 public abstract class BinaryArtifact implements Artifact<String, byte[]> {
    private final String id;
    private final byte[] content;

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/Generator.java

@@ -22,7 +22,7 @@
  * @param <F> the focus type, e.g. Aspect or AspectModel
  * @param <I> the type that uniquely identifies the artifact in the scope of the generation process
  * @param <T> the artifact's content type, e.g. String or byte[]
- * @param <C> the config object for the genererator
+ * @param <C> the config object for the generator
  * @param <A> the type of the artifact that is generated
  */
 public abstract class Generator<F, I, T, C extends GenerationConfig, A extends Artifact<I, T>> {

core/esmf-aspect-model-generator/src/main/java/org/eclipse/esmf/aspectmodel/generator/StringArtifact.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2024 Bosch Software Innovations GmbH. All rights reserved.
+ */
+
+package org.eclipse.esmf.aspectmodel.generator;
+
+public abstract class StringArtifact implements Artifact<String, String> {
+   protected final String id;
+   protected final String content;
+
+   public StringArtifact( final String id, final String content ) {
+      this.id = id;
+      this.content = content;
+   }
+
+   @Override
+   public String getId() {
+      return id;
+   }
+
+   @Override
+   public String getContent() {
+      return content;
+   }
+}

core/esmf-aspect-model-java-generator/src/main/java/org/eclipse/esmf/aspectmodel/java/AspectModelJavaUtil.java

@@ -114,7 +114,7 @@ public static String getPropertyType( final Property property, final JavaCodeGen
     */
    public static boolean hasContainerType( final Property property ) {
       return property.isOptional()
-            || (property.getEffectiveCharacteristic().map( characteristic -> characteristic.is( Collection.class ) ).orElse( false ));
+            || ( property.getEffectiveCharacteristic().map( characteristic -> characteristic.is( Collection.class ) ).orElse( false ) );
    }
 
    /**
@@ -313,8 +313,8 @@ public static String getDataType( final Optional<Type> dataType, final ImportTra
       return dataType.map( type -> {
          final Type actualDataType = dataType.get();
          if ( actualDataType instanceof ComplexType ) {
-            final String complexDataType = ((ComplexType) actualDataType).getName();
-            if ( (!codeGenerationConfig.namePrefix().isBlank() || !codeGenerationConfig.namePostfix().isBlank()) ) {
+            final String complexDataType = ( (ComplexType) actualDataType ).getName();
+            if ( ( !codeGenerationConfig.namePrefix().isBlank() || !codeGenerationConfig.namePostfix().isBlank() ) ) {
                return codeGenerationConfig.namePrefix() + complexDataType + codeGenerationConfig.namePostfix();
             }
             return complexDataType;
@@ -338,7 +338,7 @@ public static String getDataType( final Optional<Type> dataType, final ImportTra
 
    public static Class<?> getDataTypeClass( final Type dataType ) {
       if ( dataType instanceof ComplexType ) {
-         return ((ComplexType) dataType).getClass();
+         return ( (ComplexType) dataType ).getClass();
       }
 
       final Resource typeResource = ResourceFactory.createResource( dataType.getUrn() );
@@ -515,7 +515,7 @@ public static String printStructuredValueElement( final Object object ) {
       if ( object instanceof String ) {
          return createLiteral( object.toString() );
       }
-      return toConstant( ((Property) object).getName() );
+      return toConstant( ( (Property) object ).getName() );
    }
 
    public static boolean isXmlDatatypeFactoryRequired( final StructureElement element ) {
@@ -570,7 +570,7 @@ public static String genericClassSignature( final StructureElement element ) {
    }
 
    public static String generateClassName( final StructureElement element, final JavaCodeGenerationConfig config ) {
-      if ( (!config.namePrefix().isBlank() || !config.namePostfix().isBlank()) && element.is( StructureElement.class ) ) {
+      if ( ( !config.namePrefix().isBlank() || !config.namePostfix().isBlank() ) && element.is( StructureElement.class ) ) {
          return config.namePrefix() + element.getName() + config.namePostfix();
       }
       return element.getName();
@@ -666,6 +666,6 @@ public static String getterName( final Property property ) {
             .filter( Type::isScalar )
             .map( type -> XSD.xboolean.getURI().equals( type.getUrn() ) )
             .orElse( false );
-      return (isBooleanType ? "is" : "get") + StringUtils.capitalize( property.getPayloadName() );
+      return ( isBooleanType ? "is" : "get" ) + StringUtils.capitalize( property.getPayloadName() );
    }
 }

core/esmf-aspect-model-java-generator/src/main/java/org/eclipse/esmf/aspectmodel/java/metamodel/StaticMetaModelJavaGenerator.java

@@ -33,7 +33,7 @@ public StaticMetaModelJavaGenerator( final Aspect aspect, final JavaCodeGenerati
    @Override
    public Stream<Artifact<QualifiedName, String>> generate() {
       final StaticMetaModelJavaArtifactGenerator<StructureElement> template = new StaticMetaModelJavaArtifactGenerator<>();
-      return applyTemplate( StructureElement.class, template, config )
+      return applyArtifactGenerator( StructureElement.class, template, config )
             .collect( Collectors.toSet() )
             .stream();
    }

core/esmf-aspect-model-java-generator/src/main/java/org/eclipse/esmf/aspectmodel/java/pojo/AspectModelJavaGenerator.java

@@ -39,10 +39,10 @@ public Stream<Artifact<QualifiedName, String>> generate() {
       final Set<ComplexType> structureElements = elements( ComplexType.class ).filter( element ->
             element.getExtends().isPresent() ).collect( Collectors.toSet() );
       return Stream.of(
-                  applyTemplate( Aspect.class, new StructureElementJavaArtifactGenerator<>(), config ),
-                  applyTemplate( ComplexType.class, new StructureElementJavaArtifactGenerator<>( structureElements ), config ),
-                  applyTemplate( Event.class, new StructureElementJavaArtifactGenerator<>(), config ),
-                  applyTemplate( Enumeration.class, new EnumerationJavaArtifactGenerator<>(), config ) )
+                  applyArtifactGenerator( Aspect.class, new StructureElementJavaArtifactGenerator<>(), config ),
+                  applyArtifactGenerator( ComplexType.class, new StructureElementJavaArtifactGenerator<>( structureElements ), config ),
+                  applyArtifactGenerator( Event.class, new StructureElementJavaArtifactGenerator<>(), config ),
+                  applyArtifactGenerator( Enumeration.class, new EnumerationJavaArtifactGenerator<>(), config ) )
             .flatMap( Function.identity() )
             .collect( Collectors.toSet() )
             .stream();