Update generation usage in example code and clean up imports

Author: atextor

documentation/developer-guide/modules/tooling-guide/examples/EditAspectModel.java

@@ -14,7 +14,6 @@
 package examples;
 
 // tag::imports[]
-import java.io.File;
 import java.net.URI;
 import java.text.SimpleDateFormat;
 import java.util.Date;
@@ -33,6 +32,7 @@
 import org.eclipse.esmf.metamodel.AspectModel;
 // end::imports[]
 
+import java.io.File;
 import org.junit.jupiter.api.Test;
 
 public class EditAspectModel {

documentation/developer-guide/modules/tooling-guide/examples/GenerateAsyncApi.java

@@ -14,28 +14,21 @@
 package examples;
 
 // tag::imports[]
-import java.io.ByteArrayOutputStream;
-import java.nio.charset.StandardCharsets;
-
 import org.eclipse.esmf.aspectmodel.generator.asyncapi.AspectModelAsyncApiGenerator;
 import org.eclipse.esmf.aspectmodel.generator.asyncapi.AsyncApiSchemaGenerationConfig;
 import org.eclipse.esmf.aspectmodel.generator.asyncapi.AsyncApiSchemaGenerationConfigBuilder;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
 
 import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
-import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 // end::imports[]
 
 import java.io.File;
-import java.io.IOException;
 import org.junit.jupiter.api.Test;
 
 public class GenerateAsyncApi {
    @Test
-   public void generateYaml() throws IOException {
+   public void generateYaml() {
       // tag::generateYaml[]
       // AspectModel as returned by the AspectModelLoader
       final AspectModel aspectModel = // ...
@@ -44,8 +37,6 @@ public void generateYaml() throws IOException {
                   new File( "aspect-models/org.eclipse.esmf.examples.movement/1.0.0/Movement.ttl" ) );
       // tag::generateYaml[]
 
-      final ObjectMapper yamlMapper = new YAMLMapper().enable( YAMLGenerator.Feature.MINIMIZE_QUOTES );
-
       final AsyncApiSchemaGenerationConfig config = AsyncApiSchemaGenerationConfigBuilder.builder()
             // i.e., true = v1.2.3, false = v1
             .useSemanticVersion( false )
@@ -56,18 +47,12 @@ public void generateYaml() throws IOException {
 
       // Generate pretty-printed YAML
       final AspectModelAsyncApiGenerator generator = new AspectModelAsyncApiGenerator( aspectModel.aspect(), config );
-      final JsonNode json = generator.getContent();
-      final String yaml = yamlMapper.writeValueAsString( json );
-
-      final ByteArrayOutputStream out = new ByteArrayOutputStream();
-      out.write( yaml.getBytes( StandardCharsets.UTF_8 ) );
-
-      final String result = out.toString();
+      final String yaml = generator.generateYaml();
       // end::generateYaml[]
    }
 
    @Test
-   public void generateJson() throws IOException {
+   public void generateJson() {
       // tag::generateJson[]
       // AspectModel as returned by the AspectModelLoader
       final AspectModel aspectModel = // ...
@@ -76,7 +61,6 @@ public void generateJson() throws IOException {
                   new File( "aspect-models/org.eclipse.esmf.examples.movement/1.0.0/Movement.ttl" ) );
       // tag::generateJson[]
 
-      final ObjectMapper objectMapper = new ObjectMapper();
       final AsyncApiSchemaGenerationConfig config = AsyncApiSchemaGenerationConfigBuilder.builder()
             // i.e., true = v1.2.3, false = v1
             .useSemanticVersion( false )
@@ -87,12 +71,10 @@ public void generateJson() throws IOException {
 
       // Generate the JSON
       final AspectModelAsyncApiGenerator generator = new AspectModelAsyncApiGenerator( aspectModel.aspect(), config );
-      final JsonNode json = generator.getContent();
-
-      // If needed, print or pretty print it into a string
-      final ByteArrayOutputStream out = new ByteArrayOutputStream();
-      objectMapper.writerWithDefaultPrettyPrinter().writeValue( out, json );
-      final String result = out.toString();
+      // Get result as type-safe JSON object
+      final JsonNode jsonNode = generator.getContent();
+      // Or as pretty-printed JSON String:
+      final String json = generator.generateJson();
       // end::generateJson[]
    }
 }

documentation/developer-guide/modules/tooling-guide/examples/GenerateHtml.java

@@ -14,33 +14,32 @@
 package examples;
 
 // tag::imports[]
-import java.io.File;
-import java.io.IOException;
-import java.util.Map;
-
 import org.eclipse.esmf.aspectmodel.generator.docu.AspectModelDocumentationGenerator;
-import org.eclipse.esmf.aspectmodel.generator.docu.AspectModelDocumentationGenerator.HtmlGenerationOption;
+import org.eclipse.esmf.aspectmodel.generator.docu.DocumentationGenerationConfig;
+import org.eclipse.esmf.aspectmodel.generator.docu.DocumentationGenerationConfigBuilder;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
-// end:imports[]
+// end::imports[]
 
+import java.io.File;
 import org.junit.jupiter.api.Test;
 
 public class GenerateHtml extends AbstractGenerator {
    @Test
-   public void generate() throws IOException {
+   public void generate() {
       // tag::generate[]
       // AspectModel as returned by the AspectModelLoader
       final AspectModel aspectModel = // ...
             // end::generate[]
             new AspectModelLoader().load(
                   new File( "aspect-models/org.eclipse.esmf.examples.movement/1.0.0/Movement.ttl" ) );
       // tag::generate[]
-      final AspectModelDocumentationGenerator generator = // <1>
-            new AspectModelDocumentationGenerator( aspectModel.aspect() );
-
-      final Map<HtmlGenerationOption, String> options = Map.of(); // <2>
-      generator.generate( this::outputStreamForName, options );
+      final DocumentationGenerationConfig config = DocumentationGenerationConfigBuilder.builder() // <1>
+            /* .stylesheet( customCss ) if required */
+            .build();
+      final AspectModelDocumentationGenerator generator = // <2>
+            new AspectModelDocumentationGenerator( aspectModel.aspect(), config );
+      generator.generate( this::outputStreamForName );
       // end::generate[]
    }
 }

documentation/developer-guide/modules/tooling-guide/examples/GenerateJavaPojo.java

@@ -19,10 +19,10 @@
 import org.eclipse.esmf.aspectmodel.java.pojo.AspectModelJavaGenerator;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
+// end::imports[]
 
 import java.io.File;
 import org.apache.commons.io.output.NullOutputStream;
-// end::imports[]
 import org.junit.jupiter.api.Test;
 
 public class GenerateJavaPojo {

documentation/developer-guide/modules/tooling-guide/examples/GenerateJsonSchema.java

@@ -14,16 +14,14 @@
 package examples;
 
 // tag::imports[]
-import java.io.ByteArrayOutputStream;
-import java.util.Locale;
-import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
 import org.eclipse.esmf.aspectmodel.generator.jsonschema.AspectModelJsonSchemaGenerator;
 import org.eclipse.esmf.aspectmodel.generator.jsonschema.JsonSchemaGenerationConfig;
 import org.eclipse.esmf.aspectmodel.generator.jsonschema.JsonSchemaGenerationConfigBuilder;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
 
+import java.util.Locale;
+import com.fasterxml.jackson.databind.JsonNode;
 // end::imports[]
 import java.io.File;
 import java.io.IOException;
@@ -43,14 +41,11 @@ public void generate() throws IOException {
       final JsonSchemaGenerationConfig config = JsonSchemaGenerationConfigBuilder.builder()
             .locale( Locale.ENGLISH )
             .build();
-      final JsonNode jsonSchema = new AspectModelJsonSchemaGenerator( aspectModel.aspect(), config ).getContent();
-
-      // If needed, print or pretty print it into a string
-      final ByteArrayOutputStream out = new ByteArrayOutputStream();
-      final ObjectMapper objectMapper = new ObjectMapper();
-
-      objectMapper.writerWithDefaultPrettyPrinter().writeValue( out, jsonSchema );
-      final String result = out.toString();
+      final AspectModelJsonSchemaGenerator generator = new AspectModelJsonSchemaGenerator( aspectModel.aspect(), config );
+      // Get result as type-safe JSON object
+      final JsonNode jsonNode = generator.getContent();
+      // Or as pretty-printed JSON String:
+      final String json = generator.generateJson();
       // end::generate[]
    }
 }

documentation/developer-guide/modules/tooling-guide/examples/GenerateOpenApi.java

@@ -14,21 +14,18 @@
 package examples;
 
 // tag::imports[]
-import java.io.ByteArrayOutputStream;
-
 import org.eclipse.esmf.aspectmodel.generator.openapi.AspectModelOpenApiGenerator;
 import org.eclipse.esmf.aspectmodel.generator.openapi.OpenApiSchemaGenerationConfig;
 import org.eclipse.esmf.aspectmodel.generator.openapi.OpenApiSchemaGenerationConfigBuilder;
 import org.eclipse.esmf.aspectmodel.generator.openapi.PagingOption;
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
-import com.fasterxml.jackson.databind.ObjectMapper;
+// end::imports[]
+import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
-// end::imports[]
 
 import java.io.File;
 import java.io.IOException;
@@ -88,7 +85,6 @@ public void generateJson() throws IOException {
                   new File( "aspect-models/org.eclipse.esmf.examples.movement/1.0.0/Movement.ttl" ) );
       // tag::generateJson[]
 
-      final ObjectMapper objectMapper = new ObjectMapper();
       final OpenApiSchemaGenerationConfig config = OpenApiSchemaGenerationConfigBuilder.builder()
             // Server URL
             .baseUrl( "http://www.example.com" )
@@ -122,13 +118,10 @@ public void generateJson() throws IOException {
 
       // Generate the JSON
       final AspectModelOpenApiGenerator generator = new AspectModelOpenApiGenerator( aspectModel.aspect(), config );
-      final JsonNode json = generator.getContent();
-
-      // If needed, print or pretty print it into a string
-      final ByteArrayOutputStream out = new ByteArrayOutputStream();
-
-      objectMapper.writerWithDefaultPrettyPrinter().writeValue( out, json );
-      final String result = out.toString();
+      // Get result as type-safe JSON object
+      final JsonNode jsonNode = generator.getContent();
+      // Or as pretty-printed JSON String:
+      final String json = generator.generateJson();
       // end::generateJson[]
    }
 

documentation/developer-guide/modules/tooling-guide/examples/GenerateSql.java

@@ -14,8 +14,6 @@
 package examples;
 
 // tag::imports[]
-import java.io.File;
-import java.io.IOException;
 import java.util.List;
 import java.util.Locale;
 import java.util.Optional;
@@ -30,12 +28,13 @@
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
 // end::imports[]
+import java.io.File;
 
 import org.junit.jupiter.api.Test;
 
 public class GenerateSql extends AbstractGenerator {
    @Test
-   public void generate() throws IOException {
+   public void generate() {
       // tag::generate[]
       // AspectModel as returned by the AspectModelLoader
       final AspectModel aspectModel = // ...

documentation/developer-guide/modules/tooling-guide/examples/LoadAspectModelObjects.java

@@ -14,12 +14,11 @@
 package examples;
 
 // tag::imports[]
-import java.io.File;
-
 import org.eclipse.esmf.aspectmodel.loader.AspectModelLoader;
 import org.eclipse.esmf.metamodel.AspectModel;
 import org.eclipse.esmf.metamodel.ModelElement;
 // end::imports[]
+import java.io.File;
 
 import org.junit.jupiter.api.Test;