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

Enum Class TypeContextFactory

java.lang.Object
java.lang.Enum<TypeContextFactory>
com.github.victools.jsonschema.generator.impl.TypeContextFactory
All Implemented Interfaces:
Serializable, Comparable<TypeContextFactory>, Constable
public enum TypeContextFactory extends Enum<TypeContextFactory>
Factory class for creating TypeContext instances.

  • Method Details

    • values

      public static TypeContextFactory[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static TypeContextFactory valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • createDefaultTypeContext

      @Deprecated public static TypeContext createDefaultTypeContext()
      Deprecated.
      use createDefaultTypeContext(SchemaGeneratorConfig) instead
      Create the default TypeContext with AnnotationInclusion.INCLUDE_AND_INHERIT_IF_INHERITED.
      This is equivalent to calling: TypeContextFactory.createTypeContext(AnnotationInclusion.INCLUDE_AND_INHERIT_IF_INHERITED)
      Returns:
      created TypeContext instance

    • createDefaultTypeContext

      public static TypeContext createDefaultTypeContext(SchemaGeneratorConfig config)
      Create the default TypeContext with AnnotationInclusion.INCLUDE_AND_INHERIT_IF_INHERITED.
      This is equivalent to calling: TypeContextFactory.createTypeContext(AnnotationInclusion.INCLUDE_AND_INHERIT_IF_INHERITED)
      Parameters:
      config - configuration to consider
      Returns:
      created TypeContext instance

    • createTypeContext

      @Deprecated public static TypeContext createTypeContext(com.fasterxml.classmate.AnnotationInclusion annotationInclusion)
      Deprecated.
      use createTypeContext(AnnotationInclusion, SchemaGeneratorConfig) instead
      Create the a TypeContext with the given AnnotationInclusion.
      This is equivalent to calling: TypeContextFactory.createTypeContext(new AnnotationConfiguration.StdConfiguration(annotationInclusion))
      Parameters:
      annotationInclusion - indication which annotations to include during type resolution/introspection
      Returns:
      created TypeContext instance

    • createTypeContext

      public static TypeContext createTypeContext(com.fasterxml.classmate.AnnotationInclusion annotationInclusion, SchemaGeneratorConfig config)
      Create the a TypeContext with the given AnnotationInclusion.
      This is equivalent to calling: TypeContextFactory.createTypeContext(new AnnotationConfiguration.StdConfiguration(annotationInclusion))
      Parameters:
      annotationInclusion - indication which annotations to include during type resolution/introspection
      config - configuration to consider
      Returns:
      created TypeContext instance

    • createTypeContext

      @Deprecated public static TypeContext createTypeContext(com.fasterxml.classmate.AnnotationConfiguration annotationConfig)
      Deprecated.
      use createTypeContext(AnnotationConfiguration, SchemaGeneratorConfig) instead
      Create the a TypeContext with the given AnnotationConfiguration.
      Parameters:
      annotationConfig - configuration determining which annotations to include during type resolution/introspection
      Returns:
      created TypeContext instance

    • createTypeContext

      public static TypeContext createTypeContext(com.fasterxml.classmate.AnnotationConfiguration annotationConfig, SchemaGeneratorConfig config)
      Create the a TypeContext with the given AnnotationConfiguration.
      Note: when providing an instance of AnnotationConfiguration.StdConfiguration as first parameter, any configured annotation inclusion overrides are applied automatically.
      Parameters:
      annotationConfig - configuration determining which annotations to include during type resolution/introspection
      config - configuration to consider
      Returns:
      created TypeContext instance