Uses of Class
com.github.victools.jsonschema.generator.FieldScope

Packages that use FieldScope

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

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

Methods in com.github.victools.jsonschema.generator that return FieldScope

Modifier and Type	Method	Description
FieldScope	FieldScope.asFakeContainerItemScope()
FieldScope	TypeContext.createFieldScope(com.fasterxml.classmate.members.ResolvedField field, com.fasterxml.classmate.ResolvedTypeWithMembers declaringTypeMembers)	Deprecated. use TypeContext.createFieldScope(ResolvedField, MemberScope.DeclarationDetails) instead
FieldScope	TypeContext.createFieldScope(com.fasterxml.classmate.members.ResolvedField field, MemberScope.DeclarationDetails declarationDetails)	Construct a FieldScope instance for the given field.
FieldScope	MethodScope.findGetterField()	Look-up the field associated with this method if it is deemed to be a getter by convention.
FieldScope	FieldScope.withOverriddenName(String overriddenName)
FieldScope	FieldScope.withOverriddenType(com.fasterxml.classmate.ResolvedType overriddenType)

Methods in com.github.victools.jsonschema.generator that return types with arguments of type FieldScope

Modifier and Type	Method	Description
SchemaGeneratorConfigPart<FieldScope>	SchemaGeneratorConfigBuilder.forFields()	Get the part of this configuration builder dedicated to custom attribute look-ups for fields.
List<InstanceAttributeOverrideV2<FieldScope>>	SchemaGeneratorConfig.getFieldAttributeOverrides()	Getter for the applicable instance attribute overrides for fields.

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

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContext.createStandardDefinition(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)	Create a standard definition for the given property.
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContext.createStandardDefinitionReference(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)	Create a standard definition for the given property.
boolean	SchemaGeneratorConfig.isNullable(FieldScope field)	Check whether a field/property is nullable.
boolean	SchemaGeneratorConfig.isReadOnly(FieldScope field)	Check whether a field/property value is deemed read-only, i.e., may be ignored or rejected when included in a request.
boolean	SchemaGeneratorConfig.isRequired(FieldScope field)	Check whether a field/property value is required.
boolean	SchemaGeneratorConfig.isWriteOnly(FieldScope field)	Check whether a field/property value is deemed write-only, i.e., is not being returned in responses.
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfig.resolveAdditionalProperties(FieldScope field, SchemaGenerationContext context)	Determine the "additionalProperties" of an object's field/property.
Integer	SchemaGeneratorConfig.resolveArrayMaxItems(FieldScope field)	Determine the "maxItems" of an object's field/property.
Integer	SchemaGeneratorConfig.resolveArrayMinItems(FieldScope field)	Determine the "minItems" of an object's field/property.
Boolean	SchemaGeneratorConfig.resolveArrayUniqueItems(FieldScope field)	Determine the "uniqueItems" of an object's field/property.
Object	SchemaGeneratorConfig.resolveDefault(FieldScope field)	Determine the "default" value of an object's field/property.
List<String>	SchemaGeneratorConfig.resolveDependentRequires(FieldScope field)	Determine the "dependentRequired" list of other properties' names, for which a value is required if the given field is present.
String	SchemaGeneratorConfig.resolveDescription(FieldScope field)	Determine the "description" of an object's field/property.
Collection<?>	SchemaGeneratorConfig.resolveEnum(FieldScope field)	Determine the "enum"/"const" of an object's field/property.
BigDecimal	SchemaGeneratorConfig.resolveNumberExclusiveMaximum(FieldScope field)	Determine the "exclusiveMaximum" of an object's field/property.
BigDecimal	SchemaGeneratorConfig.resolveNumberExclusiveMinimum(FieldScope field)	Determine the "exclusiveMinimum" of an object's field/property.
BigDecimal	SchemaGeneratorConfig.resolveNumberInclusiveMaximum(FieldScope field)	Determine the "maximum" of an object's field/property.
BigDecimal	SchemaGeneratorConfig.resolveNumberInclusiveMinimum(FieldScope field)	Determine the "minimum" of an object's field/property.
BigDecimal	SchemaGeneratorConfig.resolveNumberMultipleOf(FieldScope field)	Determine the "multipleOf" of an object's field/property.
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfig.resolvePatternProperties(FieldScope field, SchemaGenerationContext context)	Determine the "patternProperties" of an object's field/property.
String	SchemaGeneratorConfig.resolvePropertyNameOverride(FieldScope field)	Determine the alternative name in a parent JSON Schema's "properties" from an object's field/property.
String	SchemaGeneratorConfig.resolveStringFormat(FieldScope field)	Determine the "format" of an object's field/property.
Integer	SchemaGeneratorConfig.resolveStringMaxLength(FieldScope field)	Determine the "maxLength" of an object's field/property.
Integer	SchemaGeneratorConfig.resolveStringMinLength(FieldScope field)	Determine the "minLength" of an object's field/property.
String	SchemaGeneratorConfig.resolveStringPattern(FieldScope field)	Determine the "pattern" of an object's field/property.
default com.fasterxml.classmate.ResolvedType	SchemaGeneratorConfig.resolveTargetTypeOverride(FieldScope field)	Deprecated. use SchemaGeneratorConfig.resolveTargetTypeOverrides(FieldScope) instead
List<com.fasterxml.classmate.ResolvedType>	SchemaGeneratorConfig.resolveTargetTypeOverrides(FieldScope field)	Determine the alternative target types from an object's field/property.
String	SchemaGeneratorConfig.resolveTitle(FieldScope field)	Determine the "title" of an object's field/property.
boolean	SchemaGeneratorConfig.shouldIgnore(FieldScope field)	Check whether a field/property should be ignored.

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

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContext.createStandardDefinition(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)	Create a standard definition for the given property.
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContext.createStandardDefinitionReference(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)	Create a standard definition for the given property.
<R> R	TypeContext.performActionOnMember(MemberScope<?,?> member, Function<FieldScope,R> fieldAction, Function<MethodScope,R> methodAction)	Helper function to write generic code that targets either a FieldScope or MethodScope.

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

Methods in com.github.victools.jsonschema.generator.impl that return types with arguments of type FieldScope

Modifier and Type	Method	Description
List<InstanceAttributeOverrideV2<FieldScope>>	SchemaGeneratorConfigImpl.getFieldAttributeOverrides()

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

Modifier and Type	Method	Description
static com.fasterxml.jackson.databind.node.ObjectNode	AttributeCollector.collectFieldAttributes(FieldScope field, SchemaGenerationContext generationContext)	Collect a field's contextual attributes (i.e.
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContextImpl.createStandardDefinition(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContextImpl.createStandardDefinitionReference(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)
boolean	SchemaGeneratorConfigImpl.isNullable(FieldScope field)
boolean	SchemaGeneratorConfigImpl.isReadOnly(FieldScope field)
boolean	SchemaGeneratorConfigImpl.isRequired(FieldScope field)
boolean	SchemaGeneratorConfigImpl.isWriteOnly(FieldScope field)
com.fasterxml.jackson.databind.JsonNode	SchemaGeneratorConfigImpl.resolveAdditionalProperties(FieldScope field, SchemaGenerationContext context)
Integer	SchemaGeneratorConfigImpl.resolveArrayMaxItems(FieldScope field)
Integer	SchemaGeneratorConfigImpl.resolveArrayMinItems(FieldScope field)
Boolean	SchemaGeneratorConfigImpl.resolveArrayUniqueItems(FieldScope field)
Object	SchemaGeneratorConfigImpl.resolveDefault(FieldScope field)
List<String>	SchemaGeneratorConfigImpl.resolveDependentRequires(FieldScope field)
String	SchemaGeneratorConfigImpl.resolveDescription(FieldScope field)
Collection<?>	SchemaGeneratorConfigImpl.resolveEnum(FieldScope field)
BigDecimal	SchemaGeneratorConfigImpl.resolveNumberExclusiveMaximum(FieldScope field)
BigDecimal	SchemaGeneratorConfigImpl.resolveNumberExclusiveMinimum(FieldScope field)
BigDecimal	SchemaGeneratorConfigImpl.resolveNumberInclusiveMaximum(FieldScope field)
BigDecimal	SchemaGeneratorConfigImpl.resolveNumberInclusiveMinimum(FieldScope field)
BigDecimal	SchemaGeneratorConfigImpl.resolveNumberMultipleOf(FieldScope field)
Map<String,com.fasterxml.jackson.databind.JsonNode>	SchemaGeneratorConfigImpl.resolvePatternProperties(FieldScope field, SchemaGenerationContext context)
String	SchemaGeneratorConfigImpl.resolvePropertyNameOverride(FieldScope field)
String	SchemaGeneratorConfigImpl.resolveStringFormat(FieldScope field)
Integer	SchemaGeneratorConfigImpl.resolveStringMaxLength(FieldScope field)
Integer	SchemaGeneratorConfigImpl.resolveStringMinLength(FieldScope field)
String	SchemaGeneratorConfigImpl.resolveStringPattern(FieldScope field)
List<com.fasterxml.classmate.ResolvedType>	SchemaGeneratorConfigImpl.resolveTargetTypeOverrides(FieldScope field)
String	SchemaGeneratorConfigImpl.resolveTitle(FieldScope field)
boolean	SchemaGeneratorConfigImpl.shouldIgnore(FieldScope field)

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

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContextImpl.createStandardDefinition(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)
com.fasterxml.jackson.databind.node.ObjectNode	SchemaGenerationContextImpl.createStandardDefinitionReference(FieldScope targetScope, CustomPropertyDefinitionProvider<FieldScope> ignoredDefinitionProvider)

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

Constructor

Description

SchemaGeneratorConfigImpl(com.fasterxml.jackson.databind.ObjectMapper objectMapper, SchemaVersion schemaVersion, Set<Option> enabledOptions, SchemaGeneratorGeneralConfigPart typesInGeneralConfigPart, SchemaGeneratorConfigPart<FieldScope> fieldConfigPart, SchemaGeneratorConfigPart<MethodScope> methodConfigPart, Map<Class<? extends Annotation>,com.fasterxml.classmate.AnnotationInclusion> inclusionOverrides)

Constructor of a configuration instance.

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

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

Constructor	Description
AdditionalPropertiesModule(ConfigFunction<TypeScope,Type> generalAdditionalPropertiesResolver, BiFunction<FieldScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> fieldAdditionalPropertiesResolver, BiFunction<MethodScope,SchemaGenerationContext,com.fasterxml.jackson.databind.JsonNode> methodAdditionalPropertiesResolver)	Constructor.
FieldExclusionModule(Predicate<FieldScope> shouldExcludeFieldsMatching)	Constructor setting the underlying check to be set via SchemaGeneratorConfigPart.withIgnoreCheck(Predicate).