Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addAllOf(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- addAllowedUrlPattern(String) - Static method in class io.micronaut.jsonschema.generator.loaders.UrlLoader
- addAllowedUrlPatterns(List) - Static method in class io.micronaut.jsonschema.generator.loaders.UrlLoader
- addAnyOf(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- addDefinition(String, Schema) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- addDefinition(String, TypeDef, boolean) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- addInfo(TypedElement, Schema, VisitorContext, JsonSchemaContext) - Method in class io.micronaut.jsonschema.visitor.aggregator.DocumentationInfoAggregator
- addInfo(TypedElement, Schema, VisitorContext, JsonSchemaContext) - Method in class io.micronaut.jsonschema.visitor.aggregator.JacksonInfoAggregator
- addInfo(TypedElement, Schema, VisitorContext, JsonSchemaContext) - Method in interface io.micronaut.jsonschema.visitor.aggregator.SchemaInfoAggregator
-
A method that is called for adding JSON schema info.
- addInfo(TypedElement, Schema, VisitorContext, JsonSchemaContext) - Method in class io.micronaut.jsonschema.visitor.aggregator.ValidationInfoAggregator
- additionalProperties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
additionalPropertiesrecord component. - additionalProperties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
additionalPropertiesrecord component. - addOneOf(Schema) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- addOneOf(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- addOneOf(String) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- addRequired(String) - Method in class io.micronaut.jsonschema.model.Schema
- addTempDefinition(String, String) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- addType(Schema.Type) - Method in class io.micronaut.jsonschema.model.Schema
- ALWAYS_CLASS - Enum constant in enum class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.RecordAdoptionStrategy
-
Will always generate classes.
- AnnotationsAggregator - Class in io.micronaut.jsonschema.generator.aggregator
-
An aggregator for adding annotation information from json schema.
- AnnotationsAggregator() - Constructor for class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- array() - Static method in class io.micronaut.jsonschema.model.Schema
- ARRAY - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- ARRAY - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
An ordered list of instances.
B
- BASE_URI_PARAMETER - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- baseUri() - Method in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Returns the value of the
baseUrirecord component. - baseUrl() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
baseUrlrecord component. - BINARY_AS_ARRAY_PARAMETER - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- binaryAsArray() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
binaryAsArrayrecord component. - bool() - Static method in class io.micronaut.jsonschema.model.Schema
- BOOLEAN - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- BOOLEAN - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
A "true" or "false" value.
- build() - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
- build() - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
- buildEnum(Schema, String) - Method in class io.micronaut.jsonschema.generator.SourceGenerator
- builder(String, String) - Static method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Create a builder for a
ConfigurationError.
C
- camelCaseToKebabCase(String) - Static method in class io.micronaut.jsonschema.visitor.NameUtils
-
Convert from camel case to kebab case.
- CLASS_LOADER_REQUIRED - Static variable in interface io.micronaut.jsonschema.utils.JsonSchemaClassPathResourceLoader
-
Constant for null-check messages.
- CLASSPATH_PREFIX - Static variable in class io.micronaut.jsonschema.utils.JsonSchemaResourceUtils
- classpathFolder() - Method in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Returns the value of the
classpathFolderrecord component. - clearAll() - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- ConfigurationError - Record Class in io.micronaut.jsonschema.configuration.validator
-
A configuration validation error.
- ConfigurationError(String, ConfigurationError.Type, String, String, String, Object, int, String, String) - Constructor for record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Creates an instance of a
ConfigurationErrorrecord class. - ConfigurationError(String, String, String, String, Object) - Constructor for record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Constructs a configuration error with type
ConfigurationError.Type.ERROR. - ConfigurationError(String, String, String, String, Object, int, String, String) - Constructor for record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Constructs a configuration error with type
ConfigurationError.Type.ERRORand origin information. - ConfigurationError.Builder - Class in io.micronaut.jsonschema.configuration.validator
-
Builder for
ConfigurationError. - ConfigurationError.Type - Enum Class in io.micronaut.jsonschema.configuration.validator
-
The configuration validation error type.
- ConfigurationErrorReporter - Interface in io.micronaut.jsonschema.configuration.validator.report
-
Reports configuration validation errors.
- ConfigurationErrors - Interface in io.micronaut.jsonschema.configuration.validator
-
Runtime access to configuration validation errors.
- ConfigurationJsonSchemaValidator - Class in io.micronaut.jsonschema.configuration.validator
-
Validates Micronaut configuration (
Environment) against JSON schemas on the classpath. - ConfigurationJsonSchemaValidator() - Constructor for class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
- ConfigurationJsonSchemaValidatorCli - Class in io.micronaut.jsonschema.configuration.validator.cli
-
Command line entry point for
ConfigurationJsonSchemaValidator. - ConfigurationJsonSchemaValidatorCliBootstrap - Class in io.micronaut.jsonschema.configuration.validator.cli
-
Minimal-classpath entry point that bootstraps
ConfigurationJsonSchemaValidatorCliusing a dedicated classloader. - ConfigurationRule - Interface in io.micronaut.jsonschema.configuration.validator
-
Service Provider Interface (SPI) that allows modules to extend configuration validation with custom logic that goes beyond JSON Schema keywords.
- ConfigurationSchema - Record Class in io.micronaut.jsonschema.configuration.validator.model
-
Root configuration schema model used by the configuration validator.
- ConfigurationSchema(URI, String, String, Object, String, MicronautMetadata, String, String, Integer, Integer, Integer, Integer, Boolean, BigDecimal, Object, Map, List, Integer, Integer, List, BigDecimal, BigDecimal, BigDecimal, BigDecimal, ConfigurationSchemaProperty, Object, Map, String) - Constructor for record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Creates an instance of a
ConfigurationSchemarecord class. - ConfigurationSchemaProperty - Record Class in io.micronaut.jsonschema.configuration.validator.model
-
Configuration schema property model used by the configuration validator.
- ConfigurationSchemaProperty(Object, String, String, Boolean, String, Integer, Integer, Integer, Integer, Boolean, BigDecimal, Object, String, String, String, Map, List, Integer, Integer, List, BigDecimal, BigDecimal, BigDecimal, BigDecimal, ConfigurationSchemaProperty, Object, Map, String) - Constructor for record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Creates an instance of a
ConfigurationSchemaPropertyrecord class. - configurationSchemasFolder() - Static method in class io.micronaut.jsonschema.utils.JsonSchemaResourceUtils
- ConfigurationSchemaType - Enum Class in io.micronaut.jsonschema.configuration.validator.model
-
A subset of JSON schema types used by Micronaut configuration schemas.
- ConfigurationValidationContext - Record Class in io.micronaut.jsonschema.configuration.validator
-
Context object passed to
ConfigurationRuleimplementations. - ConfigurationValidationContext(Environment, String, ConfigurationSchema, ConfigurationSchemaProperty, Map) - Constructor for record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Creates an instance of a
ConfigurationValidationContextrecord class. - ConfigurationValidator - Interface in io.micronaut.jsonschema.configuration.validator
-
API to validate the configuration.
- ConfigurationValidatorConfiguration - Class in io.micronaut.jsonschema.configuration.validator
-
Runtime configuration for configuration validation support.
- ConfigurationValidatorConfiguration() - Constructor for class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
- constValue() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
constValuerecord component. - constValue() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
constValuerecord component. - container() - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Returns the value of the
containerrecord component. - createDefault(ClassLoader) - Static method in interface io.micronaut.jsonschema.utils.JsonSchemaClassPathResourceLoader
-
Create a default
JsonSchemaClassPathResourceLoaderfor the givenClassLoader. - createDefault(Map) - Static method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- createdSchemasByType() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
createdSchemasByTyperecord component. - createMapper() - Static method in class io.micronaut.jsonschema.serialization.JsonSchemaMapperFactory
-
Create a JSON object mapper.
- createSchema(TypedElement, VisitorContext, JsonSchemaContext) - Static method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
-
A method for creating a property of the schema.
- createTopLevelSchema(TypedElement, VisitorContext, JsonSchemaContext) - Static method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
-
A method for creating a JSON schema.
- currentOriginatingElements() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
currentOriginatingElementsrecord component.
D
- DEF_SCHEMA_REF_PREFIX - Static variable in class io.micronaut.jsonschema.model.Schema
- DEFAULT_BINARY_AS_ARRAY - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- DEFAULT_CACHE - Static variable in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
- DEFAULT_ENABLED - Static variable in class io.micronaut.jsonschema.configuration.validator.HealthConfiguration
- DEFAULT_FAIL_ON_NOT_PRESENT - Static variable in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
- DEFAULT_OUTPUT_LOCATION - Static variable in interface io.micronaut.jsonschema.utils.JsonSchemaConfiguration
- DEFAULT_OUTPUT_LOCATION - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- defs() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
defsrecord component. - defs() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
defsrecord component. - deprecated() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
deprecatedrecord component. - description() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
descriptionrecord component. - description() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
descriptionrecord component. - description() - Element in annotation interface io.micronaut.jsonschema.JsonSchema
-
The description of the JSON schema.
- DocumentationInfoAggregator - Class in io.micronaut.jsonschema.visitor.aggregator
-
An aggregator for adding information from the jackson serialization annotations.
- DocumentationInfoAggregator() - Constructor for class io.micronaut.jsonschema.visitor.aggregator.DocumentationInfoAggregator
- draft() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
draftrecord component. - DRAFT_2020_12 - Enum constant in enum class io.micronaut.jsonschema.visitor.context.JsonSchemaContext.JsonSchemaDraft
E
- enumValues() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
enumValuesrecord component. - enumValues() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
enumValuesrecord component. - environment() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns the value of the
environmentrecord component. - equals(Object) - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Indicates whether some other object is "equal to" this one.
- ERROR - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Type
-
A validation error.
- exclusiveMaximum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
exclusiveMaximumrecord component. - exclusiveMaximum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
exclusiveMaximumrecord component. - exclusiveMinimum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
exclusiveMinimumrecord component. - exclusiveMinimum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
exclusiveMinimumrecord component.
F
- FALSE - Static variable in class io.micronaut.jsonschema.model.Schema
-
A false schema is a schema that would be invalid for any instance.
- FileLoader - Class in io.micronaut.jsonschema.generator.loaders
-
Loads a JSON schema from a file.
- FileLoader(File) - Constructor for class io.micronaut.jsonschema.generator.loaders.FileLoader
- FileProcessor - Class in io.micronaut.jsonschema.generator.loaders
- FileProcessor() - Constructor for class io.micronaut.jsonschema.generator.loaders.FileProcessor
- forClasspath(String, List, boolean, ConfigurationJsonSchemaValidator) - Static method in class io.micronaut.jsonschema.configuration.validator.cli.JsonSchemaConfigurationValidator
- forClasspath(String, List, ConfigurationJsonSchemaValidator) - Static method in class io.micronaut.jsonschema.configuration.validator.cli.JsonSchemaConfigurationValidator
- format() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
formatrecord component. - format() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
formatrecord component.
G
- generate(SourceGeneratorConfig) - Method in class io.micronaut.jsonschema.generator.SourceGenerator
-
Generates source code from JSON schema files based on the provided configuration.
- generatedSchemasFolder(JsonSchemaConfiguration) - Static method in class io.micronaut.jsonschema.utils.JsonSchemaResourceUtils
- GeneratorContext - Class in io.micronaut.jsonschema.generator.utils
-
An aggregator for storing and accessing definitions and oneOf relations from json schema.
- GeneratorContext() - Constructor for class io.micronaut.jsonschema.generator.utils.GeneratorContext
- GeneratorMain - Class in io.micronaut.jsonschema.generator
-
An entry point to be used in tests, to simulate what the Source Generation from Json Schema plugin would do.
- GeneratorMain() - Constructor for class io.micronaut.jsonschema.generator.GeneratorMain
- get$defs() - Method in class io.micronaut.jsonschema.model.Schema
- get$id() - Method in class io.micronaut.jsonschema.model.Schema
- get$ref() - Method in class io.micronaut.jsonschema.model.Schema
- get$schema() - Method in class io.micronaut.jsonschema.model.Schema
- getAdditionalProperties() - Method in class io.micronaut.jsonschema.model.Schema
- getAllOf() - Method in class io.micronaut.jsonschema.model.Schema
- getAllowedUrlPatterns() - Static method in class io.micronaut.jsonschema.generator.loaders.UrlLoader
- getAnnotations(Schema, TypeDef, boolean) - Static method in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- getAnyOf() - Method in class io.micronaut.jsonschema.model.Schema
- getClassName(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- getConfiguration() - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
-
Get the current configuration.
- getConstantName(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- getConstValue() - Method in class io.micronaut.jsonschema.model.Schema
- getContains() - Method in class io.micronaut.jsonschema.model.Schema
- getCurrentErrors() - Method in interface io.micronaut.jsonschema.configuration.validator.ConfigurationErrors
-
Validate the current
Environmentconfiguration and return the resulting errors. - getDefaultValue() - Method in class io.micronaut.jsonschema.model.Schema
- getDefinitionType(String) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- getDescription() - Method in class io.micronaut.jsonschema.model.Schema
- getDiscriminator() - Method in class io.micronaut.jsonschema.model.Schema
- getDraftUrl() - Method in enum class io.micronaut.jsonschema.visitor.context.JsonSchemaContext.JsonSchemaDraft
-
Get the URL referencing the schema of the draft.
- getEnumValues() - Method in class io.micronaut.jsonschema.model.Schema
- getExamples() - Method in class io.micronaut.jsonschema.model.Schema
- getExclusiveMaximum() - Method in class io.micronaut.jsonschema.model.Schema
- getExclusiveMinimum() - Method in class io.micronaut.jsonschema.model.Schema
- getFileName(Schema, Optional) - Static method in class io.micronaut.jsonschema.generator.loaders.FileProcessor
- getFormat() - Method in class io.micronaut.jsonschema.model.Schema
- getInputFileName() - Static method in class io.micronaut.jsonschema.generator.SourceGenerator
- getInputName() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
- getItems() - Method in class io.micronaut.jsonschema.model.Schema
- getJsonPropertyAnn(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- getJsonSchema(SourceGeneratorConfig) - Static method in class io.micronaut.jsonschema.generator.loaders.FileProcessor
-
Loads a JSON schema based on the configuration.
- getJsonSubTypesAnn(Map, GeneratorContext) - Static method in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- getJsonTypeInfoAnn(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- getLanguage() - Static method in class io.micronaut.jsonschema.generator.SourceGenerator
- getMaxContains() - Method in class io.micronaut.jsonschema.model.Schema
- getMaximum() - Method in class io.micronaut.jsonschema.model.Schema
- getMaxItems() - Method in class io.micronaut.jsonschema.model.Schema
- getMaxLength() - Method in class io.micronaut.jsonschema.model.Schema
- getMessage() - Method in interface io.micronaut.jsonschema.validation.ValidationMessage
- getMessage() - Method in class io.micronaut.jsonschema.validation.ValidationMessageAdapter
- getMinContains() - Method in class io.micronaut.jsonschema.model.Schema
- getMinimum() - Method in class io.micronaut.jsonschema.model.Schema
- getMinItems() - Method in class io.micronaut.jsonschema.model.Schema
- getMinLength() - Method in class io.micronaut.jsonschema.model.Schema
- getMultipleOf() - Method in class io.micronaut.jsonschema.model.Schema
- getNot() - Method in class io.micronaut.jsonschema.model.Schema
- getOneOf() - Method in class io.micronaut.jsonschema.model.Schema
- getOneOfsToGenerate() - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- getOutputFile(Path, String, String) - Static method in class io.micronaut.jsonschema.generator.loaders.FileProcessor
-
Creates or retrieves a file at the specified output path, package name, and file name.
- getOutputLocation() - Method in interface io.micronaut.jsonschema.utils.JsonSchemaConfiguration
-
The location where JSON schemas will be generated inside the build META-INF/ directory.
- getOutputPackageName() - Static method in class io.micronaut.jsonschema.generator.SourceGenerator
- getOutputPath() - Static method in class io.micronaut.jsonschema.generator.SourceGenerator
- getParameters() - Static method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- getPattern() - Method in class io.micronaut.jsonschema.model.Schema
- getProperties() - Method in class io.micronaut.jsonschema.model.Schema
- getPropertyName(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- getRequired() - Method in class io.micronaut.jsonschema.model.Schema
- getSupportedOptions() - Method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
- getSuppressionPatterns() - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
-
Patterns used to suppress validation errors.
- getSuppressions() - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
-
Patterns used to suppress validation errors.
- getTitle() - Method in class io.micronaut.jsonschema.model.Schema
- getType() - Method in class io.micronaut.jsonschema.model.Schema
- getTypeDefFromJson(Schema, GeneratorContext) - Static method in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
-
Extracts a Java type definition (
TypeDef) from a given JSON schema. - getValidationMessage() - Method in class io.micronaut.jsonschema.validation.ValidationMessageAdapter
- getVisitorKind() - Method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
H
- has$defs() - Method in class io.micronaut.jsonschema.model.Schema
- has$ref() - Method in class io.micronaut.jsonschema.model.Schema
- hasAdditionalProperties() - Method in class io.micronaut.jsonschema.model.Schema
- hasAllOf() - Method in class io.micronaut.jsonschema.model.Schema
- hasAnyOf() - Method in class io.micronaut.jsonschema.model.Schema
- hasConstValue() - Method in class io.micronaut.jsonschema.model.Schema
- hasDefaultValue() - Method in class io.micronaut.jsonschema.model.Schema
- hasDefinition(String) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- hasDescription() - Method in class io.micronaut.jsonschema.model.Schema
- hasDiscriminator() - Method in class io.micronaut.jsonschema.model.Schema
- hashCode() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Returns a hash code value for this object.
- hashCode() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns a hash code value for this object.
- hasOneOf() - Method in class io.micronaut.jsonschema.model.Schema
- hasProperties() - Method in class io.micronaut.jsonschema.model.Schema
- hasRequired() - Method in class io.micronaut.jsonschema.model.Schema
- hasTitle() - Method in class io.micronaut.jsonschema.model.Schema
- hasType() - Method in class io.micronaut.jsonschema.model.Schema
- HealthConfiguration - Class in io.micronaut.jsonschema.configuration.validator
-
Configuration for enabling/disabling the configuration errors health indicator.
- HealthConfiguration() - Constructor for class io.micronaut.jsonschema.configuration.validator.HealthConfiguration
- HtmlConfigurationErrorReporter - Class in io.micronaut.jsonschema.configuration.validator.report
-
Reports errors as an HTML document.
- HtmlConfigurationErrorReporter(OutputStream) - Constructor for class io.micronaut.jsonschema.configuration.validator.report.HtmlConfigurationErrorReporter
I
- id() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
idrecord component. - inputFolder() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
inputFolderrecord component. - inputStream() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
inputStreamrecord component. - instanceMap() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns the value of the
instanceMaprecord component. - integer() - Static method in class io.micronaut.jsonschema.model.Schema
- INTEGER - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- INTEGER - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
An integer.
- io.micronaut.jsonschema - package io.micronaut.jsonschema
- io.micronaut.jsonschema.configuration.validator - package io.micronaut.jsonschema.configuration.validator
-
JSON schema-based configuration validation support.
- io.micronaut.jsonschema.configuration.validator.cli - package io.micronaut.jsonschema.configuration.validator.cli
-
CLI support for configuration validation.
- io.micronaut.jsonschema.configuration.validator.model - package io.micronaut.jsonschema.configuration.validator.model
-
Schema model used by the configuration validator.
- io.micronaut.jsonschema.configuration.validator.report - package io.micronaut.jsonschema.configuration.validator.report
-
Error reporting formats.
- io.micronaut.jsonschema.generator - package io.micronaut.jsonschema.generator
- io.micronaut.jsonschema.generator.aggregator - package io.micronaut.jsonschema.generator.aggregator
- io.micronaut.jsonschema.generator.loaders - package io.micronaut.jsonschema.generator.loaders
- io.micronaut.jsonschema.generator.utils - package io.micronaut.jsonschema.generator.utils
- io.micronaut.jsonschema.info - package io.micronaut.jsonschema.info
- io.micronaut.jsonschema.model - package io.micronaut.jsonschema.model
- io.micronaut.jsonschema.serialization - package io.micronaut.jsonschema.serialization
- io.micronaut.jsonschema.utils - package io.micronaut.jsonschema.utils
- io.micronaut.jsonschema.validation - package io.micronaut.jsonschema.validation
-
Classes related to JSON Schema Validation.
- io.micronaut.jsonschema.visitor - package io.micronaut.jsonschema.visitor
- io.micronaut.jsonschema.visitor.aggregator - package io.micronaut.jsonschema.visitor.aggregator
- io.micronaut.jsonschema.visitor.context - package io.micronaut.jsonschema.visitor.context
- isCache() - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
-
Whether the validation result should be cached.
- isDefinitionClass(String) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- isDeprecated() - Method in class io.micronaut.jsonschema.model.Schema
- isEnabled() - Method in class io.micronaut.jsonschema.configuration.validator.HealthConfiguration
- isEnum() - Method in class io.micronaut.jsonschema.model.Schema
- isFailOnNotPresent() - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
- isFailOnNotPresent() - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
-
Whether to fail when configuration contains keys not present in schema.
- isInheriting(String) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
- isNullable() - Method in class io.micronaut.jsonschema.model.Schema
- isOnlyLetters(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- isReadOnly() - Method in class io.micronaut.jsonschema.model.Schema
- isUniqueItems() - Method in class io.micronaut.jsonschema.model.Schema
- isValidUrl(String) - Static method in class io.micronaut.jsonschema.generator.loaders.UrlLoader
-
Validates if the provided URL matches any of the allowed patterns.
- isWriteOnly() - Method in class io.micronaut.jsonschema.model.Schema
- items() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
itemsrecord component. - items() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
itemsrecord component.
J
- JacksonInfoAggregator - Class in io.micronaut.jsonschema.visitor.aggregator
-
An aggregator for adding information from the jackson serialization annotations.
- JacksonInfoAggregator() - Constructor for class io.micronaut.jsonschema.visitor.aggregator.JacksonInfoAggregator
- javadoc() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
javadocrecord component. - JavadocConfig() - Constructor for record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
-
Initialize the configuration with defaults.
- JavadocConfig(boolean) - Constructor for record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
-
Creates an instance of a
JavadocConfigrecord class. - javaType() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
javaTyperecord component. - JSON_ANY_GETTER_ANN - Static variable in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- JSON_ANY_SETTER_ANN - Static variable in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- JSON_CREATOR_ANN - Static variable in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- JSON_MAPPER - Static variable in interface io.micronaut.jsonschema.generator.loaders.SchemaLoader
- JSON_SCHEMA_CONTEXT_PROPERTY - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- JSON_SCHEMA_DRAFT_PARAMETER - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- JSON_VALUE_ANN - Static variable in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- JsonConfigurationErrorReporter - Class in io.micronaut.jsonschema.configuration.validator.report
-
Reports errors as JSON.
- JsonConfigurationErrorReporter(JsonMapper, OutputStream) - Constructor for class io.micronaut.jsonschema.configuration.validator.report.JsonConfigurationErrorReporter
- jsonFile() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
jsonFilerecord component. - JsonSchema - Annotation Interface in io.micronaut.jsonschema
-
An annotation that signifies that json schema should be created for the object.
- JsonSchemaClassPathResourceLoader - Interface in io.micronaut.jsonschema.utils
-
API to retrieve a JSON Schema for a class.
- JsonSchemaConfiguration - Interface in io.micronaut.jsonschema.utils
-
Json Schema Configuration.
- JsonSchemaConfigurationValidator - Class in io.micronaut.jsonschema.configuration.validator.cli
-
CLI-oriented facade that constructs a classloader and environment and delegates to
ConfigurationJsonSchemaValidator. - JsonSchemaConfigurationValidator(List, List, boolean, ConfigurationJsonSchemaValidator) - Constructor for class io.micronaut.jsonschema.configuration.validator.cli.JsonSchemaConfigurationValidator
- JsonSchemaContext - Record Class in io.micronaut.jsonschema.visitor.context
-
A context with configuration for the JSON schema.
- JsonSchemaContext(String, String, boolean, JsonSchemaContext.JsonSchemaDraft, boolean, Map, List) - Constructor for record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Creates an instance of a
JsonSchemaContextrecord class. - JsonSchemaContext.JsonSchemaDraft - Enum Class in io.micronaut.jsonschema.visitor.context
-
An enum for JSON Schema draft versions.
- JsonSchemaMapperFactory - Class in io.micronaut.jsonschema.serialization
-
A factory of mappers for json schema serialization and deserialization.
- JsonSchemaMapperFactory() - Constructor for class io.micronaut.jsonschema.serialization.JsonSchemaMapperFactory
- JsonSchemaResourceUtils - Class in io.micronaut.jsonschema.utils
-
Internal utilities for resolving JSON schema resources on the classpath.
- jsonSchemas() - Method in interface io.micronaut.jsonschema.utils.JsonSchemaClassPathResourceLoader
- jsonSchemaStringForClass(Class) - Method in interface io.micronaut.jsonschema.utils.JsonSchemaClassPathResourceLoader
-
This method retrieves the JSON Schema for a class for which a JSON Schema was generated.
- JsonSchemaValidator - Interface in io.micronaut.jsonschema.validation
-
JSON Schema Validator.
- JsonSchemaValidatorConfiguration - Record Class in io.micronaut.jsonschema.validation
-
A configuration for
JsonSchemaValidator. - JsonSchemaValidatorConfiguration(String, String) - Constructor for record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Creates an instance of a
JsonSchemaValidatorConfigurationrecord class. - JsonSchemaVisitor - Class in io.micronaut.jsonschema.visitor
-
A visitor for creating JSON schemas for beans.
- JsonSchemaVisitor() - Constructor for class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
- jsonUrl() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
jsonUrlrecord component.
K
- kind() - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Returns the value of the
kindrecord component.
L
- lineNumber() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
lineNumberrecord component. - lineNumber(int) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set the 1-based line number in the origin file.
- load() - Method in class io.micronaut.jsonschema.generator.loaders.FileLoader
- load() - Method in interface io.micronaut.jsonschema.generator.loaders.SchemaLoader
-
Loads a JSON schema.
- load() - Method in class io.micronaut.jsonschema.generator.loaders.StreamLoader
- load() - Method in class io.micronaut.jsonschema.generator.loaders.UrlLoader
M
- main(String[]) - Static method in class io.micronaut.jsonschema.configuration.validator.cli.ConfigurationJsonSchemaValidatorCli
-
CLI entry point.
- main(String[]) - Static method in class io.micronaut.jsonschema.configuration.validator.cli.ConfigurationJsonSchemaValidatorCliBootstrap
-
Bootstrap entry point.
- main(String[]) - Static method in class io.micronaut.jsonschema.generator.GeneratorMain
-
The main executable.
- mapping() - Method in record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
-
Returns the value of the
mappingrecord component. - maximum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
maximumrecord component. - maximum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
maximumrecord component. - maxItems() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
maxItemsrecord component. - maxItems() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
maxItemsrecord component. - maxLength() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
maxLengthrecord component. - maxLength() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
maxLengthrecord component. - maxProperties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
maxPropertiesrecord component. - maxProperties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
maxPropertiesrecord component. - merge(Schema) - Method in class io.micronaut.jsonschema.model.Schema
-
Merges the properties of the current schema with those of another schema.
- merge(Schema.SchemaDiscriminator) - Method in record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
- mergeAllOf() - Method in class io.micronaut.jsonschema.model.Schema
- message() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
messagerecord component. - META_INF - Static variable in class io.micronaut.jsonschema.utils.JsonSchemaResourceUtils
- micronaut() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
micronautrecord component. - MicronautJsonSchemaAnnotationsModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaAnnotationsModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaAnnotationsModuleInfo
- MicronautJsonSchemaCommonModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaCommonModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaCommonModuleInfo
- MicronautJsonSchemaConfigurationValidatorModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaConfigurationValidatorModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaConfigurationValidatorModuleInfo
- MicronautJsonSchemaGeneratorModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaGeneratorModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaGeneratorModuleInfo
- MicronautJsonSchemaProcessorModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaProcessorModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaProcessorModuleInfo
- MicronautJsonSchemaUtilsModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaUtilsModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaUtilsModuleInfo
- MicronautJsonSchemaValidationModuleInfo - Class in io.micronaut.jsonschema.info
- MicronautJsonSchemaValidationModuleInfo() - Constructor for class io.micronaut.jsonschema.info.MicronautJsonSchemaValidationModuleInfo
- MicronautMetadata - Record Class in io.micronaut.jsonschema.configuration.validator.model
-
Micronaut-specific schema metadata.
- MicronautMetadata(String, String, String, String) - Constructor for record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Creates an instance of a
MicronautMetadatarecord class. - micronautPath() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
micronautPathrecord component. - minimum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
minimumrecord component. - minimum() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
minimumrecord component. - minItems() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
minItemsrecord component. - minItems() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
minItemsrecord component. - minLength() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
minLengthrecord component. - minLength() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
minLengthrecord component. - minProperties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
minPropertiesrecord component. - minProperties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
minPropertiesrecord component. - multipleOf() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
multipleOfrecord component. - multipleOf() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
multipleOfrecord component.
N
- NameUtils - Class in io.micronaut.jsonschema.visitor
-
A utility class for name conversions.
- NameUtils() - Constructor for class io.micronaut.jsonschema.visitor.NameUtils
- NOT_NULL_ANN - Static variable in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- NULL - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
A JSON "null" value.
- number() - Static method in class io.micronaut.jsonschema.model.Schema
- NUMBER - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- NUMBER - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
An arbitrary-precision, base-10 decimal number value.
O
- object() - Static method in class io.micronaut.jsonschema.model.Schema
- OBJECT - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- OBJECT - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
An unordered set of properties mapping a string to an instance.
- of(String) - Static method in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- ONE_OF_SCHEMA_REF_PREFIX - Static variable in class io.micronaut.jsonschema.model.Schema
- originLocation() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
originLocationrecord component. - originLocation(String) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set the origin location for this error.
- OUTPUT_LOCATION_PARAMETER - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- outputFileName() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
outputFileNamerecord component. - outputLocation() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
outputLocationrecord component. - outputPackageName() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
outputPackageNamerecord component. - outputPath() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
outputPathrecord component.
P
- PARAMETER_PREFIX - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- pattern() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
patternrecord component. - pattern() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
patternrecord component. - PREFER_RECORD - Enum constant in enum class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.RecordAdoptionStrategy
-
Will generate record when possible.
- prefix() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns the value of the
prefixrecord component. - prefix() - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Returns the value of the
prefixrecord component. - PREFIX - Static variable in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
-
Configuration prefix.
- PREFIX - Static variable in class io.micronaut.jsonschema.configuration.validator.HealthConfiguration
-
Configuration prefix.
- PREFIX - Static variable in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
The JSON schema validation configuration prefix.
- properties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
propertiesrecord component. - properties() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
propertiesrecord component. - property() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
propertyrecord component. - property() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns the value of the
propertyrecord component. - propertyName() - Method in record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
-
Returns the value of the
propertyNamerecord component. - put$def(String, Schema) - Method in class io.micronaut.jsonschema.model.Schema
- putProperty(String, Schema) - Method in class io.micronaut.jsonschema.model.Schema
R
- rawPropertyName() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
rawPropertyNamerecord component. - rawPropertyName(String) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set the raw (non-normalized) property name.
- rawValue() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
rawValuerecord component. - rawValue(Object) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set the raw value.
- recordAdoptionStrategy() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns the value of the
recordAdoptionStrategyrecord component. - ref() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
refrecord component. - ref() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
refrecord component. - reference(String) - Static method in class io.micronaut.jsonschema.model.Schema
- replaceHTML() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
-
Returns the value of the
replaceHTMLrecord component. - report(Set) - Method in interface io.micronaut.jsonschema.configuration.validator.report.ConfigurationErrorReporter
-
Report configuration validation errors.
- report(Set) - Method in class io.micronaut.jsonschema.configuration.validator.report.HtmlConfigurationErrorReporter
- report(Set) - Method in class io.micronaut.jsonschema.configuration.validator.report.JsonConfigurationErrorReporter
- report(Set) - Method in class io.micronaut.jsonschema.configuration.validator.report.SystemErrConfigurationErrorReporter
- required() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
requiredrecord component. - required() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
requiredrecord component. - resolvePathWithinFolder(String, String, String, String) - Static method in class io.micronaut.jsonschema.utils.JsonSchemaResourceUtils
-
Resolve and normalize a relative schema path within the given folder.
S
- schema() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns the value of the
schemarecord component. - schema() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
schemarecord component. - Schema - Class in io.micronaut.jsonschema.model
-
A JSON schema.
- Schema() - Constructor for class io.micronaut.jsonschema.model.Schema
- Schema.SchemaDiscriminator - Record Class in io.micronaut.jsonschema.model
-
Discriminator defines a property that can be used to distinguish between schemas that are defined as subtypes in code.
- Schema.Type - Enum Class in io.micronaut.jsonschema.model
-
The type of schema exactly matching a primitive JSON type.
- SchemaDiscriminator(String, Map) - Constructor for record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
-
Creates an instance of a
SchemaDiscriminatorrecord class. - SchemaInfoAggregator - Interface in io.micronaut.jsonschema.visitor.aggregator
-
An interface for objects responsible for aggregating JSON schema info.
- SchemaLoader - Interface in io.micronaut.jsonschema.generator.loaders
-
Interface for loading a JSON schema from various sources.
- SERDEABLE_ANN - Static variable in class io.micronaut.jsonschema.generator.aggregator.AnnotationsAggregator
- set$defs(Map) - Method in class io.micronaut.jsonschema.model.Schema
- set$id(String) - Method in class io.micronaut.jsonschema.model.Schema
- set$ref(String) - Method in class io.micronaut.jsonschema.model.Schema
- set$schema(String) - Method in class io.micronaut.jsonschema.model.Schema
- setAdditionalProperties(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- setAllOf(List) - Method in class io.micronaut.jsonschema.model.Schema
- setAllowedUrlPatterns(List) - Static method in class io.micronaut.jsonschema.generator.loaders.UrlLoader
- setAnyOf(List) - Method in class io.micronaut.jsonschema.model.Schema
- setBeanSchemaProperties(ClassElement, VisitorContext, JsonSchemaContext, Schema) - Static method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
- setCache(boolean) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
- setConfiguration(SourceGeneratorConfig) - Method in class io.micronaut.jsonschema.generator.utils.GeneratorContext
-
Set the current configuration.
- setConstValue(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setContains(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- setDefaultValue(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setDeprecated(boolean) - Method in class io.micronaut.jsonschema.model.Schema
- setDescription(String) - Method in class io.micronaut.jsonschema.model.Schema
- setDiscriminator(Schema.SchemaDiscriminator) - Method in class io.micronaut.jsonschema.model.Schema
- setEnabled(boolean) - Method in class io.micronaut.jsonschema.configuration.validator.HealthConfiguration
- setEnumValues(List) - Method in class io.micronaut.jsonschema.model.Schema
- setExamples(List) - Method in class io.micronaut.jsonschema.model.Schema
- setExclusiveMaximum(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setExclusiveMinimum(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setFailOnNotPresent(boolean) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
- setFailOnNotPresent(boolean) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
- setFormat(String) - Method in class io.micronaut.jsonschema.model.Schema
- setInputFileName(String) - Static method in class io.micronaut.jsonschema.generator.SourceGenerator
- setItems(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- setJsonMapper(JsonMapper) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
- setMaxContains(Integer) - Method in class io.micronaut.jsonschema.model.Schema
- setMaximum(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setMaxItems(Integer) - Method in class io.micronaut.jsonschema.model.Schema
- setMaxLength(Integer) - Method in class io.micronaut.jsonschema.model.Schema
- setMinContains(Integer) - Method in class io.micronaut.jsonschema.model.Schema
- setMinimum(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setMinItems(Integer) - Method in class io.micronaut.jsonschema.model.Schema
- setMinLength(Integer) - Method in class io.micronaut.jsonschema.model.Schema
- setMultipleOf(Object) - Method in class io.micronaut.jsonschema.model.Schema
- setNot(Schema) - Method in class io.micronaut.jsonschema.model.Schema
- setNullable(boolean) - Method in class io.micronaut.jsonschema.model.Schema
- setOneOf(List) - Method in class io.micronaut.jsonschema.model.Schema
- setPattern(String) - Method in class io.micronaut.jsonschema.model.Schema
- setProperties(Map) - Method in class io.micronaut.jsonschema.model.Schema
- setReadOnly(boolean) - Method in class io.micronaut.jsonschema.model.Schema
- setRequired(List) - Method in class io.micronaut.jsonschema.model.Schema
- setSuppressionPatterns(List) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
-
Set patterns used to suppress validation errors.
- setSuppressions(List) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationValidatorConfiguration
- setTitle(String) - Method in class io.micronaut.jsonschema.model.Schema
- setType(List) - Method in class io.micronaut.jsonschema.model.Schema
- setUniqueItems(boolean) - Method in class io.micronaut.jsonschema.model.Schema
- setWriteOnly(boolean) - Method in class io.micronaut.jsonschema.model.Schema
- SLASH - Static variable in class io.micronaut.jsonschema.utils.JsonSchemaResourceUtils
- snippet() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
snippetrecord component. - snippet(String) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set a best-effort snippet showing the invalid definition.
- snippetLanguage() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
snippetLanguagerecord component. - snippetLanguage(String) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set the snippet language.
- SourceGenerator - Class in io.micronaut.jsonschema.generator
-
A source generator to create source files from Json Schema.
- SourceGenerator(VisitorContext.Language, GeneratorContext) - Constructor for class io.micronaut.jsonschema.generator.SourceGenerator
-
Constructs a new
SourceGeneratorinstance based on the provided programming language and the generation context. - SourceGenerator(String) - Constructor for class io.micronaut.jsonschema.generator.SourceGenerator
-
Constructs a new
SourceGeneratorinstance based on the provided programming language. - SourceGeneratorConfig - Record Class in io.micronaut.jsonschema.generator.utils
-
A configuration class for the JSON schema source generator, encapsulating the configuration properties related to the input and output paths, file names, and URL.
- SourceGeneratorConfig(InputStream, String, File, Path, Path, String, String, SourceGeneratorConfig.JavadocConfig, SourceGeneratorConfig.RecordAdoptionStrategy) - Constructor for record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Creates an instance of a
SourceGeneratorConfigrecord class. - SourceGeneratorConfig.JavadocConfig - Record Class in io.micronaut.jsonschema.generator.utils
-
A sub-configuration used for generated Javadoc.
- SourceGeneratorConfig.RecordAdoptionStrategy - Enum Class in io.micronaut.jsonschema.generator.utils
-
Strategy enum that specifies when to generate records vs classes.
- SourceGeneratorConfigBuilder - Class in io.micronaut.jsonschema.generator.utils
-
A builder class for the
SourceGeneratorConfig; encapsulating the configuration properties related to the input and output paths; file names; and URL. - SourceGeneratorConfigBuilder() - Constructor for class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
- sourceType() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
sourceTyperecord component. - StreamLoader - Class in io.micronaut.jsonschema.generator.loaders
-
Loads a JSON schema from an Input Stream.
- StreamLoader(InputStream) - Constructor for class io.micronaut.jsonschema.generator.loaders.StreamLoader
- STRICT_MODE_PARAMETER - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- strictMode() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
strictModerecord component. - string() - Static method in class io.micronaut.jsonschema.model.Schema
- STRING - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- STRING - Enum constant in enum class io.micronaut.jsonschema.model.Schema.Type
-
A string of Unicode code points.
- supportsPrefix(String) - Method in interface io.micronaut.jsonschema.configuration.validator.ConfigurationRule
-
Whether this rule supports the given configuration prefix.
- SystemErrConfigurationErrorReporter - Class in io.micronaut.jsonschema.configuration.validator.report
-
Reports errors to
System.err. - SystemErrConfigurationErrorReporter() - Constructor for class io.micronaut.jsonschema.configuration.validator.report.SystemErrConfigurationErrorReporter
-
Creates a reporter that writes to
System.err. - SystemErrConfigurationErrorReporter(PrintStream) - Constructor for class io.micronaut.jsonschema.configuration.validator.report.SystemErrConfigurationErrorReporter
-
Creates a reporter that writes to the given stream.
- SystemErrConfigurationErrorReporter(PrintStream, Path, Path) - Constructor for class io.micronaut.jsonschema.configuration.validator.report.SystemErrConfigurationErrorReporter
-
Creates a reporter that writes to the given stream and optionally prints the location of written report files.
- SystemErrConfigurationErrorReporter(PrintStream, Path, Path, Path, List) - Constructor for class io.micronaut.jsonschema.configuration.validator.report.SystemErrConfigurationErrorReporter
-
Creates a reporter that writes to the given stream and optionally prints the location of written report files.
T
- THIS_SCHEMA_REF - Static variable in class io.micronaut.jsonschema.model.Schema
- title() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
titlerecord component. - title() - Element in annotation interface io.micronaut.jsonschema.JsonSchema
-
The title of the JSON schema.
- toBuilder() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Convert this configuration to builder.
- toString() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationValidationContext
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.JavadocConfig
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.model.Schema.SchemaDiscriminator
-
Returns a string representation of this record class.
- toString() - Method in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Returns a string representation of this record class.
- toString() - Method in class io.micronaut.jsonschema.validation.ValidationMessageAdapter
- toString() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns a string representation of this record class.
- TRUE - Static variable in class io.micronaut.jsonschema.model.Schema
-
A true schema is a schema that would be valid for any instance.
- type() - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
-
Returns the value of the
typerecord component. - type() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
typerecord component. - type() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
typerecord component. - type() - Method in record class io.micronaut.jsonschema.configuration.validator.model.MicronautMetadata
-
Returns the value of the
typerecord component. - type(ConfigurationError.Type) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Builder
-
Set the error
ConfigurationError.Type. - TYPE_MAP - Static variable in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- TYPE_MAP_NULLABLE - Static variable in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- TypeAggregator - Class in io.micronaut.jsonschema.generator.aggregator
-
An aggregator for deducing type information from json schema.
- TypeAggregator() - Constructor for class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
U
- unicodeToString(String) - Static method in class io.micronaut.jsonschema.generator.aggregator.TypeAggregator
- uniqueItems() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchema
-
Returns the value of the
uniqueItemsrecord component. - uniqueItems() - Method in record class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaProperty
-
Returns the value of the
uniqueItemsrecord component. - UNSUPPORTED_ANNOTATIONS - Static variable in class io.micronaut.jsonschema.visitor.aggregator.JacksonInfoAggregator
- UNSUPPORTED_ANNOTATIONS - Static variable in class io.micronaut.jsonschema.visitor.aggregator.ValidationInfoAggregator
- uri() - Element in annotation interface io.micronaut.jsonschema.JsonSchema
-
The schema's relative or absolute URI.
- UrlLoader - Class in io.micronaut.jsonschema.generator.loaders
-
Loads a JSON schema from a URL.
- UrlLoader(String) - Constructor for class io.micronaut.jsonschema.generator.loaders.UrlLoader
V
- validate() - Method in class io.micronaut.jsonschema.configuration.validator.cli.JsonSchemaConfigurationValidator
-
Validate the configuration found on the configured classpath.
- validate(Environment) - Method in interface io.micronaut.jsonschema.configuration.validator.ConfigurationValidator
-
Validates the environment configuration.
- validate(ConfigurationValidationContext) - Method in interface io.micronaut.jsonschema.configuration.validator.ConfigurationRule
-
Perform custom validation for a configuration prefix (or a single
@EachPropertyentry) and return any additionalConfigurationErrors. - validate(Object, Class) - Method in interface io.micronaut.jsonschema.validation.JsonSchemaValidator
-
Validate Object based on types JSON schema.
- validate(Object, String) - Method in interface io.micronaut.jsonschema.validation.JsonSchemaValidator
-
Validate Object against a JSON schema.
- validate(Object, Map) - Method in interface io.micronaut.jsonschema.validation.JsonSchemaValidator
-
Validate Object against a JSON schema.
- validate(String, Class) - Method in interface io.micronaut.jsonschema.validation.JsonSchemaValidator
-
Validate JSON based on a types JSON schema.
- validate(ClassLoader, Environment) - Method in class io.micronaut.jsonschema.configuration.validator.ConfigurationJsonSchemaValidator
-
Validate the given environment against schemas resolvable from the given classloader.
- validate(ClassLoader, Environment) - Method in interface io.micronaut.jsonschema.configuration.validator.ConfigurationValidator
-
Validates the environment configuration.
- validateAndReport(ConfigurationErrorReporter) - Method in class io.micronaut.jsonschema.configuration.validator.cli.JsonSchemaConfigurationValidator
-
Validate and report using the given reporter.
- ValidationInfoAggregator - Class in io.micronaut.jsonschema.visitor.aggregator
-
An aggregator for adding information from the validation annotations.
- ValidationInfoAggregator() - Constructor for class io.micronaut.jsonschema.visitor.aggregator.ValidationInfoAggregator
- ValidationMessage - Interface in io.micronaut.jsonschema.validation
-
JSON Schema Validation Message.
- ValidationMessageAdapter - Class in io.micronaut.jsonschema.validation
-
Adapter from
ValidationMessageintoValidationMessage. - ValidationMessageAdapter(ValidationMessage) - Constructor for class io.micronaut.jsonschema.validation.ValidationMessageAdapter
- value() - Method in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
- valueOf(String) - Static method in enum class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.RecordAdoptionStrategy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.jsonschema.model.Schema.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.micronaut.jsonschema.visitor.context.JsonSchemaContext.JsonSchemaDraft
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.jsonschema.configuration.validator.model.ConfigurationSchemaType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfig.RecordAdoptionStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.jsonschema.model.Schema.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.micronaut.jsonschema.visitor.context.JsonSchemaContext.JsonSchemaDraft
-
Returns an array containing the constants of this enum class, in the order they are declared.
- visitClass(ClassElement, VisitorContext) - Method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
W
- WARNING - Enum constant in enum class io.micronaut.jsonschema.configuration.validator.ConfigurationError.Type
-
A validation warning.
- withInputFolder(Path) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the input folder of json schema.
- withInputStream(InputStream) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the input stream config.
- withJavadoc(SourceGeneratorConfig.JavadocConfig) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Sets the Javadoc-specific configuration.
- withJsonFile(File) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the File of a json schema.
- withJsonUrl(String) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the URL of a json schema.
- withOutputFileName(String) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the desired file name for single generations.
- withOutputFolder(Path) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the Output path for the generated files.
- withOutputPackageName(String) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Adds the Package name for generated files.
- withRecordAdoptionStrategy(SourceGeneratorConfig.RecordAdoptionStrategy) - Method in class io.micronaut.jsonschema.generator.utils.SourceGeneratorConfigBuilder
-
Sets the strategy for generating records vs classes.
- withType(ConfigurationError.Type) - Method in record class io.micronaut.jsonschema.configuration.validator.ConfigurationError
- writeSchema(Schema, ClassElement, VisitorContext, JsonSchemaContext) - Static method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
All Classes and Interfaces|All Packages|Constant Field Values