A B C D E F G H I J M N O P R S T V W
All Classes All Packages

A

ADDITIONAL_FIXED_TYPES - com.github.victools.jsonschema.generator.Option

Whether additional types (and not just primitives and their associated classes should be included as fixed schema with a "type" attribute of "string"/"boolean"/"integer"/"number".

apply(M) - Method in interface com.github.victools.jsonschema.generator.ConfigFunction

Applies this function to the given arguments.

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.ConstantValueModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.EnumModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.FlattenedOptionalModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.SimplifiedOptionalModule

applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in interface com.github.victools.jsonschema.generator.Module

Apply this module to the given configuration builder instance.

asObjects() - Static method in class com.github.victools.jsonschema.generator.impl.module.EnumModule

Factory method: creating an EnumModule instance that treats all enums as objects but hides all methods declared by the general enum interface but name().

asStrings() - Static method in class com.github.victools.jsonschema.generator.impl.module.EnumModule

Factory method: creating an EnumModule instance that treats all enums as plain strings.

AttributeCollector - Class in com.github.victools.jsonschema.generator.impl

Helper class for looking-up various attribute values for a field or method via a given configuration instance.

AttributeCollector(ObjectMapper) - Constructor for class com.github.victools.jsonschema.generator.impl.AttributeCollector

Constructor accepting the object mapper to use.

B

build() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Create a schema generator instance from the builder.

C

collectFieldAttributes(FieldScope, SchemaGeneratorConfig) - Static method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Collect a field's contextual attributes (i.e.

collectMethodAttributes(MethodScope, SchemaGeneratorConfig) - Static method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Collect a method's contextual attributes (i.e.

com.github.victools.jsonschema.generator - package com.github.victools.jsonschema.generator

com.github.victools.jsonschema.generator.impl - package com.github.victools.jsonschema.generator.impl

com.github.victools.jsonschema.generator.impl.module - package com.github.victools.jsonschema.generator.impl.module

ConfigFunction<M extends MemberScope<?,?>,R> - Interface in com.github.victools.jsonschema.generator

Functional interface for realising one of various configurations.

ConstantValueModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module being included if Option.VALUES_FROM_CONSTANT_FIELDS is enabled.

ConstantValueModule() - Constructor for class com.github.victools.jsonschema.generator.impl.module.ConstantValueModule

containsDefinition(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Whether this context (already) contains a definition for the specified type.

createArrayNode() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

createArrayNode() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Generate an empty JSON node representing an array (which will subsequently be filled by the generator).

createDefaultTypeContext() - Static method in class com.github.victools.jsonschema.generator.impl.TypeContextFactory

Create the default TypeContext with AnnotationInclusion.INCLUDE_AND_INHERIT_IF_INHERITED.

createDefinition(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

createDefinition(ResolvedType) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext

Create an inline definition for the given targetType.

createFieldScope(ResolvedField, ResolvedTypeWithMembers) - Method in class com.github.victools.jsonschema.generator.TypeContext

Construct a FieldScope instance for the given field.

createMethodScope(ResolvedMethod, ResolvedTypeWithMembers) - Method in class com.github.victools.jsonschema.generator.TypeContext

Construct a MethodScope instance for the given method.

createObjectNode() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

createObjectNode() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Generate an empty JSON node representing an object (which will subsequently be filled by the generator).

createStandardDefinition(ResolvedType, CustomDefinitionProviderV2) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

createStandardDefinition(ResolvedType, CustomDefinitionProviderV2) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext

Create an inline definition for the given targetType.

createTypeContext(AnnotationConfiguration) - Static method in class com.github.victools.jsonschema.generator.impl.TypeContextFactory

Create the a TypeContext with the given AnnotationConfiguration.

createTypeContext(AnnotationInclusion) - Static method in class com.github.victools.jsonschema.generator.impl.TypeContextFactory

Create the a TypeContext with the given AnnotationInclusion.

CustomDefinition - Class in com.github.victools.jsonschema.generator

The result of a custom definition look-up.

CustomDefinition(ObjectNode) - Constructor for class com.github.victools.jsonschema.generator.CustomDefinition

Constructor for a custom definition that should follow the standard behaviour in regards to be inlined or mentioned in the "definitions".

CustomDefinition(ObjectNode, boolean) - Constructor for class com.github.victools.jsonschema.generator.CustomDefinition

Constructor for a custom definition.

CustomDefinitionProvider - Interface in com.github.victools.jsonschema.generator

Deprecated.

use CustomDefinitionProviderV2 instead

CustomDefinitionProviderV2 - Interface in com.github.victools.jsonschema.generator

Provider of non-standard JSON schema definitions.

D

DEFAULT_INCLUDED_METHOD_NAMES - Static variable in class com.github.victools.jsonschema.generator.impl.module.SimplifiedOptionalModule

The method names to preserve for an Optional instance's schema representation: "get", "orElse", "isPresent".

DEFINITIONS_FOR_ALL_OBJECTS - com.github.victools.jsonschema.generator.Option

Whether all referenced objects should be listed in the schema's "definitions", otherwise single occurrences are defined in-line.

E

EnumModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module being included for the Option.ENUM_AS_STRING.

EnumModule(boolean) - Constructor for class com.github.victools.jsonschema.generator.impl.module.EnumModule

Constructor remembering whether to treat enums as plain strings or as objects.

F

FieldExclusionModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module for excluding fields.

FieldExclusionModule(Predicate<FieldScope>) - Constructor for class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule

Constructor setting the underlying check to be set via SchemaGeneratorConfigPart.withIgnoreCheck(Predicate).

FieldScope - Class in com.github.victools.jsonschema.generator

Representation of a single introspected field.

FieldScope(ResolvedField, ResolvedType, String, ResolvedTypeWithMembers, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.FieldScope

Constructor.

FieldScope(ResolvedField, ResolvedTypeWithMembers, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.FieldScope

Constructor.

findGetter() - Method in class com.github.victools.jsonschema.generator.FieldScope

Return the conventional getter method (if one exists).

findGetterField() - Method in class com.github.victools.jsonschema.generator.MethodScope

Look-up the field associated with this method if it is deemed to be a getter by convention.

FLATTENED_ENUMS - com.github.victools.jsonschema.generator.Option

Whether enums should be treated as plain ""string"" values.

FLATTENED_OPTIONALS - com.github.victools.jsonschema.generator.Option

Whether any Optional instance should be treated as nullable value of the wrapped type.

FlattenedOptionalModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module being included if Option.FLATTENED_OPTIONALS is enabled.

FlattenedOptionalModule() - Constructor for class com.github.victools.jsonschema.generator.impl.module.FlattenedOptionalModule

forFields() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Get the part of this configuration builder dedicated to custom attribute look-ups for fields.

forGetterMethods() - Static method in class com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule

Factory method: creating a MethodExclusionModule instance that excludes all getter methods.

forMethods() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Get the part of this configuration builder dedicated to custom attribute look-ups for methods.

forNonPublicNonStaticFieldsWithGetter() - Static method in class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule

Factory method: creating a FieldExclusionModule instance that excludes all non-public non-static fields that also have an associated getter method.

forNonPublicNonStaticFieldsWithoutGetter() - Static method in class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule

Factory method: creating a FieldExclusionModule instance that excludes all non-public non-static fields that do not have an associate getter method.

forNonStaticNonVoidNonGetterMethods() - Static method in class com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule

Factory method: creating a MethodExclusionModule instance that excludes all methods that don't fall in any of the other categories.

forPrimitiveAndAdditionalTypes() - Static method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Factory method: creating an instance of the SimpleTypeModule containing mappings for various primitive types and their non-primitive counter parts (e.g.

forPrimitiveTypes() - Static method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Factory method: creating an instance of the SimpleTypeModule containing mappings for various primitive types and their non-primitive counter parts (e.g.

forPublicNonStaticFields() - Static method in class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule

Factory method: creating a FieldExclusionModule instance that excludes all public non-static fields.

forTransientFields() - Static method in class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule

Factory method: creating a FieldExclusionModule instance that excludes all public static fields.

forVoidMethods() - Static method in class com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule

Factory method: creating a MethodExclusionModule instance that excludes all methods with a void return type.

FULL_DOCUMENTATION - Static variable in class com.github.victools.jsonschema.generator.OptionPreset

Preset: including private/package/protected/public fields and all public methods.

G

generateSchema(Type, Type...) - Method in class com.github.victools.jsonschema.generator.SchemaGenerator

Generate a JsonNode containing the JSON Schema representation of the given type.

getAnnotation(Class<A>) - Method in class com.github.victools.jsonschema.generator.MemberScope

Return the annotation of the given type on the member, if such an annotation is present.

getAnnotationConsideringFieldAndGetter(Class<A>) - Method in class com.github.victools.jsonschema.generator.FieldScope

getAnnotationConsideringFieldAndGetter(Class<A>) - Method in class com.github.victools.jsonschema.generator.MemberScope

Return the annotation of the given type on the member, if such an annotation is present on either the field or its getter.

getAnnotationConsideringFieldAndGetter(Class<A>) - Method in class com.github.victools.jsonschema.generator.MethodScope

getArgumentCount() - Method in class com.github.victools.jsonschema.generator.MethodScope

Returns the number of arguments this method has.

getArgumentTypes() - Method in class com.github.victools.jsonschema.generator.MethodScope

Returns the list of types of this method's arguments.

getContainerItemType() - Method in class com.github.victools.jsonschema.generator.MemberScope

Identify the element/item type of the given ""array"".

getContainerItemType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Identify the element/item type of the given ""array"".

getContext() - Method in class com.github.victools.jsonschema.generator.MemberScope

Getter for the overall type resolution context.

getCustomDefinition(ResolvedType, SchemaGenerationContext, CustomDefinitionProviderV2) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

getCustomDefinition(ResolvedType, SchemaGenerationContext, CustomDefinitionProviderV2) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Look-up the non-standard JSON schema definition for a given type.

getDeclaredName() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the member's name as specified in the declaring class.

getDeclaredType() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the type declared as the field's or method return value's type.

getDeclaringType() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the member's declaring type.

getDeclaringTypeMembers() - Method in class com.github.victools.jsonschema.generator.MemberScope

Getter for the collection of the member's declaring type's (other) fields and methods.

getDefinedTypes() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Retrieve the set of all types for which a definition has been remembered in this context.

getDefinition(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Retrieve the previously added definition for the specified type.

getFieldAttributeOverrides() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

getFieldAttributeOverrides() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Getter for the applicable instance attribute overrides for fields.

getFullTypeDescription() - Method in class com.github.victools.jsonschema.generator.MemberScope

Constructing a string that fully represents this member's type (including possible type parameters and their actual types).

getFullTypeDescription(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Constructing a string that fully represents the given type (including possible type parameters and their actual types).

getInstanceAttributeOverrides() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Getter for the applicable instance attribute overrides.

getMember() - Method in class com.github.victools.jsonschema.generator.MemberScope

Getter for the represented field or method.

getMethodAttributeOverrides() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

getMethodAttributeOverrides() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Getter for the applicable instance attribute overrides for methods.

getMethodPropertyArgumentTypeDescription(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Returns the type description for an argument in a method's property name.

getName() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns name of this member.

getNullableReferences(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Getter for the nodes representing nullable references to the given type.

getObjectMapper() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

getObjectMapper() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Getter for the underlying object mapper.

getObjectMapper() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Retrieve the associated object mapper instance.

getOverriddenName() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the member's overridden name.

getOverriddenType() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the overridden type of the field or method's return value.

getRawMember() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the JDK object that represents member.

getReferences(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Getter for the nodes representing not-nullable references to the given type.

getSchemaDefinitionName(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Returns the name to be associated with an entry in the generated schema's list of "definitions".

getSchemaPropertyName() - Method in class com.github.victools.jsonschema.generator.FieldScope

Returns the name to be used to reference this field in its parent's "properties".

getSchemaPropertyName() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns the name to be used to reference this member in its parent's "properties".

getSchemaPropertyName() - Method in class com.github.victools.jsonschema.generator.MethodScope

Returns the name to be used to reference this method in its parent's "properties".

getSetting(Option) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Check whether the given setting/option has been set and if yes, whether it is enabled or disabled.

getSimpleTypeDescription() - Method in class com.github.victools.jsonschema.generator.MemberScope

Constructing a string that represents this member's type (including possible type parameters and their actual types).

getSimpleTypeDescription(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Constructing a string that represents the given type (including possible type parameters and their actual types).

GETTER_METHODS - com.github.victools.jsonschema.generator.Option

Whether getter methods should be included (assuming their fields are not included).

getType() - Method in class com.github.victools.jsonschema.generator.MemberScope

Returns type of this member; if it has one, for methods this is the return type and for fields their field type.

getTypeAttributeOverrides() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

getTypeAttributeOverrides() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Getter for the applicable type attribute overrides.

getTypeContext() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

getTypeContext() - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext

Getter for the type resolution/introspection context in use.

getValue() - Method in class com.github.victools.jsonschema.generator.CustomDefinition

Getter for the actual custom definition.

H

hasGetter() - Method in class com.github.victools.jsonschema.generator.FieldScope

Determine whether the field's declaring class contains a matching method starting with "get" or "is".

I

InstanceAttributeOverride<M extends MemberScope<?,?>> - Interface in com.github.victools.jsonschema.generator

Entry point for customising a JSON Schema being generated for a certain kind of reference/context.

isContainerType() - Method in class com.github.victools.jsonschema.generator.MemberScope

Determine whether this member's type should be treated as ""array"" in the generated schema.

isContainerType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Determine whether a given type should be treated as ""array"" in the generated schema.

isFinal() - Method in class com.github.victools.jsonschema.generator.MemberScope

Indicates whether the member has the final keyword.

isGetter() - Method in class com.github.victools.jsonschema.generator.MethodScope

Determine whether the method's name matches the getter naming convention ("getFoo()"/"isFoo()") and a respective field ("foo") exists.

isMeantToBeInline() - Method in class com.github.victools.jsonschema.generator.CustomDefinition

Getter for the flag indicating whether this custom definition should be inlined even if it occurs multiple times.

isNullable(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

isNullable(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Check whether a field/property is nullable.

isNullable(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

isNullable(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Check whether a method's return value is nullable.

isNullable(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine whether a given member is nullable.

isOptionEnabledByDefault(Option) - Method in class com.github.victools.jsonschema.generator.OptionPreset

Indicate whether the given option should be enabled, if it was not specifically included/excluded in the SchemaGeneratorConfigBuilder.

isPrivate() - Method in class com.github.victools.jsonschema.generator.MemberScope

Indicates whether the member is of private visibility.

isProtected() - Method in class com.github.victools.jsonschema.generator.MemberScope

Indicates whether the member is of protected visibility.

isPublic() - Method in class com.github.victools.jsonschema.generator.MemberScope

Indicates whether the member is of public visibility.

isRequired(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

isRequired(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Check whether a field/property value is required.

isRequired(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

isRequired(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Check whether a method value is required.

isRequired(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine whether a given member should be indicated as being required in its declaring type.

isStatic() - Method in class com.github.victools.jsonschema.generator.MemberScope

Indicates whether the member has the static keyword.

isTransient() - Method in class com.github.victools.jsonschema.generator.FieldScope

Indicates whether the field has the transient keyword.

isVoid() - Method in class com.github.victools.jsonschema.generator.MethodScope

Indicating whether the method is declared as void, i.e.

J

JAVA_OBJECT - Static variable in class com.github.victools.jsonschema.generator.OptionPreset

Preset: including public fields and all public methods.

M

makeNullable(ObjectNode) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

makeNullable(ObjectNode) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext

Ensure that the JSON schema represented by the given node allows for it to be of "type" "null".

MemberScope<M extends com.fasterxml.classmate.members.ResolvedMember<T>,T extends Member> - Class in com.github.victools.jsonschema.generator

Representation of a single introspected field or method.

MemberScope(M, ResolvedType, String, ResolvedTypeWithMembers, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.MemberScope

Constructor.

MethodExclusionModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module for excluding methods.

MethodExclusionModule(Predicate<MethodScope>) - Constructor for class com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule

Constructor setting the underlying check to be set via SchemaGeneratorConfigPart.withIgnoreCheck(Predicate).

MethodScope - Class in com.github.victools.jsonschema.generator

Representation of a single introspected method.

MethodScope(ResolvedMethod, ResolvedType, String, ResolvedTypeWithMembers, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.MethodScope

Constructor.

MethodScope(ResolvedMethod, ResolvedTypeWithMembers, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.MethodScope

Constructor.

Module - Interface in com.github.victools.jsonschema.generator

Collection of configurations for the schema generation.

N

NONPUBLIC_NONSTATIC_FIELDS_WITH_GETTERS - com.github.victools.jsonschema.generator.Option

Whether fields with private/package/protected visibility, for which a respective getter method can be found, should be included.

NONPUBLIC_NONSTATIC_FIELDS_WITHOUT_GETTERS - com.github.victools.jsonschema.generator.Option

Whether fields with private/package/protected visibility and no accompanying getter method should be included.

NONPUBLIC_STATIC_FIELDS - com.github.victools.jsonschema.generator.Option

Whether static fields with private/package/protected visibility should be included.

NONSTATIC_NONVOID_NONGETTER_METHODS - com.github.victools.jsonschema.generator.Option

Whether methods that are (1) not static, (2) have a specific return value and (3) are not getters, should be included.

NULLABLE_FIELDS_BY_DEFAULT - com.github.victools.jsonschema.generator.Option

Whether an object's field/property should be deemed to be nullable if no specific check says otherwise.

NULLABLE_METHOD_RETURN_VALUES_BY_DEFAULT - com.github.victools.jsonschema.generator.Option

Whether a method's return value should be deemed to be nullable if no specific check says otherwise.

O

Option - Enum in com.github.victools.jsonschema.generator

Configuration options to be set on a SchemaGeneratorConfigBuilder instance.

OptionPreset - Class in com.github.victools.jsonschema.generator

Selection of Option entries to be enabled by default, which can be overridden via SchemaGeneratorConfigBuilder.with(Option, Option...)/SchemaGeneratorConfigBuilder.without(Option, Option...).

OptionPreset(Option...) - Constructor for class com.github.victools.jsonschema.generator.OptionPreset

Constructor: defining the fixed list of options to be enabled by default.

overrideInstanceAttributes(ObjectNode, M) - Method in interface com.github.victools.jsonschema.generator.InstanceAttributeOverride

Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.

overrideTypeAttributes(ObjectNode, ResolvedType, SchemaGeneratorConfig) - Method in interface com.github.victools.jsonschema.generator.TypeAttributeOverride

Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to the type in general.

P

parseType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Parse the given (possibly generic) type and populate this context.

PLAIN_JSON - Static variable in class com.github.victools.jsonschema.generator.OptionPreset

Preset: including private/package/protected/public fields and no methods.

provideCustomSchemaDefinition(ResolvedType, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.CustomDefinitionProvider

Deprecated.

provideCustomSchemaDefinition(ResolvedType, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.CustomDefinitionProviderV2

Look-up the non-standard JSON schema definition for a given type.

provideCustomSchemaDefinition(ResolvedType, TypeContext) - Method in interface com.github.victools.jsonschema.generator.CustomDefinitionProvider

Deprecated.

Look-up the non-standard JSON schema definition for a given type.

PUBLIC_NONSTATIC_FIELDS - com.github.victools.jsonschema.generator.Option

Whether static fields with public visibility should be included.

PUBLIC_STATIC_FIELDS - com.github.victools.jsonschema.generator.Option

Whether static fields with public visibility should be included.

R

resolve(Type, Type...) - Method in class com.github.victools.jsonschema.generator.TypeContext

Resolve actual type (mostly relevant for parameterised types, type variables and such.

resolveArrayMaxItems(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveArrayMaxItems(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "maxItems" of an object's field/property.

resolveArrayMaxItems(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveArrayMaxItems(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "maxItems" of a method's return value.

resolveArrayMaxItems(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "maxItems" of a given member.

resolveArrayMinItems(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveArrayMinItems(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "minItems" of an object's field/property.

resolveArrayMinItems(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveArrayMinItems(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "minItems" of a method's return value.

resolveArrayMinItems(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "minItems" of a given member.

resolveArrayUniqueItems(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveArrayUniqueItems(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "uniqueItems" of an object's field/property.

resolveArrayUniqueItems(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveArrayUniqueItems(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "uniqueItems" of a method's return value.

resolveArrayUniqueItems(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "uniqueItems" of a given member.

resolveDefault(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveDefault(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "default" value of an object's field/property.

resolveDefault(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveDefault(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "default" value of a method's return value.

resolveDefault(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "default" of a given member.

resolveDescription(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveDescription(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "description" of an object's field/property.

resolveDescription(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveDescription(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "description" of a method's return value.

resolveDescription(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "description" of a given member.

resolveEnum(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveEnum(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "enum"/"const" of an object's field/property.

resolveEnum(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveEnum(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "enum"/"const" of a method's return value.

resolveEnum(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "enum"/"const" of a given member.

resolveNumberExclusiveMaximum(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberExclusiveMaximum(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "exclusiveMaximum" of an object's field/property.

resolveNumberExclusiveMaximum(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberExclusiveMaximum(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "exclusiveMaximum" of a method's return value.

resolveNumberExclusiveMaximum(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "exclusiveMaximum" of a given member.

resolveNumberExclusiveMinimum(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberExclusiveMinimum(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "exclusiveMinimum" of an object's field/property.

resolveNumberExclusiveMinimum(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberExclusiveMinimum(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "exclusiveMinimum" of a method's return value.

resolveNumberExclusiveMinimum(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "exclusiveMinimum" of a given member.

resolveNumberInclusiveMaximum(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberInclusiveMaximum(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "maximum" of an object's field/property.

resolveNumberInclusiveMaximum(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberInclusiveMaximum(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "maximum" of a method's return value.

resolveNumberInclusiveMaximum(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "maximum" of a given member.

resolveNumberInclusiveMinimum(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberInclusiveMinimum(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "minimum" of an object's field/property.

resolveNumberInclusiveMinimum(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberInclusiveMinimum(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "minimum" of a method's return value.

resolveNumberInclusiveMinimum(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "minimum" of a given member.

resolveNumberMultipleOf(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberMultipleOf(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "multipleOf" of an object's field/property.

resolveNumberMultipleOf(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveNumberMultipleOf(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "multipleOf" of a method's return value.

resolveNumberMultipleOf(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "multipleOf" of a given member.

resolvePropertyNameOverride(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolvePropertyNameOverride(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the alternative name in a parent JSON Schema's "properties" from an object's field/property.

resolvePropertyNameOverride(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolvePropertyNameOverride(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the alternative name in a parent JSON Schema's "properties" from a method's return value.

resolvePropertyNameOverride(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the alternative name in a parent JSON Schema's "properties" from a given member.

resolveStringFormat(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringFormat(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "format" of an object's field/property.

resolveStringFormat(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringFormat(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "format" of a method's return value.

resolveStringFormat(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "format" of a given member.

resolveStringMaxLength(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringMaxLength(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "maxLength" of an object's field/property.

resolveStringMaxLength(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringMaxLength(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "maxLength" of a method's return value.

resolveStringMaxLength(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "maxLength" of a given member.

resolveStringMinLength(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringMinLength(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "minLength" of an object's field/property.

resolveStringMinLength(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringMinLength(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "minLength" of a method's return value.

resolveStringMinLength(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "minLength" of a given member.

resolveStringPattern(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringPattern(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "pattern" of an object's field/property.

resolveStringPattern(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveStringPattern(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "pattern" of a method's return value.

resolveStringPattern(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "format" of a given member.

resolveTargetTypeOverride(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveTargetTypeOverride(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the alternative target type from an object's field/property.

resolveTargetTypeOverride(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveTargetTypeOverride(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the alternative target type from a method's return value.

resolveTargetTypeOverride(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the alternative target type from a given member.

resolveTitle(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveTitle(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "title" of an object's field/property.

resolveTitle(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

resolveTitle(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine the "title" of a method's return value.

resolveTitle(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine the "title" of a given member.

resolveWithMembers(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext

Collect a given type's declared fields and methods.

S

SCHEMA_VERSION_INDICATOR - com.github.victools.jsonschema.generator.Option

Whether the ""$schema"" attribute with value ""http://json-schema.org/draft-07/schema#"" should be included.

SchemaConstants - Interface in com.github.victools.jsonschema.generator

JSON Schema properties and their values.

SchemaGenerationContext - Interface in com.github.victools.jsonschema.generator

Generation context for sub-schema definitions.

SchemaGenerationContextImpl - Class in com.github.victools.jsonschema.generator.impl

Generation context in which to collect definitions of traversed types and remember where they are being referenced.

SchemaGenerationContextImpl(SchemaGeneratorConfig, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl

Constructor initialising type resolution context.

SchemaGenerator - Class in com.github.victools.jsonschema.generator

Generator for JSON Schema definitions via reflection based analysis of a given class.

SchemaGenerator(SchemaGeneratorConfig) - Constructor for class com.github.victools.jsonschema.generator.SchemaGenerator

Constructor.

SchemaGenerator(SchemaGeneratorConfig, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.SchemaGenerator

Constructor.

SchemaGeneratorConfig - Interface in com.github.victools.jsonschema.generator

Default implementation of a schema generator's configuration.

SchemaGeneratorConfigBuilder - Class in com.github.victools.jsonschema.generator

Builder class for creating a configuration object to be passed into the SchemaGenerator's constructor.

SchemaGeneratorConfigBuilder(ObjectMapper) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Constructor of an empty configuration builder.

SchemaGeneratorConfigBuilder(ObjectMapper, OptionPreset) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Constructor of an empty configuration builder.

SchemaGeneratorConfigImpl - Class in com.github.victools.jsonschema.generator.impl

Default implementation of a schema generator's configuration.

SchemaGeneratorConfigImpl(ObjectMapper, Map<Option, Boolean>, SchemaGeneratorConfigPart<FieldScope>, SchemaGeneratorConfigPart<MethodScope>, List<CustomDefinitionProviderV2>, List<TypeAttributeOverride>) - Constructor for class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

Constructor of a configuration instance.

SchemaGeneratorConfigPart<M extends MemberScope<?,?>> - Class in com.github.victools.jsonschema.generator

Generic collection of reflection based analysis for populating a JSON Schema from a certain kind of member.

SchemaGeneratorConfigPart() - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

setArrayMaxItems(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""maxItems"" attribute.

setArrayMinItems(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""minItems"" attribute.

setArrayUniqueItems(ObjectNode, Boolean) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""uniqueItems"" attribute.

setDefault(ObjectNode, Object) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""default"" attribute.

setDescription(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""description"" attribute.

setEnum(ObjectNode, Collection<?>) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""const""/""enum"" attribute.

setNumberExclusiveMaximum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""exclusiveMaximum"" attribute.

setNumberExclusiveMinimum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""exclusiveMinimum"" attribute.

setNumberInclusiveMaximum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""maximum"" attribute.

setNumberInclusiveMinimum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""minimum"" attribute.

setNumberMultipleOf(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""multipleOf"" attribute.

setStringFormat(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""format"" attribute.

setStringMaxLength(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""maxLength"" attribute.

setStringMinLength(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""minLength"" attribute.

setStringPattern(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""pattern"" attribute.

setTitle(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector

Setter for ""title"" attribute.

shouldCreateDefinitionsForAllObjects() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

shouldCreateDefinitionsForAllObjects() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine whether all referenced objects should be listed in the schema's "definitions", even if they only occur once.

shouldIgnore(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

shouldIgnore(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Check whether a field/property should be ignored.

shouldIgnore(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

shouldIgnore(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Check whether a method should be ignored.

shouldIgnore(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Determine whether a given member should be included – ignoring member if any inclusion check returns false.

shouldIncludeSchemaVersionIndicator() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

shouldIncludeSchemaVersionIndicator() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine whether the ""$schema"" attribute with value ""http://json-schema.org/draft-07/schema#"" should be added.

shouldIncludeStaticFields() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

shouldIncludeStaticFields() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine whether static fields should be included in the generated schema.

shouldIncludeStaticMethods() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl

shouldIncludeStaticMethods() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig

Determine whether static methods should be included in the generated schema.

SimpleTypeModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module being included for the Option.ADDITIONAL_FIXED_TYPES.

SimpleTypeModule() - Constructor for class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

SIMPLIFIED_ENUMS - com.github.victools.jsonschema.generator.Option

Whether enums should be treated as ""object"", with all methods but name() being excluded.

SIMPLIFIED_OPTIONALS - com.github.victools.jsonschema.generator.Option

Whether any Optional instance should be reduced to an object with only three methods.

SimplifiedOptionalModule - Class in com.github.victools.jsonschema.generator.impl.module

Default module being included if Option.SIMPLIFIED_OPTIONALS is enabled.

SimplifiedOptionalModule(String...) - Constructor for class com.github.victools.jsonschema.generator.impl.module.SimplifiedOptionalModule

Constructor: setting the names of methods declared by the Optional class to include in its generated object schema.

STATIC_METHODS - com.github.victools.jsonschema.generator.Option

Whether methods that are static should be included.

T

TAG_ALLOF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ANYOF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_CONST - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_DEFAULT - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_DEFINITIONS - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_DESCRIPTION - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ENUM - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_FORMAT - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ITEMS - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ITEMS_MAX - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ITEMS_MIN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ITEMS_UNIQUE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_LENGTH_MAX - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_LENGTH_MIN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_MAXIMUM - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_MAXIMUM_EXCLUSIVE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_MINIMUM - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_MINIMUM_EXCLUSIVE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_MULTIPLE_OF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_ONEOF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_PATTERN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_PROPERTIES - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_REF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_REF_MAIN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_REF_PREFIX - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_REQUIRED - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_SCHEMA - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_SCHEMA_DRAFT7 - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TITLE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_ARRAY - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_BOOLEAN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_INTEGER - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_NULL - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_NUMBER - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_OBJECT - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

TAG_TYPE_STRING - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants

toString() - Method in class com.github.victools.jsonschema.generator.MemberScope

TRANSIENT_FIELDS - com.github.victools.jsonschema.generator.Option

Whether transient fields should be included.

TypeAttributeOverride - Interface in com.github.victools.jsonschema.generator

Entry point for customising a JSON Schema being generated for a particular JavaType, i.e.

TypeContext - Class in com.github.victools.jsonschema.generator

Context in which types can be resolved (as well as their declared fields and methods).

TypeContext(AnnotationConfiguration) - Constructor for class com.github.victools.jsonschema.generator.TypeContext

Constructor.

TypeContextFactory - Class in com.github.victools.jsonschema.generator.impl

Factory class for creating TypeContext instances.

TypeContextFactory() - Constructor for class com.github.victools.jsonschema.generator.impl.TypeContextFactory

V

valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.Option

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.github.victools.jsonschema.generator.Option

Returns an array containing the constants of this enum type, in the order they are declared.

VALUES_FROM_CONSTANT_FIELDS - com.github.victools.jsonschema.generator.Option

Whether the constant values of static final fields should be included.

VOID_METHODS - com.github.victools.jsonschema.generator.Option

Whether methods without return value (e.g.

W

with(CustomDefinitionProviderV2) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Adding a custom schema provider – if it returns null for a given type, the next definition provider will be applied.

with(Module) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Applying a module to this configuration builder instance.

with(Option, Option...) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Enable an option for the schema generation.

with(TypeAttributeOverride) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Adding an override for type attributes – all of the registered overrides will be applied in the order of having been added.

withArrayMaxItemsResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "maxItems" resolver.

withArrayMinItemsResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "minItems" resolver.

withArrayUniqueItemsResolver(ConfigFunction<M, Boolean>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "uniqueItems" resolver.

withBooleanType(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Add the given mapping for a (simple) java class to its JSON schema equivalent "type" attribute: ""boolean"".

withDefaultResolver(ConfigFunction<M, Object>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "default" resolver.

withDescriptionResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "description" resolver.

withEnumResolver(ConfigFunction<M, Collection<?>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "enum"/"const" resolver.

withIgnoreCheck(Predicate<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for ignore check.

withInstanceAttributeOverride(InstanceAttributeOverride<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for override of attributes on a given JSON Schema node in the respective member.

withIntegerType(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Add the given mapping for a (simple) java class to its JSON schema equivalent "type" attribute: ""integer"".

withNullableCheck(ConfigFunction<M, Boolean>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for nullable check.

withNumberExclusiveMaximumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "exclusiveMaximum" resolver.

withNumberExclusiveMinimumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "exclusiveMinimum" resolver.

withNumberInclusiveMaximumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "maximum" resolver.

withNumberInclusiveMinimumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "minimum" resolver.

withNumberMultipleOfResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "multipleOf" resolver.

withNumberType(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Add the given mapping for a (simple) java class to its JSON schema equivalent "type" attribute: ""number"".

withObjectType(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Add the given mapping for a (simple) java class to its JSON schema equivalent "type" attribute: ""object"".

without(Option, Option...) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder

Disable an option for the schema generation.

withOverriddenName(String) - Method in class com.github.victools.jsonschema.generator.FieldScope

withOverriddenName(String) - Method in class com.github.victools.jsonschema.generator.MemberScope

Create another instance for this field or method and context, but overriding the declared field/method name with the given one.

withOverriddenName(String) - Method in class com.github.victools.jsonschema.generator.MethodScope

withOverriddenType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.FieldScope

withOverriddenType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.MemberScope

Create another instance for this field or method and context, but overriding the declared field/method return type with the given one.

withOverriddenType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.MethodScope

withPropertyNameOverrideResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for property name resolver, expecting the respective member and the default name as inputs.

withRequiredCheck(Predicate<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for required check.

withStringFormatResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "format" resolver.

withStringMaxLengthResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "maxLength" resolver.

withStringMinLengthResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "minLength" resolver.

withStringPatternResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "format" resolver.

withStringType(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule

Add the given mapping for a (simple) java class to its JSON schema equivalent "type" attribute: ""string"".

withTargetTypeOverrideResolver(ConfigFunction<M, ResolvedType>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for target type resolver, expecting the respective member and the default type as inputs.

withTitleResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart

Setter for "title" resolver.

A B C D E F G H I J M N O P R S T V W
All Classes All Packages