Package com.github.victools.jsonschema.generator.naming

Class CleanSchemaDefinitionNamingStrategy

java.lang.Object

com.github.victools.jsonschema.generator.naming.CleanSchemaDefinitionNamingStrategy

All Implemented Interfaces:

SchemaDefinitionNamingStrategy, StatefulConfig

public class CleanSchemaDefinitionNamingStrategy
extends Object
implements SchemaDefinitionNamingStrategy

Wrapper for a SchemaDefinitionNamingStrategy that performs a specific clean-up task on all returned values.

Constructor Summary

Constructors

Constructor	Description
CleanSchemaDefinitionNamingStrategy(SchemaDefinitionNamingStrategy strategy, Function<String,String> cleanUpTask)	Constructor expecting a naming strategy to be wrapped and the applicable clean-up task.

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.victools.jsonschema.generator.StatefulConfig

resetAfterSchemaGenerationFinished

Constructor Detail

CleanSchemaDefinitionNamingStrategy

public CleanSchemaDefinitionNamingStrategy(SchemaDefinitionNamingStrategy strategy,
                                           Function<String,String> cleanUpTask)

Constructor expecting a naming strategy to be wrapped and the applicable clean-up task.

Parameters:

strategy - definition naming strategy to be wrapped

cleanUpTask - task discarding/replacing illegal characters

Method Detail

getDefinitionNameForKey

public String getDefinitionNameForKey(DefinitionKey key,
                                      SchemaGenerationContext generationContext)

Description copied from interface: SchemaDefinitionNamingStrategy

Getter for the name/key in the "definitions"/"$defs" to represent the given DefinitionKey.

Specified by:

getDefinitionNameForKey in interface SchemaDefinitionNamingStrategy

Parameters:

key - definition reference for a type (there may be multiple different keys for the same type if custom definitions are involved)

generationContext - generation context providing access to the applied configuration and type context

Returns:

name/key in "definitions"/"$defs" for the indicated subschema

See Also:

SchemaGenerationContext.getGeneratorConfig(), SchemaGenerationContext.getTypeContext()

adjustDuplicateNames

public void adjustDuplicateNames(Map<DefinitionKey,String> subschemasWithDuplicateNames,
                                 SchemaGenerationContext generationContext)

Description copied from interface: 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.
By default, a numeric counter is appended after a separating dash to each duplicate name.

Specified by:

adjustDuplicateNames in interface SchemaDefinitionNamingStrategy

Parameters:

subschemasWithDuplicateNames - definition references that initially have the same values that should be adjusted

generationContext - generation context providing access to the applied configuration and type context

See Also:

SchemaDefinitionNamingStrategy.getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext)

adjustNullableName

public String adjustNullableName(DefinitionKey key,
                                 String definitionName,
                                 SchemaGenerationContext generationContext)

Description copied from interface: SchemaDefinitionNamingStrategy

Provide an alternative definition name for the given key and name when it is nullable.
By default, a "-nullable" suffix will be appended.

Specified by:

adjustNullableName in interface SchemaDefinitionNamingStrategy

Parameters:

key - definition reference for a type (there may be multiple different keys for the same type if custom definitions are involved)

definitionName - previous result of SchemaDefinitionNamingStrategy.getDefinitionNameForKey(DefinitionKey, SchemaGenerationContext) to be adjusted

generationContext - generation context providing access to the applied configuration and type context

Returns:

adjusted definition name