Package com.github.victools.jsonschema.generator
-
Interface Summary Interface Description ConfigFunction<S extends TypeScope,R> Functional interface for realising one of various configurations.CustomDefinitionProvider Deprecated. useCustomDefinitionProviderV2
insteadCustomDefinitionProviderV2 Provider of non-standard JSON schema definitions.CustomPropertyDefinitionProvider<M extends MemberScope<?,?>> Provider of non-standard JSON schema definitions.InstanceAttributeOverride<M extends MemberScope<?,?>> Deprecated. useInstanceAttributeOverrideV2
insteadInstanceAttributeOverrideV2<M extends MemberScope<?,?>> Entry point for customising the JSON Schema attributes being collected for a property.Module Collection of configurations for the schema generation.SchemaConstants Deprecated. this only covers Draft 7; useSchemaKeyword
insteadSchemaGenerationContext Generation context for sub-schema definitions.SchemaGeneratorConfig Default implementation of a schema generator's configuration.StatefulConfig Type of configuration (or an aspect of it), that may change during a schema generation and7or remember some kind of state.SubtypeResolver Resolver for looking up a declared type's subtypes in order to list those specifically (in anSchemaKeyword.TAG_ANYOF
).TypeAttributeOverride Deprecated. useTypeAttributeOverrideV2
insteadTypeAttributeOverrideV2 Entry point for customising the JSON Schema attributes being collected for a type in general, i.e. -
Class Summary Class Description CustomDefinition The result of a custom definition look-up.CustomPropertyDefinition The result of a custom definition look-up for a particular field/method.FieldScope Representation of a single introspected field.MemberScope<M extends com.fasterxml.classmate.members.ResolvedMember<T>,T extends Member> Representation of a single introspected field or method.MemberScope.DeclarationDetails MethodScope Representation of a single introspected method.OptionPreset Selection ofOption
entries to be enabled by default, which can be overridden viaSchemaGeneratorConfigBuilder.with(Option, Option...)
/SchemaGeneratorConfigBuilder.without(Option, Option...)
.SchemaBuilder Builder for a single schema being generated.SchemaGenerator Generator for JSON Schema definitions via reflection based analysis of a given class.SchemaGeneratorConfigBuilder Builder class for creating a configuration object to be passed into the SchemaGenerator's constructor.SchemaGeneratorConfigPart<M extends MemberScope<?,?>> Generic collection of reflection based analysis for populating a JSON Schema from a certain kind of member.SchemaGeneratorGeneralConfigPart Generic collection of reflection based analysis for populating a JSON Schema targeting a specific type in general.SchemaGeneratorTypeConfigPart<S extends TypeScope> Generic collection of reflection based analysis for populating a JSON Schema.TypeContext Context in which types can be resolved (as well as their declared fields and methods).TypeScope Representation of a single type to represent as (sub) schema. -
Enum Summary Enum Description CustomDefinition.AttributeInclusion Indication whether the normal attribute collection should be performed and any attributes should be added to the custom definition.CustomDefinition.DefinitionType Indication whether a custom definition should always be inlined or follow the standard behaviour.Option Configuration options to be set on aSchemaGeneratorConfigBuilder
instance.SchemaKeyword JSON Schema properties and their values.SchemaKeyword.SchemaType Values of theSchemaKeyword.TAG_TYPE
.SchemaKeyword.TagContent Type of content/values to be expected under a schema tag.SchemaVersion Supported JSON Schema Versions.