Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- 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
- addOneOf(Schema) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- addRequired(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- addType(Schema.Type) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- array() - Static method in class io.micronaut.jsonschema.visitor.model.Schema
- ARRAY - Enum constant in enum class io.micronaut.jsonschema.visitor.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
baseUri
record component. - baseUrl() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
baseUrl
record 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
binaryAsArray
record component. - bool() - Static method in class io.micronaut.jsonschema.visitor.model.Schema
- BOOLEAN - Enum constant in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
A "true" or "false" value.
C
- camelCaseToKebabCase(String) - Static method in class io.micronaut.jsonschema.visitor.NameUtils
-
Convert from camel case to kebab case.
- classpathFolder() - Method in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
Returns the value of the
classpathFolder
record component. - createDefault(Map<String, String>) - 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
createdSchemasByType
record component. - createMapper() - Static method in class io.micronaut.jsonschema.visitor.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
currentOriginatingElements
record component.
D
- DEF_SCHEMA_REF_PREFIX - Static variable in class io.micronaut.jsonschema.visitor.model.Schema
- DEFAULT_BINARY_AS_ARRAY - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- DEFAULT_OUTPUT_LOCATION - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- 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
draft
record component. - DRAFT_2020_12 - Enum constant in enum class io.micronaut.jsonschema.visitor.context.JsonSchemaContext.JsonSchemaDraft
E
- 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.
F
- FALSE - Static variable in class io.micronaut.jsonschema.visitor.model.Schema
-
A false schema is a schema that would be invalid for any instance.
G
- get$id() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- get$ref() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- get$schema() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getAdditionalProperties() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getConstValue() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getContains() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getDefaultValue() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getDescription() - Method in class io.micronaut.jsonschema.visitor.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.visitor.model.Schema
- getExamples() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getExclusiveMaximum() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getExclusiveMinimum() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getFormat() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getItems() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMaxContains() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMaximum() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMaxItems() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMaxLength() - Method in class io.micronaut.jsonschema.visitor.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.visitor.model.Schema
- getMinimum() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMinItems() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMinLength() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getMultipleOf() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getNot() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getOneOf() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getParameters() - Static method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- getPattern() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getProperties() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getRequired() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getSourceElement() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getSupportedOptions() - Method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
- getTitle() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getType() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- getValidationMessage() - Method in class io.micronaut.jsonschema.validation.ValidationMessageAdapter
- getVisitorKind() - Method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
H
- 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.
I
- integer() - Static method in class io.micronaut.jsonschema.visitor.model.Schema
- INTEGER - Enum constant in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
An integer.
- io.micronaut.jsonschema - package io.micronaut.jsonschema
- 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
- io.micronaut.jsonschema.visitor.model - package io.micronaut.jsonschema.visitor.model
- io.micronaut.jsonschema.visitor.serialization - package io.micronaut.jsonschema.visitor.serialization
- isDeprecated() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- isReadOnly() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- isUniqueItems() - Method in class io.micronaut.jsonschema.visitor.model.Schema
- isWriteOnly() - Method in class io.micronaut.jsonschema.visitor.model.Schema
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
- 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
- JsonSchema - Annotation Interface in io.micronaut.jsonschema
-
An annotation that signifies that json schema should be created for the object.
- 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<String, Schema>, List<ClassElement>) - Constructor for record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Creates an instance of a
JsonSchemaContext
record class. - JsonSchemaContext.JsonSchemaDraft - Enum Class in io.micronaut.jsonschema.visitor.context
-
An enum for JSON Schema draft versions.
- JsonSchemaMapperFactory - Class in io.micronaut.jsonschema.visitor.serialization
-
A factory of mappers for swagger serialization and deserialization.
- JsonSchemaMapperFactory() - Constructor for class io.micronaut.jsonschema.visitor.serialization.JsonSchemaMapperFactory
- 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
JsonSchemaValidatorConfiguration
record 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
N
- NameUtils - Class in io.micronaut.jsonschema.visitor
-
A utility class for name conversions.
- NameUtils() - Constructor for class io.micronaut.jsonschema.visitor.NameUtils
- NULL - Enum constant in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
A JSON "null" value.
- number() - Static method in class io.micronaut.jsonschema.visitor.model.Schema
- NUMBER - Enum constant in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
An arbitrary-precision, base-10 decimal number value.
O
- object() - Static method in class io.micronaut.jsonschema.visitor.model.Schema
- OBJECT - Enum constant in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
An unordered set of properties mapping a string to an instance.
- OUTPUT_LOCATION_PARAMETER - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- outputLocation() - Method in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
-
Returns the value of the
outputLocation
record component.
P
- PARAMETER_PREFIX - Static variable in record class io.micronaut.jsonschema.visitor.context.JsonSchemaContext
- PREFIX - Static variable in record class io.micronaut.jsonschema.validation.JsonSchemaValidatorConfiguration
-
The JSON schema validation configuration prefix.
- putProperty(String, Schema) - Method in class io.micronaut.jsonschema.visitor.model.Schema
R
- reference(String) - Static method in class io.micronaut.jsonschema.visitor.model.Schema
S
- Schema - Class in io.micronaut.jsonschema.visitor.model
-
A JSON schema.
- Schema() - Constructor for class io.micronaut.jsonschema.visitor.model.Schema
- Schema.Type - Enum Class in io.micronaut.jsonschema.visitor.model
-
The type of schema exactly matching a primitive JSON type.
- SchemaInfoAggregator - Interface in io.micronaut.jsonschema.visitor.aggregator
-
An interface for objects responsible for aggregating JSON schema info.
- set$id(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- set$ref(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- set$schema(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setAdditionalProperties(Schema) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setBeanSchemaProperties(ClassElement, VisitorContext, JsonSchemaContext, Schema) - Static method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
- setConstValue(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setContains(List<Object>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setDefaultValue(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setDeprecated(boolean) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setDescription(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setEnumValues(List<Object>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setExamples(List<Object>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setExclusiveMaximum(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setExclusiveMinimum(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setFormat(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setItems(Schema) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMaxContains(Integer) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMaximum(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMaxItems(Integer) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMaxLength(Integer) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMinContains(Integer) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMinimum(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMinItems(Integer) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMinLength(Integer) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setMultipleOf(Object) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setNot(Schema) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setOneOf(List<Schema>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setPattern(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setProperties(Map<String, Schema>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setReadOnly(boolean) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setRequired(List<String>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setSourceElement(TypedElement) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setTitle(String) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setType(List<Schema.Type>) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setUniqueItems(boolean) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- setWriteOnly(boolean) - Method in class io.micronaut.jsonschema.visitor.model.Schema
- 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
strictMode
record component. - string() - Static method in class io.micronaut.jsonschema.visitor.model.Schema
- STRING - Enum constant in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
A string of Unicode code points.
T
- THIS_SCHEMA_REF - Static variable in class io.micronaut.jsonschema.visitor.model.Schema
- title() - Element in annotation interface io.micronaut.jsonschema.JsonSchema
-
The title of the JSON schema.
- 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.visitor.model.Schema
-
A true schema is a schema that would be valid for any instance.
U
- 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.
V
- validate(Object, Class<T>) - Method in interface io.micronaut.jsonschema.validation.JsonSchemaValidator
-
Validate Object based on types JSON schema.
- validate(String, Class<T>) - Method in interface io.micronaut.jsonschema.validation.JsonSchemaValidator
-
Validate JSON based on a types JSON schema.
- 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
ValidationMessage
intoValidationMessage
. - ValidationMessageAdapter(ValidationMessage) - Constructor for class io.micronaut.jsonschema.validation.ValidationMessageAdapter
- 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.
- valueOf(String) - Static method in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
Returns the enum constant of this class with the specified name.
- 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.
- values() - Static method in enum class io.micronaut.jsonschema.visitor.model.Schema.Type
-
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
- writeSchema(Schema, ClassElement, VisitorContext, JsonSchemaContext) - Static method in class io.micronaut.jsonschema.visitor.JsonSchemaVisitor
All Classes and Interfaces|All Packages|Constant Field Values