A B C D E F G H I J L M N O P R S T V W Y
All Classes All Packages
All Classes All Packages
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
SchemaKeyword.TAG_TYPE
attribute of "string"/"boolean"/"integer"/"number". - AdditionalPropertiesModule - Class in com.github.victools.jsonschema.generator.impl.module
-
Default module being included if
Option.FORBIDDEN_ADDITIONAL_PROPERTIES_BY_DEFAULT
is enabled. - AdditionalPropertiesModule(ConfigFunction<TypeScope, Type>) - Constructor for class com.github.victools.jsonschema.generator.impl.module.AdditionalPropertiesModule
-
Constructor.
- AdditionalPropertiesModule(ConfigFunction<TypeScope, Type>, BiFunction<FieldScope, SchemaGenerationContext, JsonNode>, BiFunction<MethodScope, SchemaGenerationContext, JsonNode>) - Constructor for class com.github.victools.jsonschema.generator.impl.module.AdditionalPropertiesModule
-
Constructor.
- addReference(ResolvedType, ObjectNode, CustomDefinitionProviderV2, boolean) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
-
Remember for the specified type that the given node is supposed to either include or reference the type's associated schema.
- adjustDuplicateNames(Map<DefinitionKey, String>, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.naming.CleanSchemaDefinitionNamingStrategy
- adjustDuplicateNames(Map<DefinitionKey, String>, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy
-
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. - adjustNullableName(DefinitionKey, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.naming.CleanSchemaDefinitionNamingStrategy
- adjustNullableName(DefinitionKey, String, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy
-
Provide an alternative definition name for the given key and name when it is nullable.
- ALLOF_CLEANUP_AT_THE_END - com.github.victools.jsonschema.generator.Option
-
Whether as the last step of the schema generation, unnecessary "allOf" elements (i.e.
- ALWAYS_REF - com.github.victools.jsonschema.generator.CustomDefinition.DefinitionType
-
Always include this entry in the
SchemaKeyword.TAG_DEFINITIONS
even if it is just referenced once. - apply(S) - 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.AdditionalPropertiesModule
- 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.FlattenedWrapperModule
- applyToConfigBuilder(SchemaGeneratorConfigBuilder) - Method in class com.github.victools.jsonschema.generator.impl.module.InlineSchemaModule
- 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.
- ARRAY - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- ARRAY_OF_SCHEMAS - com.github.victools.jsonschema.generator.SchemaKeyword.TagContent
- asFakeContainerItemScope() - Method in class com.github.victools.jsonschema.generator.FieldScope
- asFakeContainerItemScope() - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Create another instance for this field or method and context, representing its field/method return type's container item type.
- asFakeContainerItemScope() - Method in class com.github.victools.jsonschema.generator.MethodScope
- asFakeContainerItemScope(Class<?>, int) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Create another instance for this field or method and context, representing its field/method return type's container item type.
- 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 butname()
. - asStringsFromName() - 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 (derived from their constant value names). - asStringsFromToString() - 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 (derived from each value's toString()). - 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
- BOOLEAN - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- build() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Create a schema generator instance from the builder.
- buildMultipleSchemaDefinitions() - Method in class com.github.victools.jsonschema.generator.SchemaGenerator
-
Create a
SchemaBuilder
instance for collecting schema references viacreateSchemaReference()
until finalizing the generation viacollectDefinitions()
.
C
- CleanSchemaDefinitionNamingStrategy - Class in com.github.victools.jsonschema.generator.naming
-
Wrapper for a
SchemaDefinitionNamingStrategy
that performs a specific clean-up task on all returned values. - CleanSchemaDefinitionNamingStrategy(SchemaDefinitionNamingStrategy, Function<String, String>) - Constructor for class com.github.victools.jsonschema.generator.naming.CleanSchemaDefinitionNamingStrategy
-
Constructor expecting a naming strategy to be wrapped and the applicable clean-up task.
- collectDefinitions(String) - Method in class com.github.victools.jsonschema.generator.SchemaBuilder
-
Completing the schema generation (after
SchemaBuilder.createSchemaReference(Type, Type...)
was invoked for all relevant types) by creating anObjectNode
containing common schema definitions. - collectFieldAttributes(FieldScope, SchemaGenerationContext) - Static method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Collect a field's contextual attributes (i.e.
- collectMethodAttributes(MethodScope, SchemaGenerationContext) - Static method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Collect a method's contextual attributes (i.e.
- collectTypeAttributes(TypeScope, SchemaGenerationContext, Set<String>) - Static method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Collect a given scope's general type 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
- com.github.victools.jsonschema.generator.naming - package com.github.victools.jsonschema.generator.naming
- ConfigFunction<S extends TypeScope,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, CustomDefinitionProviderV2) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
-
Whether this context (already) contains a definition for the specified type, considering custom definition providers after the specified one.
- 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 enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Deprecated.
- createDefaultTypeContext(SchemaGeneratorConfig) - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Create the default
TypeContext
withAnnotationInclusion.INCLUDE_AND_INHERIT_IF_INHERITED
.
This is equivalent to calling:TypeContextFactory.createTypeContext(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.
- createDefinitionReference(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- createDefinitionReference(ResolvedType) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Create a 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).
- createSchemaReference(Type, Type...) - Method in class com.github.victools.jsonschema.generator.SchemaBuilder
-
Generate an
ObjectNode
placeholder for the given type and add all referenced/encountered types to this builder instance. - 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.
- createStandardDefinition(FieldScope, CustomPropertyDefinitionProvider<FieldScope>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- createStandardDefinition(FieldScope, CustomPropertyDefinitionProvider<FieldScope>) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Create a standard definition for the given property.
- createStandardDefinition(MethodScope, CustomPropertyDefinitionProvider<MethodScope>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- createStandardDefinition(MethodScope, CustomPropertyDefinitionProvider<MethodScope>) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Create a standard definition for the given property.
- createStandardDefinitionReference(ResolvedType, CustomDefinitionProviderV2) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- createStandardDefinitionReference(ResolvedType, CustomDefinitionProviderV2) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Create a standard definition for the given targetType.
- createStandardDefinitionReference(FieldScope, CustomPropertyDefinitionProvider<FieldScope>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- createStandardDefinitionReference(FieldScope, CustomPropertyDefinitionProvider<FieldScope>) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Create a standard definition for the given property.
- createStandardDefinitionReference(MethodScope, CustomPropertyDefinitionProvider<MethodScope>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- createStandardDefinitionReference(MethodScope, CustomPropertyDefinitionProvider<MethodScope>) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Create a standard definition for the given property.
- createTypeContext(AnnotationConfiguration) - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Deprecated.
- createTypeContext(AnnotationConfiguration, SchemaGeneratorConfig) - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Create the a
TypeContext
with the givenAnnotationConfiguration
. - createTypeContext(AnnotationInclusion) - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Deprecated.
- createTypeContext(AnnotationInclusion, SchemaGeneratorConfig) - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Create the a
TypeContext
with the givenAnnotationInclusion
. - createTypeScope(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Construct a
TypeScope
instance for the type. - 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.
- CustomDefinition(ObjectNode, CustomDefinition.DefinitionType, CustomDefinition.AttributeInclusion) - Constructor for class com.github.victools.jsonschema.generator.CustomDefinition
-
Constructor for a custom definition.
- CustomDefinition.AttributeInclusion - Enum in com.github.victools.jsonschema.generator
-
Indication whether the normal attribute collection should be performed and any attributes should be added to the custom definition.
- CustomDefinition.DefinitionType - Enum in com.github.victools.jsonschema.generator
-
Indication whether a custom definition should always be inlined or follow the standard behaviour.
- 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.
- CustomPropertyDefinition - Class in com.github.victools.jsonschema.generator
-
The result of a custom definition look-up for a particular field/method.
- CustomPropertyDefinition(ObjectNode) - Constructor for class com.github.victools.jsonschema.generator.CustomPropertyDefinition
-
Constructor for a custom property definition.
- CustomPropertyDefinition(ObjectNode, CustomDefinition.AttributeInclusion) - Constructor for class com.github.victools.jsonschema.generator.CustomPropertyDefinition
-
Constructor for a custom property definition.
- CustomPropertyDefinitionProvider<M extends MemberScope<?,?>> - 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". - DEFAULT_PROPERTY_ORDER - Static variable in enum com.github.victools.jsonschema.generator.impl.PropertySortUtils
-
Comparator
sorting properties into the following groups and within each group alphabetically by their name. - DefaultSchemaDefinitionNamingStrategy - Class in com.github.victools.jsonschema.generator.naming
-
Default implementation of a
SchemaDefinitionNamingStrategy
using the output ofTypeContext.getSimpleTypeDescription(ResolvedType)
as definition name/key. - DefaultSchemaDefinitionNamingStrategy() - Constructor for class com.github.victools.jsonschema.generator.naming.DefaultSchemaDefinitionNamingStrategy
- DEFINITION_FOR_MAIN_SCHEMA - com.github.victools.jsonschema.generator.Option
-
Whether the schema for the target/main type should be included in the "definitions"/"$defs" – thereby avoiding an potential
"$ref": "#"
and assigning a name to it like for all other defined subschemas. - DefinitionKey - Class in com.github.victools.jsonschema.generator.impl
-
Identifier for a particular sub-schema definition.
- DefinitionKey(ResolvedType, CustomDefinitionProviderV2) - Constructor for class com.github.victools.jsonschema.generator.impl.DefinitionKey
-
Constructor.
- DEFINITIONS_FOR_ALL_OBJECTS - com.github.victools.jsonschema.generator.Option
-
Whether all referenced objects should be listed in the schema's "definitions"/"$defs".
- DEFINITIONS_FOR_MEMBER_SUPERTYPES - com.github.victools.jsonschema.generator.Option
-
Whether a member (field/method), having a declared type for which subtypes are being detected, should be included as standalone definition with any collected member attributes assigned directly – and the subtypes only being handled as generic types – or each of its subtypes should be treated as alternative sub-schema for this member (field/method) including any attributes derived from that member.
- doGetSchemaPropertyName() - Method in class com.github.victools.jsonschema.generator.FieldScope
-
Returns the name to be used to reference this field in its parent's "properties".
- doGetSchemaPropertyName() - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Returns the name to be used to reference this member in its parent's "properties".
- doGetSchemaPropertyName() - Method in class com.github.victools.jsonschema.generator.MethodScope
-
Returns the name to be used to reference this method in its parent's "properties".
- DRAFT_2019_09 - com.github.victools.jsonschema.generator.SchemaVersion
- DRAFT_2020_12 - com.github.victools.jsonschema.generator.SchemaVersion
- DRAFT_6 - com.github.victools.jsonschema.generator.SchemaVersion
- DRAFT_7 - com.github.victools.jsonschema.generator.SchemaVersion
E
- ensureDefinitionKeyIsPlain(String) - Method in class com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils
-
Replace characters in the given definition key that are neither alphanumeric nor a dot, dash or underscore (as expected by OpenAPI).
- ensureDefinitionKeyIsUriCompatible(String) - Method in class com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils
-
Replace characters in the given definition key that are deemed incompatible within a URI (as expected by JSON Schema).
- ENUM_KEYWORD_FOR_SINGLE_VALUES - com.github.victools.jsonschema.generator.Option
-
Whether allowed values should always be included in an
"enum"
keyword. - EnumModule - Class in com.github.victools.jsonschema.generator.impl.module
-
Default module being included for the
Option.ENUM_AS_STRING
. - EnumModule(Function<Enum<?>, String>) - Constructor for class com.github.victools.jsonschema.generator.impl.module.EnumModule
-
Constructor remembering whether to treat enums as plain strings or as objects.
- equals(Object) - Method in class com.github.victools.jsonschema.generator.impl.DefinitionKey
- EXCLUDING_ATTRIBUTES - Static variable in class com.github.victools.jsonschema.generator.CustomDefinition
-
Alternative accessor for
CustomDefinition.AttributeInclusion.NO
. - EXTRA_OPEN_API_FORMAT_VALUES - com.github.victools.jsonschema.generator.Option
-
For the "format" attribute, JSON Schema defines various supported values.
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)
. - FIELDS_DERIVED_FROM_ARGUMENTFREE_METHODS - com.github.victools.jsonschema.generator.Option
-
Whether methods that do not expect any arguments, should be treated as fields: i.e.
- FieldScope - Class in com.github.victools.jsonschema.generator
-
Representation of a single introspected field.
- FieldScope(ResolvedField, ResolvedType, String, ResolvedTypeWithMembers, Integer, 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.
- findSubtypes(ResolvedType, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SubtypeResolver
-
Look-up the subtypes for a given type, that should be listed independently.
- FLATTENED_ENUMS - com.github.victools.jsonschema.generator.Option
-
Whether enums should be treated as plain
SchemaKeyword.TAG_TYPE_STRING
values – derived from their respective constant name. - FLATTENED_ENUMS_FROM_TOSTRING - com.github.victools.jsonschema.generator.Option
-
Whether enums should be treated as plain
SchemaKeyword.TAG_TYPE_STRING
values – derived from their respectivetoString()
. - FLATTENED_OPTIONALS - com.github.victools.jsonschema.generator.Option
-
Whether any
Optional
instance should be treated as nullable value of the wrapped type. - FLATTENED_SUPPLIERS - com.github.victools.jsonschema.generator.Option
-
Whether a
Supplier<T>
instance should be treated as the wrapped typeT
. - 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
-
Constructor declaring
Optional
as the target type to unwrap. - FlattenedWrapperModule<W> - Class in com.github.victools.jsonschema.generator.impl.module
-
Default module being included if
Option.FLATTENED_SUPPLIER
is enabled, but re-usable for other generic wrappers. - FlattenedWrapperModule(Class<W>) - Constructor for class com.github.victools.jsonschema.generator.impl.module.FlattenedWrapperModule
-
Constructor setting the type to unwrap.
- FORBIDDEN_ADDITIONAL_PROPERTIES_BY_DEFAULT - com.github.victools.jsonschema.generator.Option
-
Whether a schema's "additionalProperties" should be set to "false" if no specific configuration says otherwise.
- forbiddenForAllObjectsButContainers() - Static method in class com.github.victools.jsonschema.generator.impl.module.AdditionalPropertiesModule
-
Create module instance that forbids additional properties everywhere but on container types.
- 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. - forMapValues() - Static method in class com.github.victools.jsonschema.generator.impl.module.AdditionalPropertiesModule
-
Create module instance that specifically allows additional properties on
Map
instances. - 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 counterparts (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 allpublic
non-static
fields. - forTransientFields() - Static method in class com.github.victools.jsonschema.generator.impl.module.FieldExclusionModule
- forTypesInGeneral() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Get the part of this configuration builder dedicated to custom attribute look-ups for types in general, independent of the declaration context.
- forVersion(SchemaVersion) - Method in enum com.github.victools.jsonschema.generator.SchemaKeyword
-
Provide the appropriate tag name/value, considering the specified schema version.
- forVoidMethods() - Static method in class com.github.victools.jsonschema.generator.impl.module.MethodExclusionModule
-
Factory method: creating a
MethodExclusionModule
instance that excludes all methods with avoid
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. - get() - Method in class com.github.victools.jsonschema.generator.impl.LazyValue
-
Look-up the wrapped value, loading it on first invocation.
- 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.
- getAnnotation(Class<A>, Predicate<Annotation>) - 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.
- getAnnotation(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MethodScope
-
Return the annotation of the given type on the method or its return type, if such an annotation is present.
- 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>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.FieldScope
- getAnnotationConsideringFieldAndGetter(Class<A>, Predicate<Annotation>) - 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>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MethodScope
- getAnnotationConsideringFieldAndGetterIfSupported(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 and this is not a
fake container item scope
. - getAnnotationConsideringFieldAndGetterIfSupported(Class<A>, Predicate<Annotation>) - 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 and this is not a
fake container item scope
. - getAnnotationFromList(Class<A>, List<Annotation>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Select the instance of the specified annotation type from the given list.
- getAnnotationInclusionOverrides() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- getAnnotationInclusionOverrides() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Provide the explicit rule overrides of when to include particular annotations (e.g., with or without
@Inherited
). - 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.
- getAttributeInclusion() - Method in class com.github.victools.jsonschema.generator.CustomDefinition
-
Getter for the associated extent of additional attributes being collected and applied.
- getConfig() - Method in class com.github.victools.jsonschema.generator.SchemaGenerator
-
Returns the
SchemaGeneratorConfig
associated with thisSchemaGenerator
. - getContainerItemAnnotation(Class<A>) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Return the annotation of the given type on the member's container item (i.e.
- getContainerItemAnnotation(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.FieldScope
- getContainerItemAnnotation(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Return the annotation of the given type on the member's container item (i.e.
- getContainerItemAnnotation(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MethodScope
- getContainerItemAnnotationConsideringFieldAndGetter(Class<A>) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Return the annotation of the given type on the member's container item (i.e.
- getContainerItemAnnotationConsideringFieldAndGetter(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.FieldScope
- getContainerItemAnnotationConsideringFieldAndGetter(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Return the annotation of the given type on the member's container item (i.e.
- getContainerItemAnnotationConsideringFieldAndGetter(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MethodScope
- getContainerItemAnnotationConsideringFieldAndGetterIfSupported(Class<A>) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Return the annotation of the given type on the member's container item (i.e.
- getContainerItemAnnotationConsideringFieldAndGetterIfSupported(Class<A>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Return the annotation of the given type on the member's container item (i.e.
- getContainerItemType() - Method in class com.github.victools.jsonschema.generator.TypeScope
-
Identify the element/item type of the given
SchemaKeyword.TAG_TYPE_ARRAY
. - getContainerItemType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Identify the element/item type of the given
SchemaKeyword.TAG_TYPE_ARRAY
. - getContext() - Method in class com.github.victools.jsonschema.generator.TypeScope
-
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.
- getCustomDefinition(M, SchemaGenerationContext, CustomPropertyDefinitionProvider<M>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- getCustomDefinition(M, SchemaGenerationContext, CustomPropertyDefinitionProvider<M>) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Look-up the non-standard JSON schema definition for a given property.
- getCustomDefinitionProviders() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Getter for the applicable custom property definition provider.
- getCustomDefinitionProviders() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Getter for the applicable custom definition provider.
- 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(DefinitionKey) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
-
Retrieve the previously added definition for the specified type.
- getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.naming.CleanSchemaDefinitionNamingStrategy
- getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.naming.DefaultSchemaDefinitionNamingStrategy
- getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.naming.SchemaDefinitionNamingStrategy
-
Getter for the name/key in the "definitions"/"$defs" to represent the given
DefinitionKey
. - getDefinitionNamingStrategy() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- getDefinitionNamingStrategy() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Getter for the naming strategy to be applied when determining key names in the "definitions"/"$defs".
- getDefinitionNamingStrategy() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Getter for the current naming strategy for keys in the "definitions"/"$defs".
- getDefinitionType() - Method in class com.github.victools.jsonschema.generator.CustomDefinition
-
Getter for the associated definition type.
- getFakeContainerItemIndex() - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Getter for the
fakeContainerItemIndex
(may be null). - 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.
- getFirstDefinedValue(List<ConfigFunction<S, R>>, S) - Static method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Helper function for invoking a given function with the provided inputs or returning null, if all functions return null themselves.
- getFirstDefinedValue(List<BiFunction<S, SchemaGenerationContext, R>>, S, SchemaGenerationContext) - Static method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Helper function for invoking a given function with the provided inputs or returning null, if all functions return null themselves.
- getFullTypeDescription() - Method in class com.github.victools.jsonschema.generator.TypeScope
-
Constructing a string that represents this member's type (including possible type parameters and their actual types) – including package names.
- 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).
- getGeneratorConfig() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- getGeneratorConfig() - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Getter for the applicable configuration.
- getIdentifier() - Method in enum com.github.victools.jsonschema.generator.SchemaVersion
-
Getter for the
$schema
tag's value. - getIgnoredDefinitionProvider() - Method in class com.github.victools.jsonschema.generator.impl.DefinitionKey
-
Getter for the custom definition provider that was the first to be skipped during the generation of the schema definition.
- getImpliedTypes() - Method in enum com.github.victools.jsonschema.generator.SchemaKeyword
-
Determine which (if any) specific
SchemaKeyword.TAG_TYPE
values this keyword implies. - getInstanceAttributeOverrides() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Getter for the applicable instance attribute overrides.
- getKeyword(SchemaKeyword) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
- getKeyword(SchemaKeyword) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- getKeyword(SchemaKeyword) - Method in interface com.github.victools.jsonschema.generator.SchemaGenerationContext
-
Look-up a given keyword's associated tag name or value for the designated JSON Schema version.
- getKeyword(SchemaKeyword) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Getter for the indicated keyword's value in the designated JSON Schema version.
- 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(DefinitionKey) - 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.
- getPropertySorter() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Getter for the sorting algorithm for an object's properties (fields and methods).
- getRawMember() - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Returns the JDK object that represents member.
- getReferences(DefinitionKey) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
-
Getter for the nodes representing not-nullable references to the given type.
- getReverseTagMap(SchemaVersion, Predicate<SchemaKeyword>) - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword
-
Provide a map over all keywords, that represent a schema tag/property, i.e., not a value.
- getSchemaKeywordValue() - Method in enum com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- 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".
- getSchemaVersion() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- getSchemaVersion() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Getter for the designated JSON Schema version.
- 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.TypeScope
-
Constructing a string that represents this member's type (including possible type parameters and their actual types) – excluding package names.
- 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).
- getSubtypeResolvers() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Getter for the applicable subtype resolvers.
- 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.impl.DefinitionKey
-
Getter for the associated java type.
- getType() - Method in class com.github.victools.jsonschema.generator.TypeScope
-
Returns represented type; if there is one, for methods this is the return type and for fields their field type.
- getTypeAnnotationConsideringHierarchy(ResolvedType, Class<A>) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Look-up the given annotation on the targeted type or one of its declared interfaces or super types.
- 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.
- getTypeAttributeOverrides() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Getter for the applicable overrides for type attributes.
- getTypeConsideringHierarchyMatching(ResolvedType, Predicate<ResolvedType>) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Find the (super) type, including interfaces, that fulfils the given condition/check..
- 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.
- getTypeParameterAnnotation(Class<A>, AnnotatedType, Integer) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Deprecated.
- getTypeParameterAnnotation(Class<A>, Predicate<Annotation>, AnnotatedType, Integer) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Return the annotation of the given type from the annotated container's item, if such an annotation is present.
- getTypeParameterAnnotations(AnnotatedType, Integer) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Return the annotations from the annotated container's item.
- getTypeParameterFor(ResolvedType, Class<?>, int) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Find type parameterization for the specified (super) type at return the type parameter at the given index.
- getTypeParameterFor(Class<?>, int) - Method in class com.github.victools.jsonschema.generator.TypeScope
-
Find type parameterization for the specified (super) type at return the type parameter at the given index.
- getTypeWithAnnotation(ResolvedType, Class<? extends Annotation>) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Find the (super) type, including interfaces, that has the designated type annotation.
- getTypeWithAnnotation(ResolvedType, Class<? extends Annotation>, Predicate<Annotation>) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Find the (super) type, including interfaces, that has the designated type annotation.
- 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".
- hashCode() - Method in class com.github.victools.jsonschema.generator.impl.DefinitionKey
- hasMemberWrapperType(MemberScope<?, ?>) - Method in class com.github.victools.jsonschema.generator.impl.module.FlattenedWrapperModule
-
Determine whether the given field/method's declared type is assignable to the targeted wrapper type.
I
- IGNORE_ANNOTATIONS_ON_ANNOTATIONS - Static variable in class com.github.victools.jsonschema.generator.TypeContext
- INCLUDING_ATTRIBUTES - Static variable in class com.github.victools.jsonschema.generator.CustomDefinition
-
Alternative accessor for
CustomDefinition.AttributeInclusion.YES
. - INLINE - com.github.victools.jsonschema.generator.CustomDefinition.DefinitionType
-
Always inline an associated custom definition (with the potential risk of creating infinite loops).
- INLINE_ALL_SCHEMAS - com.github.victools.jsonschema.generator.Option
-
Whether all sub-schemas should be defined in-line, i.e.
- INLINE_DEFINITION - Static variable in class com.github.victools.jsonschema.generator.CustomDefinition
-
Alternative accessor for
CustomDefinition.DefinitionType.INLINE
. - InlineSchemaModule - Class in com.github.victools.jsonschema.generator.impl.module
-
Default module being included if
Option.INLINE_ALL_SCHEMAS
is enabled. - InlineSchemaModule() - Constructor for class com.github.victools.jsonschema.generator.impl.module.InlineSchemaModule
- InstanceAttributeOverride<M extends MemberScope<?,?>> - Interface in com.github.victools.jsonschema.generator
-
Deprecated.use
InstanceAttributeOverrideV2
instead - InstanceAttributeOverrideV2<M extends MemberScope<?,?>> - Interface in com.github.victools.jsonschema.generator
-
Entry point for customising the JSON Schema attributes being collected for a property.
- INTEGER - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- isContainerType() - Method in class com.github.victools.jsonschema.generator.TypeScope
-
Determine whether this targeted type should be treated as
SchemaKeyword.TAG_TYPE_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
SchemaKeyword.TAG_TYPE_ARRAY
in the generated schema. - isDerivingFieldsFromArgumentFreeMethods() - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Getter for the flag indicating whether to derive fields from argument-free methods.
- isFakeContainerItemScope() - Method in class com.github.victools.jsonschema.generator.MemberScope
-
Check whether this field/method scope represents only the container item type of the actual field/method.
- 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
. - isOverriding(Option) - Method in enum com.github.victools.jsonschema.generator.Option
-
Check whether the given option is being ignored if this one enabled.
- 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. - isReadOnly(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- isReadOnly(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Check whether a field/property value is deemed read-only, i.e., may be ignored or rejected when included in a request.
- isReadOnly(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- isReadOnly(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Check whether a method value is deemed read-only, i.e., may be ignored or rejected when included in a request.
- isReadOnly(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Determine whether a given member should be deemed read-only in its declaring type.
- 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. - isWrapperType(ResolvedType) - Method in class com.github.victools.jsonschema.generator.impl.module.FlattenedWrapperModule
-
Check whether the given type is an instance of the predefined wrapper class.
- isWriteOnly(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- isWriteOnly(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Check whether a field/property value is deemed write-only, i.e., is not being returned in responses.
- isWriteOnly(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- isWriteOnly(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Check whether a method value is deemed write-only, i.e., is not being returned in responses.
- isWriteOnly(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Determine whether a given member should be deemed write-only in its declaring type.
J
- JAVA_OBJECT - Static variable in class com.github.victools.jsonschema.generator.OptionPreset
-
Preset: including public fields and all public methods.
L
- LazyValue<T> - Class in com.github.victools.jsonschema.generator.impl
-
Wrapper for a value that should only be lazily initialised when being accessed for the first time.
- LazyValue(Supplier<? extends T>) - Constructor for class com.github.victools.jsonschema.generator.impl.LazyValue
-
Constructor, not yet invoking the given
Supplier
.
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".
- MAP_VALUES_AS_ADDITIONAL_PROPERTIES - com.github.victools.jsonschema.generator.Option
-
Whether a
Map<K, V>
schema's "additionalProperties" should be set to its declared value typeV
. - 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, Integer, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.MemberScope
-
Constructor.
- mergeMissingAttributes(ObjectNode, ObjectNode) - Static method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Merge the second node's attributes into the first, skipping those attributes that are already contained in the first node.
- 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, Integer, 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
- NAMED_SCHEMAS - com.github.victools.jsonschema.generator.SchemaKeyword.TagContent
- NO - com.github.victools.jsonschema.generator.CustomDefinition.AttributeInclusion
-
Skip the attribute collection both for a specific field/method or the type in general if that's the level where this custom definition is being applied.
- NON_SCHEMA - com.github.victools.jsonschema.generator.SchemaKeyword.TagContent
- 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. - NULL - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- NULLABLE_ARRAY_ITEMS_ALLOWED - com.github.victools.jsonschema.generator.Option
-
Whether a container/collection/array item should be subject to the standard nullable checks.
- 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.
- NUMBER - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
O
- OBJECT - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- 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 viaSchemaGeneratorConfigBuilder.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
-
Deprecated.Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.
- overrideInstanceAttributes(ObjectNode, M, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.InstanceAttributeOverride
-
Deprecated.
- overrideInstanceAttributes(ObjectNode, M, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.InstanceAttributeOverrideV2
-
Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to a particular instance.
- overrideTypeAttributes(ObjectNode, TypeScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.TypeAttributeOverride
-
Deprecated.
- overrideTypeAttributes(ObjectNode, TypeScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.TypeAttributeOverrideV2
-
Add/remove attributes on the given JSON Schema node – this is specifically intended for attributes relating to the type in general.
- overrideTypeAttributes(ObjectNode, TypeScope, SchemaGeneratorConfig) - Method in interface com.github.victools.jsonschema.generator.TypeAttributeOverride
-
Deprecated.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_DEFINITION_KEYS - com.github.victools.jsonschema.generator.Option
-
Generally, keys in the collected "definitions"/"$defs" are ensured to be URI compatible but may include parentheses and commas for listing type parameters.
- PLAIN_JSON - Static variable in class com.github.victools.jsonschema.generator.OptionPreset
-
Preset: including private/package/protected/public fields and no methods.
- PropertySortUtils - Enum in com.github.victools.jsonschema.generator.impl
-
Utility class containing the declaration of the default property sort algorithm and its components.
- 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, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.module.InlineSchemaModule
- 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.
- provideCustomSchemaDefinition(M, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.CustomPropertyDefinitionProvider
-
Look-up the non-standard JSON schema definition for a given property.
- 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
- reduceAllOfNodes(List<ObjectNode>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils
-
Remove and merge
SchemaKeyword.TAG_ALLOF
parts when there are no conflicts between the sub-schemas. - reduceAnyOfNodes(List<ObjectNode>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils
-
Reduce nested
SchemaKeyword.TAG_ANYOF
parts when one contains an entry with only anotherSchemaKeyword.TAG_ANYOF
inside. - resetAfterSchemaGenerationFinished() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resetAfterSchemaGenerationFinished() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- resetAfterSchemaGenerationFinished() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- resetAfterSchemaGenerationFinished() - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
- resetAfterSchemaGenerationFinished() - Method in interface com.github.victools.jsonschema.generator.StatefulConfig
-
Method being invoked after the generation of a single "main" type's schema has been completed.
- resolve(Type, Type...) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Resolve actual type (mostly relevant for parameterised types, type variables and such).
- resolveAdditionalProperties(FieldScope, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveAdditionalProperties(FieldScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "additionalProperties" of an object's field/property.
- resolveAdditionalProperties(MethodScope, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveAdditionalProperties(MethodScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "additionalProperties" of a method's return value.
- resolveAdditionalProperties(S, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "additionalProperties" of a given scope/type representation.
- resolveAdditionalPropertiesForType(TypeScope, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveAdditionalPropertiesForType(TypeScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "additionalProperties" of a context-independent type representation.
- resolveAnchor(TypeScope) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Determine the "$anchor" of a context-independent type representation.
- resolveAnchorForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveAnchorForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "$anchor" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "maxItems" of a given scope/type representation.
- resolveArrayMaxItemsForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveArrayMaxItemsForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "maxItems" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "minItems" of a given scope/type representation.
- resolveArrayMinItemsForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveArrayMinItemsForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "minItems" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "uniqueItems" of a given scope/type representation.
- resolveArrayUniqueItemsForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveArrayUniqueItemsForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "uniqueItems" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "default" of a given scope/type representation.
- resolveDefaultForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveDefaultForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "default" value of a context-independent type representation.
- resolveDependentRequires(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveDependentRequires(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "dependentRequired" list of other properties' names, for which a value is required if the given field is present.
- resolveDependentRequires(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveDependentRequires(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "dependentRequired" list of other properties' names, for which a value is required if the given method (or more likely: the field derived from this method) is present.
- resolveDependentRequires(M) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Determine the names of other properties that are required to have a value, if the given member is present.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "description" of a given scope/type representation.
- resolveDescriptionForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveDescriptionForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "description" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "enum"/"const" of a given scope/type representation.
- resolveEnumForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveEnumForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "enum"/"const" of a context-independent type representation.
- resolveId(TypeScope) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Determine the "$id" of a context-independent type representation.
- resolveIdForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveIdForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "$id" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "exclusiveMaximum" of a given scope/type representation.
- resolveNumberExclusiveMaximumForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveNumberExclusiveMaximumForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "exclusiveMaximum" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "exclusiveMinimum" of a given scope/type representation.
- resolveNumberExclusiveMinimumForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveNumberExclusiveMinimumForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "exclusiveMinimum" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "maximum" of a given scope/type representation.
- resolveNumberInclusiveMaximumForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveNumberInclusiveMaximumForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "maximum" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "minimum" of a given scope/type representation.
- resolveNumberInclusiveMinimumForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveNumberInclusiveMinimumForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "minimum" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "multipleOf" of a given scope/type representation.
- resolveNumberMultipleOfForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveNumberMultipleOfForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "multipleOf" of a context-independent type representation.
- resolvePatternProperties(FieldScope, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolvePatternProperties(FieldScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "patternProperties" of an object's field/property.
- resolvePatternProperties(MethodScope, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolvePatternProperties(MethodScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "patternProperties" of a method's return value.
- resolvePatternProperties(S, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "patternProperties" of a given scope/type representation.
- resolvePatternPropertiesForType(TypeScope, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolvePatternPropertiesForType(TypeScope, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "patternProperties" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "format" of a given scope/type representation.
- resolveStringFormatForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveStringFormatForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "format" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "maxLength" of a given scope/type representation.
- resolveStringMaxLengthForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveStringMaxLengthForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "maxLength" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "minLength" of a given scope/type representation.
- resolveStringMinLengthForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveStringMinLengthForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "minLength" of a context-independent type representation.
- 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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "format" of a given scope/type representation.
- resolveStringPatternForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveStringPatternForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "pattern" of a context-independent type representation.
- resolveSubtype(ResolvedType, Class<?>) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Resolve subtype considering the given super-types (potentially) known type parameters.
- resolveSubtypes(ResolvedType, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveSubtypes(ResolvedType, SchemaGenerationContext) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Look-up a declared type's subtypes in order to list those specifically (in an
SchemaKeyword.TAG_ANYOF
). - resolveTargetTypeOverride(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Deprecated.
- resolveTargetTypeOverride(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Deprecated.
- resolveTargetTypeOverrides(FieldScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveTargetTypeOverrides(FieldScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the alternative target types from an object's field/property.
- resolveTargetTypeOverrides(MethodScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveTargetTypeOverrides(MethodScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the alternative target types from a method's return value.
- resolveTargetTypeOverrides(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(S) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Determine the "title" of a given scope/type representation.
- resolveTitleForType(TypeScope) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- resolveTitleForType(TypeScope) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine the "title" of a context-independent type representation.
- resolveWithMembers(ResolvedType) - Method in class com.github.victools.jsonschema.generator.TypeContext
-
Collect a given type's declared fields and methods.
S
- SCHEMA - com.github.victools.jsonschema.generator.SchemaKeyword.TagContent
- SCHEMA_VERSION_INDICATOR - com.github.victools.jsonschema.generator.Option
-
Whether the
SchemaKeyword.TAG_SCHEMA
attribute withSchemaKeyword.TAG_SCHEMA_VALUE
should be included. - SchemaBuilder - Class in com.github.victools.jsonschema.generator
-
Builder for a single schema being generated.
- SchemaCleanUpUtils - Class in com.github.victools.jsonschema.generator.impl
-
Utility for cleaning up generated schemas.
- SchemaCleanUpUtils(SchemaGeneratorConfig) - Constructor for class com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils
-
Constructor.
- SchemaConstants - Interface in com.github.victools.jsonschema.generator
-
Deprecated.this only covers Draft 7; use
SchemaKeyword
instead - SchemaDefinitionNamingStrategy - Interface in com.github.victools.jsonschema.generator.naming
-
Naming strategy for the keys in the "definitions"/"$defs" containing shared/reused subschemas.
- 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
-
Deprecated.
- SchemaGeneratorConfigBuilder(ObjectMapper, OptionPreset) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Deprecated.
- SchemaGeneratorConfigBuilder(ObjectMapper, SchemaVersion) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Constructor of an empty configuration builder.
- SchemaGeneratorConfigBuilder(ObjectMapper, SchemaVersion, OptionPreset) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Constructor of an empty configuration builder.
- SchemaGeneratorConfigBuilder(SchemaVersion) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Constructor of an empty configuration builder with a default
ObjectMapper
instance. - SchemaGeneratorConfigBuilder(SchemaVersion, OptionPreset) - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Constructor of an empty configuration builder with a default
ObjectMapper
instance. - SchemaGeneratorConfigImpl - Class in com.github.victools.jsonschema.generator.impl
-
Default implementation of a schema generator's configuration.
- SchemaGeneratorConfigImpl(ObjectMapper, SchemaVersion, Set<Option>, SchemaGeneratorGeneralConfigPart, SchemaGeneratorConfigPart<FieldScope>, SchemaGeneratorConfigPart<MethodScope>, Map<Class<? extends Annotation>, AnnotationInclusion>) - 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
- SchemaGeneratorGeneralConfigPart - Class in com.github.victools.jsonschema.generator
-
Generic collection of reflection based analysis for populating a JSON Schema targeting a specific type in general.
- SchemaGeneratorGeneralConfigPart() - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- SchemaGeneratorTypeConfigPart<S extends TypeScope> - Class in com.github.victools.jsonschema.generator
-
Generic collection of reflection based analysis for populating a JSON Schema.
- SchemaGeneratorTypeConfigPart() - Constructor for class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
- SchemaKeyword - Enum in com.github.victools.jsonschema.generator
-
JSON Schema properties and their values.
- SchemaKeyword.SchemaType - Enum in com.github.victools.jsonschema.generator
-
Values of the
SchemaKeyword.TAG_TYPE
. - SchemaKeyword.TagContent - Enum in com.github.victools.jsonschema.generator
-
Type of content/values to be expected under a schema tag.
- SchemaVersion - Enum in com.github.victools.jsonschema.generator
-
Supported JSON Schema Versions.
- setAdditionalProperties(ObjectNode, JsonNode, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_ADDITIONAL_PROPERTIES
" attribute. - setAnchor(ObjectNode, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_ANCHOR
" attribute. - setArrayMaxItems(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setArrayMaxItems(ObjectNode, Integer, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_ITEMS_MAX
" attribute. - setArrayMinItems(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setArrayMinItems(ObjectNode, Integer, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_ITEMS_MIN
" attribute. - setArrayUniqueItems(ObjectNode, Boolean) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setArrayUniqueItems(ObjectNode, Boolean, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_ITEMS_UNIQUE
" attribute. - setDefault(ObjectNode, Object) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setDefault(ObjectNode, Object, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_DEFAULT
" attribute. - setDescription(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setDescription(ObjectNode, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_DESCRIPTION
" attribute. - setEnum(ObjectNode, Collection<?>) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setEnum(ObjectNode, Collection<?>, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_CONST
"/"SchemaKeyword.TAG_ENUM
" attribute. - setId(ObjectNode, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_ID
" attribute. - setNumberExclusiveMaximum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setNumberExclusiveMaximum(ObjectNode, BigDecimal, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_MAXIMUM_EXCLUSIVE
" attribute. - setNumberExclusiveMinimum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setNumberExclusiveMinimum(ObjectNode, BigDecimal, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_MINIMUM_EXCLUSIVE
" attribute (considering Draft 7). - setNumberInclusiveMaximum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setNumberInclusiveMaximum(ObjectNode, BigDecimal, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_MAXIMUM
" attribute (considering Draft 7). - setNumberInclusiveMinimum(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setNumberInclusiveMinimum(ObjectNode, BigDecimal, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_MINIMUM
" attribute (considering Draft 7). - setNumberMultipleOf(ObjectNode, BigDecimal) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setNumberMultipleOf(ObjectNode, BigDecimal, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_MULTIPLE_OF
" attribute. - setPatternProperties(ObjectNode, Map<String, JsonNode>, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_PATTERN_PROPERTIES
" attribute. - setReadOnly(ObjectNode, boolean, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_READ_ONLY
" attribute. - setStrictTypeInfo(List<ObjectNode>, boolean) - Method in class com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils
-
Go through all sub-schemas and look for those without a
SchemaKeyword.TAG_TYPE
indication. - setStringFormat(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setStringFormat(ObjectNode, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_FORMAT
" attribute (considering Draft 7). - setStringMaxLength(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setStringMaxLength(ObjectNode, Integer, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_LENGTH_MAX
" attribute (considering Draft 7). - setStringMinLength(ObjectNode, Integer) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setStringMinLength(ObjectNode, Integer, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_LENGTH_MIN
" attribute (considering Draft 7). - setStringPattern(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setStringPattern(ObjectNode, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_PATTERN
" attribute (considering Draft 7). - setTitle(ObjectNode, String) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Deprecated.
- setTitle(ObjectNode, String, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_TITLE
" attribute. - setWriteOnly(ObjectNode, boolean, SchemaGenerationContext) - Method in class com.github.victools.jsonschema.generator.impl.AttributeCollector
-
Setter for "
SchemaKeyword.TAG_WRITE_ONLY
" attribute. - shouldAllowNullableArrayItems() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldAllowNullableArrayItems() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether "fake" container/array items should be subject to the same nullable checks as the actual declared member type.
- shouldAlwaysProduceDefinition() - Method in class com.github.victools.jsonschema.generator.CustomDefinition
-
Getter for the flag indicating whether this custom definition should always be included in the
SchemaKeyword.TAG_DEFINITIONS
even if it occurs only once. - shouldCleanupUnnecessaryAllOfElements() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldCleanupUnnecessaryAllOfElements() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether unnecessary
SchemaKeyword.TAG_ALLOF
elements should be removed and merged into their declaring schema when there are no conflicts between the sub-schemas. - shouldCreateDefinitionForMainSchema() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldCreateDefinitionForMainSchema() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether the schema for the target/main type should be included alongside any "definitions"/"$defs" and be referenced via
"$ref": "#"
if necessary. - 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"/"$defs", even if they only occur once.
- shouldDeriveFieldsFromArgumentFreeMethods() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldDeriveFieldsFromArgumentFreeMethods() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether non-void argument-free "getXyZ"/"isXyZ" methods should be represented by the respective field name "xyZ" by default.
- 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.
- shouldIncludeAttributes() - Method in class com.github.victools.jsonschema.generator.CustomDefinition
- shouldIncludeExtraOpenApiFormatValues() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldIncludeExtraOpenApiFormatValues() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether extra
SchemaKeyword.TAG_FORMAT
values should be included for "simple types". - shouldIncludeSchemaVersionIndicator() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldIncludeSchemaVersionIndicator() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether the
SchemaKeyword.TAG_SCHEMA
attribute withSchemaKeyword.TAG_SCHEMA_VALUE
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.
- shouldIncludeStrictTypeInfo() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldIncludeStrictTypeInfo() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether sub schemas should get the
SchemaKeyword.TAG_TYPE
added implicitly based on other contained tags, if it is missing. - shouldInlineAllSchemas() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldInlineAllSchemas() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether all sub-schemas should be included in-line, even if they occur multiple times, and not in the schema's "definitions"/"$defs".
- shouldNeverInlineDefinition(DefinitionKey) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
-
Determine whether the definition for the given type should always be included in the
SchemaKeyword.TAG_DEFINITIONS
, even if only occurring once. - shouldRepresentSingleAllowedValueAsConst() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldRepresentSingleAllowedValueAsConst() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether a single allowed values should be represented by a
SchemaKeyword.TAG_CONST
. - shouldTransparentlyResolveSubtypesOfMembers() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldTransparentlyResolveSubtypesOfMembers() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether a member (field/method), having a declared type for which subtypes are being detected, should be merely a collection of its subtype schemas – each being treated like the member had declared the subtype directly – or whether it should be included as standalone definition with any collected member attributes assigned directly and the subtypes only being handled as generic types.
- shouldUsePlainDefinitionKeys() - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- shouldUsePlainDefinitionKeys() - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Determine whether the
SchemaKeyword.TAG_REF
values should not just be URI compatible (as expected in JSON Schemas). - 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
SchemaKeyword.TAG_TYPE_OBJECT
, with all methods butname()
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. - SORT_PROPERTIES_BY_NAME_ALPHABETICALLY - Static variable in enum com.github.victools.jsonschema.generator.impl.PropertySortUtils
-
Comparator
sorting properties: alphabetically by their name. - SORT_PROPERTIES_FIELDS_BEFORE_METHODS - Static variable in enum com.github.victools.jsonschema.generator.impl.PropertySortUtils
-
Comparator
sorting properties: with fields before methods. - sortProperties(MemberScope<?, ?>, MemberScope<?, ?>) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGeneratorConfigImpl
- sortProperties(MemberScope<?, ?>, MemberScope<?, ?>) - Method in interface com.github.victools.jsonschema.generator.SchemaGeneratorConfig
-
Implementation of the
Comparator.compare(Object, Object)
interface method to determine the order of fields and methods in an object's"properties"
. - STANDARD - com.github.victools.jsonschema.generator.CustomDefinition.DefinitionType
-
Follow the standard behaviour of being moved into the
SchemaKeyword.TAG_DEFINITIONS
if it is being referenced multiple times orOption.DEFINITIONS_FOR_ALL_OBJECTS
is enabled. - StatefulConfig - Interface in com.github.victools.jsonschema.generator
-
Type of configuration (or an aspect of it), that may change during a schema generation and7or remember some kind of state.
- STATIC_METHODS - com.github.victools.jsonschema.generator.Option
-
Whether methods that are
static
should be included. - STRICT_TYPE_INFO - com.github.victools.jsonschema.generator.Option
-
Whether at the end of the schema generation, all sub-schemas without an explicit "type" indication should be augmented by the implied "type" based on the other tags in the respective schema.
- STRING - com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
- SubtypeResolver - Interface in com.github.victools.jsonschema.generator
-
Resolver for looking up a declared type's subtypes in order to list those specifically (in an
SchemaKeyword.TAG_ANYOF
). - supportsContentType(SchemaKeyword.TagContent) - Method in enum com.github.victools.jsonschema.generator.SchemaKeyword
-
Indicate whether the given kind of values can be expected under this keyword (if it represents a tag).
T
- TAG_ADDITIONAL_PROPERTIES - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ADDITIONAL_PROPERTIES - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ALLOF - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ALLOF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ANCHOR - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_2019_09
. - TAG_ANYOF - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ANYOF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_CONST - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_CONST - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_DEFAULT - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_DEFAULT - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_DEFINITIONS - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_DEFINITIONS - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_DEPENDENT_REQUIRED - com.github.victools.jsonschema.generator.SchemaKeyword
-
Prior to
SchemaVersion.DRAFT_2019_09
, this had the same name asSchemaKeyword.TAG_DEPENDENT_SCHEMAS
. - TAG_DEPENDENT_SCHEMAS - com.github.victools.jsonschema.generator.SchemaKeyword
-
Prior to
SchemaVersion.DRAFT_2019_09
, this had the same name asSchemaKeyword.TAG_DEPENDENT_REQUIRED
. - TAG_DESCRIPTION - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_DESCRIPTION - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ELSE - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_7
. - TAG_ENUM - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ENUM - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_FORMAT - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_FORMAT - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ID - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_IF - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_7
. - TAG_ITEMS - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ITEMS - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ITEMS_MAX - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ITEMS_MAX - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ITEMS_MIN - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ITEMS_MIN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_ITEMS_UNIQUE - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ITEMS_UNIQUE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_LENGTH_MAX - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_LENGTH_MAX - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_LENGTH_MIN - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_LENGTH_MIN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_MAXIMUM - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_MAXIMUM - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_MAXIMUM_EXCLUSIVE - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_MAXIMUM_EXCLUSIVE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_MINIMUM - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_MINIMUM - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_MINIMUM_EXCLUSIVE - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_MINIMUM_EXCLUSIVE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_MULTIPLE_OF - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_MULTIPLE_OF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_NOT - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ONEOF - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_ONEOF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_PATTERN - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_PATTERN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_PATTERN_PROPERTIES - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_PATTERN_PROPERTIES - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_PREFIX_ITEMS - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_2019_09
. - TAG_PROPERTIES - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_PROPERTIES - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_PROPERTIES_MAX - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_PROPERTIES_MIN - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_READ_ONLY - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_7
. - TAG_REF - com.github.victools.jsonschema.generator.SchemaKeyword
-
Before
SchemaVersion.DRAFT_2019_09
all other properties in the same sub-schema besides this one were ignored. - TAG_REF - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_REF_MAIN - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_REF_MAIN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_REF_PREFIX - com.github.victools.jsonschema.generator.SchemaKeyword
-
Deprecated.is now implicitly created based on
SchemaKeyword.TAG_DEFINITIONS
or an explicit alternative definitions path - TAG_REF_PREFIX - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_REQUIRED - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_REQUIRED - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_SCHEMA - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_SCHEMA - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_SCHEMA_DRAFT7 - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_SCHEMA_VALUE - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_THEN - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_7
. - TAG_TITLE - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TITLE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_ARRAY - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_ARRAY - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_BOOLEAN - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_BOOLEAN - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_INTEGER - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_INTEGER - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_NULL - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_NULL - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_NUMBER - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_NUMBER - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_OBJECT - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_OBJECT - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_TYPE_STRING - com.github.victools.jsonschema.generator.SchemaKeyword
- TAG_TYPE_STRING - Static variable in interface com.github.victools.jsonschema.generator.SchemaConstants
-
Deprecated.
- TAG_UNEVALUATED_ITEMS - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_2019_09
. - TAG_UNEVALUATED_PROPERTIES - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_2019_09
. - TAG_WRITE_ONLY - com.github.victools.jsonschema.generator.SchemaKeyword
-
Beware that this keyword was only introduced in
SchemaVersion.DRAFT_7
. - toString() - Method in class com.github.victools.jsonschema.generator.MemberScope
- toString() - Method in class com.github.victools.jsonschema.generator.TypeScope
- TRANSIENT_FIELDS - com.github.victools.jsonschema.generator.Option
-
Whether
transient
fields should be included. - traverseGenericType(ResolvedType, ObjectNode, boolean) - Method in class com.github.victools.jsonschema.generator.impl.SchemaGenerationContextImpl
-
Preparation Step: add the given targetType.
- TypeAttributeOverride - Interface in com.github.victools.jsonschema.generator
-
Deprecated.use
TypeAttributeOverrideV2
instead - TypeAttributeOverrideV2 - Interface in com.github.victools.jsonschema.generator
-
Entry point for customising the JSON Schema attributes being collected for a type in general, 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
-
Deprecated.
- TypeContext(AnnotationConfiguration, SchemaGeneratorConfig) - Constructor for class com.github.victools.jsonschema.generator.TypeContext
-
Constructor.
- TypeContextFactory - Enum in com.github.victools.jsonschema.generator.impl
-
Factory class for creating
TypeContext
instances. - TypeScope - Class in com.github.victools.jsonschema.generator
-
Representation of a single type to represent as (sub) schema.
- TypeScope(ResolvedType, TypeContext) - Constructor for class com.github.victools.jsonschema.generator.TypeScope
-
Constructor.
V
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.CustomDefinition.AttributeInclusion
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.CustomDefinition.DefinitionType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.impl.PropertySortUtils
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.Option
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword.TagContent
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.github.victools.jsonschema.generator.SchemaVersion
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.github.victools.jsonschema.generator.CustomDefinition.AttributeInclusion
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.victools.jsonschema.generator.CustomDefinition.DefinitionType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.victools.jsonschema.generator.impl.PropertySortUtils
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.victools.jsonschema.generator.impl.TypeContextFactory
-
Returns an array containing the constants of this enum type, in the order they are declared.
- 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() - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword.SchemaType
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword.TagContent
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.victools.jsonschema.generator.SchemaKeyword
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.github.victools.jsonschema.generator.SchemaVersion
-
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
-
Deprecated.
- 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
-
Deprecated.
- withAdditionalPropertiesResolver(ConfigFunction<TypeScope, Type>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withAdditionalPropertiesResolver(ConfigFunction<M, Type>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withAdditionalPropertiesResolver(ConfigFunction<S, Type>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "additionalProperties" resolver.
- withAdditionalPropertiesResolver(BiFunction<TypeScope, SchemaGenerationContext, JsonNode>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withAdditionalPropertiesResolver(BiFunction<M, SchemaGenerationContext, JsonNode>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withAdditionalPropertiesResolver(BiFunction<S, SchemaGenerationContext, JsonNode>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "additionalProperties" resolver.
- withAnchorResolver(ConfigFunction<TypeScope, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Setter for "$anchor" resolver.
- withAnnotationInclusionOverride(Class<? extends Annotation>, AnnotationInclusion) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Register an explicit annotation inclusion rule for a given annotation type.
- withArrayMaxItemsResolver(ConfigFunction<TypeScope, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withArrayMaxItemsResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withArrayMaxItemsResolver(ConfigFunction<S, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "maxItems" resolver.
- withArrayMinItemsResolver(ConfigFunction<TypeScope, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withArrayMinItemsResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withArrayMinItemsResolver(ConfigFunction<S, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "minItems" resolver.
- withArrayUniqueItemsResolver(ConfigFunction<TypeScope, Boolean>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withArrayUniqueItemsResolver(ConfigFunction<M, Boolean>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withArrayUniqueItemsResolver(ConfigFunction<S, Boolean>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
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: "
SchemaKeyword.TAG_TYPE_BOOLEAN
". - withCustomDefinitionProvider(CustomDefinitionProviderV2) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Adding a custom schema provider – if it returns null for a given type, the next definition provider will be applied.
- withCustomDefinitionProvider(CustomPropertyDefinitionProvider<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Adding a custom schema provider – if it returns null for a given type, the next definition provider will be applied.
- withDefaultResolver(ConfigFunction<TypeScope, Object>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withDefaultResolver(ConfigFunction<M, Object>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withDefaultResolver(ConfigFunction<S, Object>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "default" resolver.
- withDefinitionNamingStrategy(SchemaDefinitionNamingStrategy) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Replacing the current naming strategy for keys in the "definitions"/"$defs".
- withDependentRequiresResolver(ConfigFunction<M, List<String>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Setter for resolver, that collects the names of other properties that are required depending on the targeted one.
- withDescriptionResolver(ConfigFunction<TypeScope, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withDescriptionResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withDescriptionResolver(ConfigFunction<S, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "description" resolver.
- withEmptySchema(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule
-
Add the given mapping for a (simple) java class that should be represented by an empty schema.
- withEnumResolver(ConfigFunction<TypeScope, Collection<?>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withEnumResolver(ConfigFunction<M, Collection<?>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withEnumResolver(ConfigFunction<S, Collection<?>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "enum"/"const" resolver.
- withIdResolver(ConfigFunction<TypeScope, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Setter for "$id" 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
-
Deprecated.
- withInstanceAttributeOverride(InstanceAttributeOverrideV2<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: "
SchemaKeyword.TAG_TYPE_INTEGER
". - withIntegerType(Class<?>, String) - 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: "
SchemaKeyword.TAG_TYPE_INTEGER
". - withNullableCheck(ConfigFunction<M, Boolean>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Setter for nullable check.
- withNumberExclusiveMaximumResolver(ConfigFunction<TypeScope, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withNumberExclusiveMaximumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withNumberExclusiveMaximumResolver(ConfigFunction<S, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "exclusiveMaximum" resolver.
- withNumberExclusiveMinimumResolver(ConfigFunction<TypeScope, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withNumberExclusiveMinimumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withNumberExclusiveMinimumResolver(ConfigFunction<S, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "exclusiveMinimum" resolver.
- withNumberInclusiveMaximumResolver(ConfigFunction<TypeScope, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withNumberInclusiveMaximumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withNumberInclusiveMaximumResolver(ConfigFunction<S, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "maximum" resolver.
- withNumberInclusiveMinimumResolver(ConfigFunction<TypeScope, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withNumberInclusiveMinimumResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withNumberInclusiveMinimumResolver(ConfigFunction<S, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "minimum" resolver.
- withNumberMultipleOfResolver(ConfigFunction<TypeScope, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withNumberMultipleOfResolver(ConfigFunction<M, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withNumberMultipleOfResolver(ConfigFunction<S, BigDecimal>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
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
SchemaKeyword.TAG_TYPE_NUMBER
. - withNumberType(Class<?>, String) - 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
SchemaKeyword.TAG_TYPE_NUMBER
. - withObjectMapper(ObjectMapper) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder
-
Register a custom
ObjectMapper
to create object and array nodes for the JSON structure being generated. - withObjectType(Class<?>) - Method in class com.github.victools.jsonschema.generator.impl.module.SimpleTypeModule
-
Deprecated.rather use
SimpleTypeModule.withEmptySchema(Class)
instead to really allow any value - 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
- withPatternPropertiesResolver(ConfigFunction<TypeScope, Map<String, Type>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withPatternPropertiesResolver(ConfigFunction<M, Map<String, Type>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withPatternPropertiesResolver(ConfigFunction<S, Map<String, Type>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "patternProperties" resolver.
- withPatternPropertiesResolver(BiFunction<TypeScope, SchemaGenerationContext, Map<String, JsonNode>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withPatternPropertiesResolver(BiFunction<M, SchemaGenerationContext, Map<String, JsonNode>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withPatternPropertiesResolver(BiFunction<S, SchemaGenerationContext, Map<String, JsonNode>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "patternProperties" resolver.
- 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.
- withPropertySorter(Comparator<MemberScope<?, ?>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Replacing the current sorting algorithm of properties (fields and methods).
- withReadOnlyCheck(Predicate<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Setter for read-only check.
- withRequiredCheck(Predicate<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Setter for required check.
- withStringFormatResolver(ConfigFunction<TypeScope, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withStringFormatResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withStringFormatResolver(ConfigFunction<S, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "format" resolver.
- withStringMaxLengthResolver(ConfigFunction<TypeScope, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withStringMaxLengthResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withStringMaxLengthResolver(ConfigFunction<S, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "maxLength" resolver.
- withStringMinLengthResolver(ConfigFunction<TypeScope, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withStringMinLengthResolver(ConfigFunction<M, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withStringMinLengthResolver(ConfigFunction<S, Integer>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "minLength" resolver.
- withStringPatternResolver(ConfigFunction<TypeScope, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withStringPatternResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withStringPatternResolver(ConfigFunction<S, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
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: "
SchemaKeyword.TAG_TYPE_STRING
". - withStringType(Class<?>, String) - 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: "
SchemaKeyword.TAG_TYPE_STRING
". - withSubtypeResolver(SubtypeResolver) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Adding a subtype resolver – if it returns null for a given type, the next subtype resolver will be applied.
- withTargetTypeOverrideResolver(ConfigFunction<M, ResolvedType>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Deprecated.
- withTargetTypeOverridesResolver(ConfigFunction<M, List<ResolvedType>>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Setter for target type resolver, expecting the respective member as input.
- withTitleResolver(ConfigFunction<TypeScope, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
- withTitleResolver(ConfigFunction<M, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
- withTitleResolver(ConfigFunction<S, String>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorTypeConfigPart
-
Setter for "title" resolver.
- withTypeAttributeOverride(TypeAttributeOverrideV2) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorGeneralConfigPart
-
Adding an override for type attributes – all of the registered overrides will be applied in the order of having been added.
- withWriteOnlyCheck(Predicate<M>) - Method in class com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart
-
Setter for write-only check.
Y
- YES - com.github.victools.jsonschema.generator.CustomDefinition.AttributeInclusion
-
Collect and add attributes both for a specific field/method as well as for the associated type in general.
All Classes All Packages