Module gov.nist.secauto.metaschema.schemagen

Package gov.nist.secauto.metaschema.schemagen

Interface ISchemaGenerator

All Known Implementing Classes:

AbstractSchemaGenerator, JsonSchemaGenerator, XmlSchemaGenerator

public interface ISchemaGenerator

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ISchemaGenerator.SchemaFormat	Identifies the supported schema generation formats.

Method Summary

Modifier and Type	Method	Description
void	generateFromModule(IModule metaschema, Writer writer, IConfiguration<SchemaGenerationFeature<?>> configuration)	Generate and write a schema for the provided metaschema to the Writer provided by writer using the provided configuration.
static void	generateSchema(IModule module, OutputStream os, ISchemaGenerator.SchemaFormat asFormat, IConfiguration<SchemaGenerationFeature<?>> configuration)
static void	generateSchema(IModule module, Path destination, ISchemaGenerator.SchemaFormat asFormat, IConfiguration<SchemaGenerationFeature<?>> configuration)

Method Detail

generateFromModule

void generateFromModule(@NonNull
                        IModule metaschema,
                        @NonNull
                        Writer writer,
                        @NonNull
                        IConfiguration<SchemaGenerationFeature<?>> configuration)

Generate and write a schema for the provided metaschema to the Writer provided by writer using the provided configuration.

Parameters:

metaschema - the Module to generate the schema for

writer - the writer to use to write the schema

configuration - the schema generation configuration

Throws:

SchemaGenerationException - if an error occurred while writing the schema

generateSchema

static void generateSchema(@NonNull
                           IModule module,
                           @NonNull
                           Path destination,
                           @NonNull
                           ISchemaGenerator.SchemaFormat asFormat,
                           @NonNull
                           IConfiguration<SchemaGenerationFeature<?>> configuration)
                    throws IOException

Throws:

IOException

generateSchema

static void generateSchema(@NonNull
                           IModule module,
                           @NonNull
                           OutputStream os,
                           @NonNull
                           ISchemaGenerator.SchemaFormat asFormat,
                           @NonNull
                           IConfiguration<SchemaGenerationFeature<?>> configuration)
                    throws IOException

Throws:

IOException