Package com.github.victools.jsonschema.generator

Class SchemaGeneratorConfigPart<M extends MemberScope<?,?>>

java.lang.Object

com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart<M>

com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart<M>

Type Parameters:

M - type of the (resolved) member to analyse

public class SchemaGeneratorConfigPart<M extends MemberScope<?,?>>
extends SchemaGeneratorTypeConfigPart<M>

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

Constructor Summary

Constructors

Constructor	Description
SchemaGeneratorConfigPart()

Method Summary

Modifier and Type	Method	Description
List<InstanceAttributeOverride<M>>	getInstanceAttributeOverrides()	Getter for the applicable instance attribute overrides.
Boolean	isNullable(M member)	Determine whether a given member is nullable.
boolean	isRequired(M member)	Determine whether a given member should be indicated as being required in its declaring type.
String	resolvePropertyNameOverride(M member)	Determine the alternative name in a parent JSON Schema's "properties" from a given member.
com.fasterxml.classmate.ResolvedType	resolveTargetTypeOverride(M member)	Determine the alternative target type from a given member.
boolean	shouldIgnore(M member)	Determine whether a given member should be included – ignoring member if any inclusion check returns false.
SchemaGeneratorConfigPart<M>	withAdditionalPropertiesResolver(ConfigFunction<M,Type> resolver)	Setter for "additionalProperties" resolver.
SchemaGeneratorConfigPart<M>	withArrayMaxItemsResolver(ConfigFunction<M,Integer> resolver)	Setter for "maxItems" resolver.
SchemaGeneratorConfigPart<M>	withArrayMinItemsResolver(ConfigFunction<M,Integer> resolver)	Setter for "minItems" resolver.
SchemaGeneratorConfigPart<M>	withArrayUniqueItemsResolver(ConfigFunction<M,Boolean> resolver)	Setter for "uniqueItems" resolver.
SchemaGeneratorConfigPart<M>	withDefaultResolver(ConfigFunction<M,Object> resolver)	Setter for "default" resolver.
SchemaGeneratorConfigPart<M>	withDescriptionResolver(ConfigFunction<M,String> resolver)	Setter for "description" resolver.
SchemaGeneratorConfigPart<M>	withEnumResolver(ConfigFunction<M,Collection<?>> resolver)	Setter for "enum"/"const" resolver.
SchemaGeneratorConfigPart<M>	withIgnoreCheck(Predicate<M> check)	Setter for ignore check.
SchemaGeneratorConfigPart<M>	withInstanceAttributeOverride(InstanceAttributeOverride<M> override)	Setter for override of attributes on a given JSON Schema node in the respective member.
SchemaGeneratorConfigPart<M>	withNullableCheck(ConfigFunction<M,Boolean> check)	Setter for nullable check.
SchemaGeneratorConfigPart<M>	withNumberExclusiveMaximumResolver(ConfigFunction<M,BigDecimal> resolver)	Setter for "exclusiveMaximum" resolver.
SchemaGeneratorConfigPart<M>	withNumberExclusiveMinimumResolver(ConfigFunction<M,BigDecimal> resolver)	Setter for "exclusiveMinimum" resolver.
SchemaGeneratorConfigPart<M>	withNumberInclusiveMaximumResolver(ConfigFunction<M,BigDecimal> resolver)	Setter for "maximum" resolver.
SchemaGeneratorConfigPart<M>	withNumberInclusiveMinimumResolver(ConfigFunction<M,BigDecimal> resolver)	Setter for "minimum" resolver.
SchemaGeneratorConfigPart<M>	withNumberMultipleOfResolver(ConfigFunction<M,BigDecimal> resolver)	Setter for "multipleOf" resolver.
SchemaGeneratorConfigPart<M>	withPatternPropertiesResolver(ConfigFunction<M,Map<String,Type>> resolver)	Setter for "patternProperties" resolver.
SchemaGeneratorConfigPart<M>	withPropertyNameOverrideResolver(ConfigFunction<M,String> resolver)	Setter for property name resolver, expecting the respective member and the default name as inputs.
SchemaGeneratorConfigPart<M>	withRequiredCheck(Predicate<M> check)	Setter for required check.
SchemaGeneratorConfigPart<M>	withStringFormatResolver(ConfigFunction<M,String> resolver)	Setter for "format" resolver.
SchemaGeneratorConfigPart<M>	withStringMaxLengthResolver(ConfigFunction<M,Integer> resolver)	Setter for "maxLength" resolver.
SchemaGeneratorConfigPart<M>	withStringMinLengthResolver(ConfigFunction<M,Integer> resolver)	Setter for "minLength" resolver.
SchemaGeneratorConfigPart<M>	withStringPatternResolver(ConfigFunction<M,String> resolver)	Setter for "format" resolver.
SchemaGeneratorConfigPart<M>	withTargetTypeOverrideResolver(ConfigFunction<M,com.fasterxml.classmate.ResolvedType> resolver)	Setter for target type resolver, expecting the respective member and the default type as inputs.
SchemaGeneratorConfigPart<M>	withTitleResolver(ConfigFunction<M,String> resolver)	Setter for "title" resolver.

Methods inherited from class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart

getFirstDefinedValue, resolveAdditionalProperties, resolveArrayMaxItems, resolveArrayMinItems, resolveArrayUniqueItems, resolveDefault, resolveDescription, resolveEnum, resolveNumberExclusiveMaximum, resolveNumberExclusiveMinimum, resolveNumberInclusiveMaximum, resolveNumberInclusiveMinimum, resolveNumberMultipleOf, resolvePatternProperties, resolveStringFormat, resolveStringMaxLength, resolveStringMinLength, resolveStringPattern, resolveTitle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaGeneratorConfigPart

public SchemaGeneratorConfigPart()

Method Detail

withInstanceAttributeOverride

public SchemaGeneratorConfigPart<M> withInstanceAttributeOverride(InstanceAttributeOverride<M> override)

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

Parameters:

override - override of a given JSON Schema node's instance attributes

Returns:

this config part (for chaining)

getInstanceAttributeOverrides

public List<InstanceAttributeOverride<M>> getInstanceAttributeOverrides()

Getter for the applicable instance attribute overrides.

Returns:

overrides of a given JSON Schema node's instance attributes

withIgnoreCheck

public SchemaGeneratorConfigPart<M> withIgnoreCheck(Predicate<M> check)

Setter for ignore check.

Parameters:

check - how to determine whether a given reference should be ignored

Returns:

this config part (for chaining)

shouldIgnore

public boolean shouldIgnore(M member)

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

Parameters:

member - member to check

Returns:

whether the member should be ignored (defaults to false)

withRequiredCheck

public SchemaGeneratorConfigPart<M> withRequiredCheck(Predicate<M> check)

Setter for required check.

Parameters:

check - how to determine whether a given reference should have required value

Returns:

this config part (for chaining)

isRequired

public boolean isRequired(M member)

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

Parameters:

member - member to check

Returns:

whether the member is required (defaults to false)

withNullableCheck

public SchemaGeneratorConfigPart<M> withNullableCheck(ConfigFunction<M,Boolean> check)

Setter for nullable check.

Parameters:

check - how to determine whether a given reference should be nullable

Returns:

this config part (for chaining)

isNullable

public Boolean isNullable(M member)

Determine whether a given member is nullable.

Parameters:

member - member to check

Returns:

whether the member is nullable (may be null if not specified)

withTargetTypeOverrideResolver

public SchemaGeneratorConfigPart<M> withTargetTypeOverrideResolver(ConfigFunction<M,com.fasterxml.classmate.ResolvedType> resolver)

Setter for target type resolver, expecting the respective member and the default type as inputs.
For generally replacing one type with one or multiple of its subtypes, you may want to consider adding a SubtypeResolver via forTypesInGeneral() instead.

Parameters:

resolver - how to determine the alternative target type

Returns:

this config part (for chaining)

See Also:

SchemaGeneratorGeneralConfigPart.withSubtypeResolver(SubtypeResolver)

resolveTargetTypeOverride

public com.fasterxml.classmate.ResolvedType resolveTargetTypeOverride(M member)

Determine the alternative target type from a given member.

Parameters:

member - member to determine the target type override for

Returns:

target type of member (may be null)

See Also:

MemberScope.getDeclaredType(), MemberScope.getOverriddenType()

withPropertyNameOverrideResolver

public SchemaGeneratorConfigPart<M> withPropertyNameOverrideResolver(ConfigFunction<M,String> resolver)

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

Parameters:

resolver - how to determine the alternative name in a parent JSON Schema's "properties"

Returns:

this config part (for chaining)

resolvePropertyNameOverride

public String resolvePropertyNameOverride(M member)

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

Parameters:

member - member to determine the property name for

Returns:

name in a parent JSON Schema's "properties" (may be null, thereby falling back on the default value)

withTitleResolver

public SchemaGeneratorConfigPart<M> withTitleResolver(ConfigFunction<M,String> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "title" resolver.

Overrides:

withTitleResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "title" of a JSON Schema

Returns:

this config part (for chaining)

withDescriptionResolver

public SchemaGeneratorConfigPart<M> withDescriptionResolver(ConfigFunction<M,String> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "description" resolver.

Overrides:

withDescriptionResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "description" of a JSON Schema

Returns:

this config part (for chaining)

withDefaultResolver

public SchemaGeneratorConfigPart<M> withDefaultResolver(ConfigFunction<M,Object> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "default" resolver.

Overrides:

withDefaultResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "default" of a JSON Schema

Returns:

this config part (for chaining)

withEnumResolver

public SchemaGeneratorConfigPart<M> withEnumResolver(ConfigFunction<M,Collection<?>> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "enum"/"const" resolver.

Overrides:

withEnumResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "enum"/"const" of a JSON Schema

Returns:

this config part (for chaining)

withAdditionalPropertiesResolver

public SchemaGeneratorConfigPart<M> withAdditionalPropertiesResolver(ConfigFunction<M,Type> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "additionalProperties" resolver. If the returned type is Void "false" will be set, otherwise an appropriate sub-schema.

Overrides:

withAdditionalPropertiesResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "additionalProperties" of a JSON Schema, returning Void will result in "false"

Returns:

this config part (for chaining)

withPatternPropertiesResolver

public SchemaGeneratorConfigPart<M> withPatternPropertiesResolver(ConfigFunction<M,Map<String,Type>> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "patternProperties" resolver. The map's keys are representing the patterns and the mapped values their corresponding types.

Overrides:

withPatternPropertiesResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "patternProperties" of a JSON Schema

Returns:

this config part (for chaining)

withStringMinLengthResolver

public SchemaGeneratorConfigPart<M> withStringMinLengthResolver(ConfigFunction<M,Integer> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "minLength" resolver.

Overrides:

withStringMinLengthResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "minLength" of a JSON Schema

Returns:

this config part (for chaining)

withStringMaxLengthResolver

public SchemaGeneratorConfigPart<M> withStringMaxLengthResolver(ConfigFunction<M,Integer> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "maxLength" resolver.

Overrides:

withStringMaxLengthResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "maxLength" of a JSON Schema

Returns:

this config part (for chaining)

withStringFormatResolver

public SchemaGeneratorConfigPart<M> withStringFormatResolver(ConfigFunction<M,String> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "format" resolver.

Overrides:

withStringFormatResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "format" of a JSON Schema

Returns:

this config part (for chaining)

withStringPatternResolver

public SchemaGeneratorConfigPart<M> withStringPatternResolver(ConfigFunction<M,String> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "format" resolver.

Overrides:

withStringPatternResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "format" of a JSON Schema

Returns:

this config part (for chaining)

withNumberInclusiveMinimumResolver

public SchemaGeneratorConfigPart<M> withNumberInclusiveMinimumResolver(ConfigFunction<M,BigDecimal> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "minimum" resolver.

Overrides:

withNumberInclusiveMinimumResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "minimum" of a JSON Schema

Returns:

this config part (for chaining)

withNumberExclusiveMinimumResolver

public SchemaGeneratorConfigPart<M> withNumberExclusiveMinimumResolver(ConfigFunction<M,BigDecimal> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "exclusiveMinimum" resolver.

Overrides:

withNumberExclusiveMinimumResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "exclusiveMinimum" of a JSON Schema

Returns:

this config part (for chaining)

withNumberInclusiveMaximumResolver

public SchemaGeneratorConfigPart<M> withNumberInclusiveMaximumResolver(ConfigFunction<M,BigDecimal> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "maximum" resolver.

Overrides:

withNumberInclusiveMaximumResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "maximum" of a JSON Schema

Returns:

this config part (for chaining)

withNumberExclusiveMaximumResolver

public SchemaGeneratorConfigPart<M> withNumberExclusiveMaximumResolver(ConfigFunction<M,BigDecimal> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "exclusiveMaximum" resolver.

Overrides:

withNumberExclusiveMaximumResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "exclusiveMaximum" of a JSON Schema

Returns:

this config part (for chaining)

withNumberMultipleOfResolver

public SchemaGeneratorConfigPart<M> withNumberMultipleOfResolver(ConfigFunction<M,BigDecimal> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "multipleOf" resolver.

Overrides:

withNumberMultipleOfResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "multipleOf" of a JSON Schema

Returns:

this config part (for chaining)

withArrayMinItemsResolver

public SchemaGeneratorConfigPart<M> withArrayMinItemsResolver(ConfigFunction<M,Integer> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "minItems" resolver.

Overrides:

withArrayMinItemsResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "minItems" of a JSON Schema

Returns:

this config part (for chaining)

withArrayMaxItemsResolver

public SchemaGeneratorConfigPart<M> withArrayMaxItemsResolver(ConfigFunction<M,Integer> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "maxItems" resolver.

Overrides:

withArrayMaxItemsResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "maxItems" of a JSON Schema

Returns:

this config part (for chaining)

withArrayUniqueItemsResolver

public SchemaGeneratorConfigPart<M> withArrayUniqueItemsResolver(ConfigFunction<M,Boolean> resolver)

Description copied from class: SchemaGeneratorTypeConfigPart

Setter for "uniqueItems" resolver.

Overrides:

withArrayUniqueItemsResolver in class SchemaGeneratorTypeConfigPart<M extends MemberScope<?,?>>

Parameters:

resolver - how to determine the "uniqueItems" of a JSON Schema

Returns:

this config part (for chaining)