Uses of Interface
com.github.victools.jsonschema.generator.SchemaGenerationContext

Packages that use SchemaGenerationContext

Package	Description
com.github.victools.jsonschema.generator
com.github.victools.jsonschema.generator.impl
com.github.victools.jsonschema.generator.impl.module
com.github.victools.jsonschema.generator.naming

Uses of SchemaGenerationContext in com.github.victools.jsonschema.generator

Methods in com.github.victools.jsonschema.generator with parameters of type SchemaGenerationContext

Modifier and Type	Method	Description
List<com.fasterxml.classmate.ResolvedType>	SubtypeResolver.findSubtypes(com.fasterxml.classmate.ResolvedType declaredType, SchemaGenerationContext context)	Look-up the subtypes for a given type, that should be listed independently.
CustomDefinition	SchemaGeneratorConfig.getCustomDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context, CustomDefinitionProviderV2 ignoredDefinitionProvider)	Look-up the non-standard JSON schema definition for a given type.
<M extends MemberScope<?,?>> CustomDefinition	SchemaGeneratorConfig.getCustomDefinition(M scope, SchemaGenerationContext context, CustomPropertyDefinitionProvider<M> ignoredDefinitionProvider)	Look-up the non-standard JSON schema definition for a given property.
protected static <S extends TypeScope,R> R	SchemaGeneratorTypeConfigPart.getFirstDefinedValue(List<BiFunction<S,SchemaGenerationContext,R>> resolvers, S scope, SchemaGenerationContext context)	Helper function for invoking a given function with the provided inputs or returning null, if all functions return null themselves.
default void	InstanceAttributeOverride.overrideInstanceAttributes(com.fasterxml.jackson.databind.node.ObjectNode jsonSchemaAttributesNode, M member, SchemaGenerationContext context)	Deprecated.
void	InstanceAttributeOverrideV2.overrideInstanceAttributes(com.fasterxml.jackson.databind.node.ObjectNode collectedMemberAttributes, M member, SchemaGenerationContext context)	Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.
default void	TypeAttributeOverride.overrideTypeAttributes(com.fasterxml.jackson.databind.node.ObjectNode collectedTypeAttributes, TypeScope scope, SchemaGenerationContext context)	Deprecated.
void	TypeAttributeOverrideV2.overrideTypeAttributes(com.fasterxml.jackson.databind.node.ObjectNode collectedTypeAttributes, TypeScope scope, SchemaGenerationContext context)	Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to the type in general.
default CustomDefinition	CustomDefinitionProvider.provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)	Deprecated.
CustomDefinition	CustomDefinitionProviderV2.provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)	Look-up the non-standard JSON schema definition for a given type.
CustomPropertyDefinition	CustomPropertyDefinitionProvider.provideCustomSchemaDefinition(M scope, SchemaGenerationContext context)	Look-up the non-standard JSON schema definition for a given property.
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfig.resolveAdditionalProperties(FieldScope field, SchemaGenerationContext context)	Determine the "additionalProperties" of an object's field/property.
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfig.resolveAdditionalProperties(MethodScope method, SchemaGenerationContext context)	Determine the "additionalProperties" of a method's return value.
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorTypeConfigPart.resolveAdditionalProperties(S scope, SchemaGenerationContext context)	Determine the "additionalProperties" of a given scope/type representation.
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfig.resolveAdditionalPropertiesForType(TypeScope scope, SchemaGenerationContext context)	Determine the "additionalProperties" of a context-independent type representation.
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfig.resolvePatternProperties(FieldScope field, SchemaGenerationContext context)	Determine the "patternProperties" of an object's field/property.
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfig.resolvePatternProperties(MethodScope method, SchemaGenerationContext context)	Determine the "patternProperties" of a method's return value.
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorTypeConfigPart.resolvePatternProperties(S scope, SchemaGenerationContext context)	Determine the "patternProperties" of a given scope/type representation.
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfig.resolvePatternPropertiesForType(TypeScope scope, SchemaGenerationContext context)	Determine the "patternProperties" of a context-independent type representation.
List<com.fasterxml.classmate.ResolvedType>	SchemaGeneratorConfig.resolveSubtypes(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)	Look-up a declared type's subtypes in order to list those specifically (in an SchemaKeyword.TAG_ANYOF).

Method parameters in com.github.victools.jsonschema.generator with type arguments of type SchemaGenerationContext

Modifier and Type	Method	Description
protected static <S extends TypeScope,R> R	SchemaGeneratorTypeConfigPart.getFirstDefinedValue(List<BiFunction<S,SchemaGenerationContext,R>> resolvers, S scope, SchemaGenerationContext context)	Helper function for invoking a given function with the provided inputs or returning null, if all functions return null themselves.
SchemaGeneratorConfigPart<M>	SchemaGeneratorConfigPart.withAdditionalPropertiesResolver(BiFunction<M,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> resolver)
SchemaGeneratorGeneralConfigPart	SchemaGeneratorGeneralConfigPart.withAdditionalPropertiesResolver(BiFunction<TypeScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> resolver)
SchemaGeneratorTypeConfigPart<S>	SchemaGeneratorTypeConfigPart.withAdditionalPropertiesResolver(BiFunction<S,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> resolver)	Setter for "additionalProperties" resolver.
SchemaGeneratorConfigPart<M>	SchemaGeneratorConfigPart.withPatternPropertiesResolver(BiFunction<M,SchemaGenerationContext,Map<String,com.fasterxml.jackson.databind.JsonNode>> resolver)
SchemaGeneratorGeneralConfigPart	SchemaGeneratorGeneralConfigPart.withPatternPropertiesResolver(BiFunction<TypeScope,SchemaGenerationContext,Map<String,com.fasterxml.jackson.databind.JsonNode>> resolver)
SchemaGeneratorTypeConfigPart<S>	SchemaGeneratorTypeConfigPart.withPatternPropertiesResolver(BiFunction<S,SchemaGenerationContext,Map<String,com.fasterxml.jackson.databind.JsonNode>> resolver)	Setter for "patternProperties" resolver.

Uses of SchemaGenerationContext in com.github.victools.jsonschema.generator.impl

Classes in com.github.victools.jsonschema.generator.impl that implement SchemaGenerationContext

Modifier and Type	Class	Description
class	SchemaGenerationContextImpl	Generation context in which to collect definitions of traversed types and remember where they are being referenced.

Methods in com.github.victools.jsonschema.generator.impl with parameters of type SchemaGenerationContext

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.node.ObjectNode	AttributeCollector.collectFieldAttributes(FieldScope field, SchemaGenerationContext generationContext)	Collect a field's contextual attributes (i.e.
static com.fasterxml.jackson.databind.node.ObjectNode	AttributeCollector.collectMethodAttributes(MethodScope method, SchemaGenerationContext generationContext)	Collect a method's contextual attributes (i.e.
static com.fasterxml.jackson.databind.node.ObjectNode	AttributeCollector.collectTypeAttributes(TypeScope scope, SchemaGenerationContext generationContext, Set<String> allowedSchemaTypes)	Collect a given scope's general type attributes (i.e.
CustomDefinition	SchemaGeneratorConfigImpl.getCustomDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context, CustomDefinitionProviderV2 ignoredDefinitionProvider)
<M extends MemberScope<?,?>> CustomPropertyDefinition	SchemaGeneratorConfigImpl.getCustomDefinition(M scope, SchemaGenerationContext context, CustomPropertyDefinitionProvider<M> ignoredDefinitionProvider)
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfigImpl.resolveAdditionalProperties(FieldScope field, SchemaGenerationContext context)
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfigImpl.resolveAdditionalProperties(MethodScope method, SchemaGenerationContext context)
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfigImpl.resolveAdditionalPropertiesForType(TypeScope scope, SchemaGenerationContext context)
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfigImpl.resolvePatternProperties(FieldScope field, SchemaGenerationContext context)
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfigImpl.resolvePatternProperties(MethodScope method, SchemaGenerationContext context)
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfigImpl.resolvePatternPropertiesForType(TypeScope scope, SchemaGenerationContext context)
List<com.fasterxml.classmate.ResolvedType>	SchemaGeneratorConfigImpl.resolveSubtypes(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)
AttributeCollector	AttributeCollector.setAdditionalProperties(com.fasterxml.jackson.databind.node.ObjectNode node, com.fasterxml.jackson.databind.JsonNode additionalProperties, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_ADDITIONAL_PROPERTIES" attribute.
AttributeCollector	AttributeCollector.setAnchor(com.fasterxml.jackson.databind.node.ObjectNode node, String anchor, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_ANCHOR" attribute.
AttributeCollector	AttributeCollector.setArrayMaxItems(com.fasterxml.jackson.databind.node.ObjectNode node, Integer maxItemCount, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_ITEMS_MAX" attribute.
AttributeCollector	AttributeCollector.setArrayMinItems(com.fasterxml.jackson.databind.node.ObjectNode node, Integer minItemCount, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_ITEMS_MIN" attribute.
AttributeCollector	AttributeCollector.setArrayUniqueItems(com.fasterxml.jackson.databind.node.ObjectNode node, Boolean uniqueItems, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_ITEMS_UNIQUE" attribute.
AttributeCollector	AttributeCollector.setDefault(com.fasterxml.jackson.databind.node.ObjectNode node, Object defaultValue, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_DEFAULT" attribute.
AttributeCollector	AttributeCollector.setDescription(com.fasterxml.jackson.databind.node.ObjectNode node, String description, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_DESCRIPTION" attribute.
AttributeCollector	AttributeCollector.setEnum(com.fasterxml.jackson.databind.node.ObjectNode node, Collection<?> enumValues, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_CONST"/"SchemaKeyword.TAG_ENUM" attribute.
AttributeCollector	AttributeCollector.setId(com.fasterxml.jackson.databind.node.ObjectNode node, String id, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_ID" attribute.
AttributeCollector	AttributeCollector.setNumberExclusiveMaximum(com.fasterxml.jackson.databind.node.ObjectNode node, BigDecimal exclusiveMaximum, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_MAXIMUM_EXCLUSIVE" attribute.
AttributeCollector	AttributeCollector.setNumberExclusiveMinimum(com.fasterxml.jackson.databind.node.ObjectNode node, BigDecimal exclusiveMinimum, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_MINIMUM_EXCLUSIVE" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setNumberInclusiveMaximum(com.fasterxml.jackson.databind.node.ObjectNode node, BigDecimal inclusiveMaximum, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_MAXIMUM" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setNumberInclusiveMinimum(com.fasterxml.jackson.databind.node.ObjectNode node, BigDecimal inclusiveMinimum, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_MINIMUM" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setNumberMultipleOf(com.fasterxml.jackson.databind.node.ObjectNode node, BigDecimal multipleOf, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_MULTIPLE_OF" attribute.
AttributeCollector	AttributeCollector.setPatternProperties(com.fasterxml.jackson.databind.node.ObjectNode node, Map<String,com.fasterxml.jackson.databind.JsonNode> patternProperties, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_PATTERN_PROPERTIES" attribute.
AttributeCollector	AttributeCollector.setReadOnly(com.fasterxml.jackson.databind.node.ObjectNode node, boolean readOnly, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_READ_ONLY" attribute.
AttributeCollector	AttributeCollector.setStringFormat(com.fasterxml.jackson.databind.node.ObjectNode node, String format, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_FORMAT" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setStringMaxLength(com.fasterxml.jackson.databind.node.ObjectNode node, Integer maxLength, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_LENGTH_MAX" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setStringMinLength(com.fasterxml.jackson.databind.node.ObjectNode node, Integer minLength, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_LENGTH_MIN" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setStringPattern(com.fasterxml.jackson.databind.node.ObjectNode node, String pattern, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_PATTERN" attribute (considering Draft 7).
AttributeCollector	AttributeCollector.setTitle(com.fasterxml.jackson.databind.node.ObjectNode node, String title, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_TITLE" attribute.
AttributeCollector	AttributeCollector.setWriteOnly(com.fasterxml.jackson.databind.node.ObjectNode node, boolean writeOnly, SchemaGenerationContext generationContext)	Setter for "SchemaKeyword.TAG_WRITE_ONLY" attribute.

Uses of SchemaGenerationContext in com.github.victools.jsonschema.generator.impl.module

Methods in com.github.victools.jsonschema.generator.impl.module with parameters of type SchemaGenerationContext

Modifier and Type	Method	Description
CustomDefinition	InlineSchemaModule.provideCustomSchemaDefinition(com.fasterxml.classmate.ResolvedType javaType, SchemaGenerationContext context)

Constructor parameters in com.github.victools.jsonschema.generator.impl.module with type arguments of type SchemaGenerationContext

Constructor	Description
AdditionalPropertiesModule(ConfigFunction<TypeScope,Type> generalAdditionalPropertiesResolver, BiFunction<FieldScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> fieldAdditionalPropertiesResolver, BiFunction<MethodScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> methodAdditionalPropertiesResolver)	Constructor.

Uses of SchemaGenerationContext in com.github.victools.jsonschema.generator.naming

Methods in com.github.victools.jsonschema.generator.naming with parameters of type SchemaGenerationContext

Modifier and Type	Method	Description
void	CleanSchemaDefinitionNamingStrategy.adjustDuplicateNames(Map<DefinitionKey,String> subschemasWithDuplicateNames, SchemaGenerationContext generationContext)
default void	SchemaDefinitionNamingStrategy.adjustDuplicateNames(Map<DefinitionKey,String> subschemasWithDuplicateNames, SchemaGenerationContext generationContext)	Adjust the names/keys in the "definitions"/"$defs" for the given definition references that have the same names (according to SchemaDefinitionNamingStrategy.getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext)) to ensure their uniqueness.
String	CleanSchemaDefinitionNamingStrategy.adjustNullableName(DefinitionKey key, String definitionName, SchemaGenerationContext generationContext)
default String	SchemaDefinitionNamingStrategy.adjustNullableName(DefinitionKey key, String definitionName, SchemaGenerationContext generationContext)	Provide an alternative definition name for the given key and name when it is nullable.
String	CleanSchemaDefinitionNamingStrategy.getDefinitionNameForKey(DefinitionKey key, SchemaGenerationContext generationContext)
String	DefaultSchemaDefinitionNamingStrategy.getDefinitionNameForKey(DefinitionKey key, SchemaGenerationContext generationContext)
String	SchemaDefinitionNamingStrategy.getDefinitionNameForKey(DefinitionKey key, SchemaGenerationContext generationContext)	Getter for the name/key in the "definitions"/"$defs" to represent the given DefinitionKey.