Module gov.nist.secauto.metaschema.schemagen

Package gov.nist.secauto.metaschema.schemagen.json

Interface IJsonGenerationState

All Superinterfaces:

IGenerationState<com.fasterxml.jackson.core.JsonGenerator>

public interface IJsonGenerationState
extends IGenerationState<com.fasterxml.jackson.core.JsonGenerator>

Method Summary

Modifier and Type	Method	Description
IDataTypeJsonSchema	getDataTypeSchemaForDefinition(IValuedDefinition definition)
com.fasterxml.jackson.databind.node.JsonNodeFactory	getJsonNodeFactory()
default <DEF extends IDefinition> IDefinitionJsonSchema<DEF>	getSchema(DEF definition, String jsonKeyFlagName, String discriminatorProperty, String discriminatorValue)	Get the JSON schema info for the provided definition.
IDataTypeJsonSchema	getSchema(IDataTypeAdapter<?> datatype)
<DEF extends IDefinition> IDefinitionJsonSchema<DEF>	getSchema(IDefineableJsonSchema.IKey key)
boolean	isDefinitionRegistered(IDefinitionJsonSchema<?> schema)
void	registerDefinitionSchema(IDefinitionJsonSchema<?> schema)

Methods inherited from interface gov.nist.secauto.metaschema.schemagen.IGenerationState

flushWriter, getModule, getRootDefinitions, getTypeNameForDefinition, getWriter, isInline

Method Details

getSchema

@NonNull
default <DEF extends IDefinition>
IDefinitionJsonSchema<DEF> getSchema(@NonNull
 DEF definition,
 @Nullable
 String jsonKeyFlagName,
 @Nullable
 String discriminatorProperty,
 @Nullable
 String discriminatorValue)

Get the JSON schema info for the provided definition.

Type Parameters:

DEF - the definition's Java type

Parameters:

definition - the definition to get the schema info for

jsonKeyFlagName - the name of the flag to use as the JSON key, or @{code null} if no flag is used as the JSON key

discriminatorProperty - the property name to use as the choice group discriminator, or @{code null} if no choice group discriminator is used

discriminatorValue - the property value to use as the choice group discriminator, or @{code null} if no choice group discriminator is used

Returns:

the definition's schema info

getSchema

@NonNull
<DEF extends IDefinition>
IDefinitionJsonSchema<DEF> getSchema(@NonNull
 IDefineableJsonSchema.IKey key)

getSchema

@NonNull
IDataTypeJsonSchema getSchema(@NonNull
 IDataTypeAdapter<?> datatype)

getDataTypeSchemaForDefinition

@NonNull
IDataTypeJsonSchema getDataTypeSchemaForDefinition(@NonNull
 IValuedDefinition definition)

getJsonNodeFactory

@NonNull
com.fasterxml.jackson.databind.node.JsonNodeFactory getJsonNodeFactory()

registerDefinitionSchema

void registerDefinitionSchema(IDefinitionJsonSchema<?> schema)

isDefinitionRegistered

boolean isDefinitionRegistered(IDefinitionJsonSchema<?> schema)