SchemaGeneratorGeneralConfigPart (Java JSON Schema Generator 4.28.0 API)

java.lang.Object
- com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart<TypeScope>
- - com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart

```
public class SchemaGeneratorGeneralConfigPart
extends SchemaGeneratorTypeConfigPart<TypeScope>
```
Generic collection of reflection based analysis for populating a JSON Schema targeting a specific type in general.

Constructor Summary

Constructors
Constructor and Description

SchemaGeneratorGeneralConfigPart()

Constructors
Constructor and Description
`SchemaGeneratorGeneralConfigPart()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<CustomDefinitionProviderV2>`	`getCustomDefinitionProviders()` Getter for the applicable custom definition provider.
`SchemaDefinitionNamingStrategy`	`getDefinitionNamingStrategy()` Getter for the current naming strategy for keys in the "definitions"/"$defs".
`Comparator<MemberScope<?,?>>`	`getPropertySorter()` Getter for the sorting algorithm for an object's properties (fields and methods).
`List<SubtypeResolver>`	`getSubtypeResolvers()` Getter for the applicable subtype resolvers.
`List<TypeAttributeOverrideV2>`	`getTypeAttributeOverrides()` Getter for the applicable overrides for type attributes.
`String`	`resolveAnchor(TypeScope scope)` Determine the "$anchor" of a context-independent type representation.
`String`	`resolveId(TypeScope scope)` Determine the "$id" of a context-independent type representation.
`SchemaGeneratorGeneralConfigPart`	`withAdditionalPropertiesResolver(BiFunction<TypeScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> resolver)` Setter for "additionalProperties" resolver.
`SchemaGeneratorGeneralConfigPart`	`withAdditionalPropertiesResolver(ConfigFunction<TypeScope,Type> resolver)` Setter for "additionalProperties" resolver.
`SchemaGeneratorGeneralConfigPart`	`withAnchorResolver(ConfigFunction<TypeScope,String> resolver)` Setter for "$anchor" resolver.
`SchemaGeneratorGeneralConfigPart`	`withArrayMaxItemsResolver(ConfigFunction<TypeScope,Integer> resolver)` Setter for "maxItems" resolver.
`SchemaGeneratorGeneralConfigPart`	`withArrayMinItemsResolver(ConfigFunction<TypeScope,Integer> resolver)` Setter for "minItems" resolver.
`SchemaGeneratorGeneralConfigPart`	`withArrayUniqueItemsResolver(ConfigFunction<TypeScope,Boolean> resolver)` Setter for "uniqueItems" resolver.
`SchemaGeneratorGeneralConfigPart`	`withCustomDefinitionProvider(CustomDefinitionProviderV2 definitionProvider)` Adding a custom schema provider – if it returns null for a given type, the next definition provider will be applied.
`SchemaGeneratorGeneralConfigPart`	`withDefaultResolver(ConfigFunction<TypeScope,Object> resolver)` Setter for "default" resolver.
`SchemaGeneratorGeneralConfigPart`	`withDefinitionNamingStrategy(SchemaDefinitionNamingStrategy namingStrategy)` Replacing the current naming strategy for keys in the "definitions"/"$defs".
`SchemaGeneratorGeneralConfigPart`	`withDescriptionResolver(ConfigFunction<TypeScope,String> resolver)` Setter for "description" resolver.
`SchemaGeneratorGeneralConfigPart`	`withEnumResolver(ConfigFunction<TypeScope,Collection<?>> resolver)` Setter for "enum"/"const" resolver.
`SchemaGeneratorGeneralConfigPart`	`withIdResolver(ConfigFunction<TypeScope,String> resolver)` Setter for "$id" resolver.
`SchemaGeneratorGeneralConfigPart`	`withNumberExclusiveMaximumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)` Setter for "exclusiveMaximum" resolver.
`SchemaGeneratorGeneralConfigPart`	`withNumberExclusiveMinimumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)` Setter for "exclusiveMinimum" resolver.
`SchemaGeneratorGeneralConfigPart`	`withNumberInclusiveMaximumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)` Setter for "maximum" resolver.
`SchemaGeneratorGeneralConfigPart`	`withNumberInclusiveMinimumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)` Setter for "minimum" resolver.
`SchemaGeneratorGeneralConfigPart`	`withNumberMultipleOfResolver(ConfigFunction<TypeScope,BigDecimal> resolver)` Setter for "multipleOf" resolver.
`SchemaGeneratorGeneralConfigPart`	`withPatternPropertiesResolver(BiFunction<TypeScope,SchemaGenerationContext,Map<String,com.fasterxml.jackson.databind.JsonNode>> resolver)` Setter for "patternProperties" resolver.
`SchemaGeneratorGeneralConfigPart`	`withPatternPropertiesResolver(ConfigFunction<TypeScope,Map<String,Type>> resolver)` Setter for "patternProperties" resolver.
`SchemaGeneratorGeneralConfigPart`	`withPropertySorter(Comparator<MemberScope<?,?>> propertySorter)` Replacing the current sorting algorithm of properties (fields and methods).
`SchemaGeneratorGeneralConfigPart`	`withStringFormatResolver(ConfigFunction<TypeScope,String> resolver)` Setter for "format" resolver.
`SchemaGeneratorGeneralConfigPart`	`withStringMaxLengthResolver(ConfigFunction<TypeScope,Integer> resolver)` Setter for "maxLength" resolver.
`SchemaGeneratorGeneralConfigPart`	`withStringMinLengthResolver(ConfigFunction<TypeScope,Integer> resolver)` Setter for "minLength" resolver.
`SchemaGeneratorGeneralConfigPart`	`withStringPatternResolver(ConfigFunction<TypeScope,String> resolver)` Setter for "format" resolver.
`SchemaGeneratorGeneralConfigPart`	`withSubtypeResolver(SubtypeResolver subtypeResolver)` Adding a subtype resolver – if it returns null for a given type, the next subtype resolver will be applied.
`SchemaGeneratorGeneralConfigPart`	`withTitleResolver(ConfigFunction<TypeScope,String> resolver)` Setter for "title" resolver.
`SchemaGeneratorGeneralConfigPart`	`withTypeAttributeOverride(TypeAttributeOverrideV2 override)` Adding an override for type attributes – all of the registered overrides will be applied in the order of having been added.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SchemaGeneratorGeneralConfigPart
```
public SchemaGeneratorGeneralConfigPart()
```
- Method Detail
  - withPropertySorter
```
public SchemaGeneratorGeneralConfigPart withPropertySorter(Comparator<MemberScope<?,?>> propertySorter)
```
    Replacing the current sorting algorithm of properties (fields and methods).
    
    Parameters:
    
    propertySorter - sorting algorithm for an object's properties
    
    Returns:
    
    this builder instance (for chaining)
  - getPropertySorter
```
public Comparator<MemberScope<?,?>> getPropertySorter()
```
    Getter for the sorting algorithm for an object's properties (fields and methods).
    
    Returns:
    
    applicable Comparator for an object's properties
  - withDefinitionNamingStrategy
```
public SchemaGeneratorGeneralConfigPart withDefinitionNamingStrategy(SchemaDefinitionNamingStrategy namingStrategy)
```
    Replacing the current naming strategy for keys in the "definitions"/"$defs".
    
    Parameters:
    
    namingStrategy - naming strategy for "definitions"/"$defs" keys
    
    Returns:
    
    this builder instance (for chaining)
  - getDefinitionNamingStrategy
```
public SchemaDefinitionNamingStrategy getDefinitionNamingStrategy()
```
    Getter for the current naming strategy for keys in the "definitions"/"$defs".
    
    Returns:
    
    applicable naming strategy for "definitions"/"$defs" keys (or null if the a default strategy should be used)
  - withCustomDefinitionProvider
```
public SchemaGeneratorGeneralConfigPart withCustomDefinitionProvider(CustomDefinitionProviderV2 definitionProvider)
```
    Adding a custom schema provider – if it returns null for a given type, the next definition provider will be applied.
    If all custom schema providers return null (or there is none), then the standard behaviour applies.
    
    Parameters:
    
    definitionProvider - provider of a custom definition to register, which may return null
    
    Returns:
    
    this builder instance (for chaining)
  - getCustomDefinitionProviders
```
public List<CustomDefinitionProviderV2> getCustomDefinitionProviders()
```
    Getter for the applicable custom definition provider.
    
    Returns:
    
    providers for certain custom definitions by-passing the default schema generation to some extent
  - withSubtypeResolver
```
public SchemaGeneratorGeneralConfigPart withSubtypeResolver(SubtypeResolver subtypeResolver)
```
    Adding a subtype resolver – if it returns null for a given type, the next subtype resolver will be applied.
    If all subtype resolvers return null, there is none or a resolver returns an empty list, then the standard behaviour applies.
    
    Parameters:
    
    subtypeResolver - resolver for looking up a declared type's subtypes in order to list those specifically
    
    Returns:
    
    this builder instance (for chaining)
  - getSubtypeResolvers
```
public List<SubtypeResolver> getSubtypeResolvers()
```
    Getter for the applicable subtype resolvers.
    
    Returns:
    
    registered subtype resolvers
  - withTypeAttributeOverride
```
public SchemaGeneratorGeneralConfigPart withTypeAttributeOverride(TypeAttributeOverrideV2 override)
```
    Adding an override for type attributes – all of the registered overrides will be applied in the order of having been added.
    
    Parameters:
    
    override - adding/removing attributes on a JSON Schema node – specifically intended for attributes relating to the type in general.
    
    Returns:
    
    this builder instance (for chaining)
  - getTypeAttributeOverrides
```
public List<TypeAttributeOverrideV2> getTypeAttributeOverrides()
```
    Getter for the applicable overrides for type attributes.
    
    Returns:
    
    registered overrides to be applied in the given order
  - withIdResolver
```
public SchemaGeneratorGeneralConfigPart withIdResolver(ConfigFunction<TypeScope,String> resolver)
```
    Setter for "$id" resolver.
    
    Parameters:
    
    resolver - how to determine the "$id" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - resolveId
```
public String resolveId(TypeScope scope)
```
    Determine the "$id" of a context-independent type representation.
    
    Parameters:
    
    scope - context-independent type representation to determine "$id" value for
    
    Returns:
    
    "$id" in a JSON Schema (may be null)
  - withAnchorResolver
```
public SchemaGeneratorGeneralConfigPart withAnchorResolver(ConfigFunction<TypeScope,String> resolver)
```
    Setter for "$anchor" resolver.
    
    Parameters:
    
    resolver - how to determine the "$anchor" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - resolveAnchor
```
public String resolveAnchor(TypeScope scope)
```
    Determine the "$anchor" of a context-independent type representation.
    
    Parameters:
    
    scope - context-independent type representation to determine "$anchor" value for
    
    Returns:
    
    "$anchor" in a JSON Schema (may be null)
  - withTitleResolver
```
public SchemaGeneratorGeneralConfigPart withTitleResolver(ConfigFunction<TypeScope,String> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "title" resolver.
    
    Overrides:
    
    withTitleResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "title" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withDescriptionResolver
```
public SchemaGeneratorGeneralConfigPart withDescriptionResolver(ConfigFunction<TypeScope,String> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "description" resolver.
    
    Overrides:
    
    withDescriptionResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "description" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withDefaultResolver
```
public SchemaGeneratorGeneralConfigPart withDefaultResolver(ConfigFunction<TypeScope,Object> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "default" resolver.
    
    Overrides:
    
    withDefaultResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "default" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withEnumResolver
```
public SchemaGeneratorGeneralConfigPart withEnumResolver(ConfigFunction<TypeScope,Collection<?>> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "enum"/"const" resolver.
    
    Overrides:
    
    withEnumResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "enum"/"const" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withAdditionalPropertiesResolver
```
public SchemaGeneratorGeneralConfigPart withAdditionalPropertiesResolver(ConfigFunction<TypeScope,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<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "additionalProperties" of a JSON Schema, returning Void will result in "false"
    
    Returns:
    
    this config part (for chaining)
  - withAdditionalPropertiesResolver
```
public SchemaGeneratorGeneralConfigPart withAdditionalPropertiesResolver(BiFunction<TypeScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> 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<TypeScope>
    
    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 SchemaGeneratorGeneralConfigPart withPatternPropertiesResolver(ConfigFunction<TypeScope,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<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "patternProperties" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withPatternPropertiesResolver
```
public SchemaGeneratorGeneralConfigPart withPatternPropertiesResolver(BiFunction<TypeScope,SchemaGenerationContext,Map<String,com.fasterxml.jackson.databind.JsonNode>> 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<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "patternProperties" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withStringMinLengthResolver
```
public SchemaGeneratorGeneralConfigPart withStringMinLengthResolver(ConfigFunction<TypeScope,Integer> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "minLength" resolver.
    
    Overrides:
    
    withStringMinLengthResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "minLength" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withStringMaxLengthResolver
```
public SchemaGeneratorGeneralConfigPart withStringMaxLengthResolver(ConfigFunction<TypeScope,Integer> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "maxLength" resolver.
    
    Overrides:
    
    withStringMaxLengthResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "maxLength" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withStringFormatResolver
```
public SchemaGeneratorGeneralConfigPart withStringFormatResolver(ConfigFunction<TypeScope,String> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "format" resolver.
    
    Overrides:
    
    withStringFormatResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "format" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withStringPatternResolver
```
public SchemaGeneratorGeneralConfigPart withStringPatternResolver(ConfigFunction<TypeScope,String> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "format" resolver.
    
    Overrides:
    
    withStringPatternResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "format" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withNumberInclusiveMinimumResolver
```
public SchemaGeneratorGeneralConfigPart withNumberInclusiveMinimumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "minimum" resolver.
    
    Overrides:
    
    withNumberInclusiveMinimumResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "minimum" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withNumberExclusiveMinimumResolver
```
public SchemaGeneratorGeneralConfigPart withNumberExclusiveMinimumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "exclusiveMinimum" resolver.
    
    Overrides:
    
    withNumberExclusiveMinimumResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "exclusiveMinimum" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withNumberInclusiveMaximumResolver
```
public SchemaGeneratorGeneralConfigPart withNumberInclusiveMaximumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "maximum" resolver.
    
    Overrides:
    
    withNumberInclusiveMaximumResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "maximum" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withNumberExclusiveMaximumResolver
```
public SchemaGeneratorGeneralConfigPart withNumberExclusiveMaximumResolver(ConfigFunction<TypeScope,BigDecimal> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "exclusiveMaximum" resolver.
    
    Overrides:
    
    withNumberExclusiveMaximumResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "exclusiveMaximum" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withNumberMultipleOfResolver
```
public SchemaGeneratorGeneralConfigPart withNumberMultipleOfResolver(ConfigFunction<TypeScope,BigDecimal> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "multipleOf" resolver.
    
    Overrides:
    
    withNumberMultipleOfResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "multipleOf" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withArrayMinItemsResolver
```
public SchemaGeneratorGeneralConfigPart withArrayMinItemsResolver(ConfigFunction<TypeScope,Integer> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "minItems" resolver.
    
    Overrides:
    
    withArrayMinItemsResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "minItems" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withArrayMaxItemsResolver
```
public SchemaGeneratorGeneralConfigPart withArrayMaxItemsResolver(ConfigFunction<TypeScope,Integer> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "maxItems" resolver.
    
    Overrides:
    
    withArrayMaxItemsResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "maxItems" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)
  - withArrayUniqueItemsResolver
```
public SchemaGeneratorGeneralConfigPart withArrayUniqueItemsResolver(ConfigFunction<TypeScope,Boolean> resolver)
```
    Description copied from class: SchemaGeneratorTypeConfigPart
    
    Setter for "uniqueItems" resolver.
    
    Overrides:
    
    withArrayUniqueItemsResolver in class SchemaGeneratorTypeConfigPart<TypeScope>
    
    Parameters:
    
    resolver - how to determine the "uniqueItems" of a JSON Schema
    
    Returns:
    
    this config part (for chaining)

Class SchemaGeneratorGeneralConfigPart

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SchemaGeneratorGeneralConfigPart

Method Detail

withPropertySorter

getPropertySorter

withDefinitionNamingStrategy

getDefinitionNamingStrategy

withCustomDefinitionProvider

getCustomDefinitionProviders

withSubtypeResolver

getSubtypeResolvers

withTypeAttributeOverride

getTypeAttributeOverrides

withIdResolver

resolveId

withAnchorResolver

resolveAnchor

withTitleResolver

withDescriptionResolver

withDefaultResolver

withEnumResolver

withAdditionalPropertiesResolver

withAdditionalPropertiesResolver

withPatternPropertiesResolver

withPatternPropertiesResolver

withStringMinLengthResolver

withStringMaxLengthResolver

withStringFormatResolver

withStringPatternResolver

withNumberInclusiveMinimumResolver

withNumberExclusiveMinimumResolver

withNumberInclusiveMaximumResolver

withNumberExclusiveMaximumResolver

withNumberMultipleOfResolver

withArrayMinItemsResolver

withArrayMaxItemsResolver

withArrayUniqueItemsResolver