Class DefinitionKey

java.lang.Object
com.github.victools.jsonschema.generator.impl.DefinitionKey

public class DefinitionKey extends Object
Identifier for a particular sub-schema definition. This consists of the encountered type as well as some contextual information, as there may be multiple alternative definitions (e.g. a standard definition and one or multiple custom definitions) for a single type.
  • Constructor Details

    • DefinitionKey

      protected DefinitionKey(com.fasterxml.classmate.ResolvedType type, CustomDefinitionProviderV2 ignoredDefinitionProvider)
      Constructor.
      Parameters:
      type - encountered type a schema definition is associated with
      ignoredDefinitionProvider - first custom definition provider that was ignored when creating the definition (is null in most cases)
  • Method Details

    • getType

      public com.fasterxml.classmate.ResolvedType getType()
      Getter for the associated java type.
      Returns:
      encountered type a schema definition is associated with
    • getIgnoredDefinitionProvider

      public CustomDefinitionProviderV2 getIgnoredDefinitionProvider()
      Getter for the custom definition provider that was the first to be skipped during the generation of the schema definition. Ignoring a custom definition provider allows for the next custom definition provider to be applied, or if there is none or no custom definition is returned: falling-back on the standard definition for the targeted type.
      Returns:
      first custom definition provider that was ignored when creating the definition (is null in most cases)
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object