Package org.springdoc.core.customizers

Record Class JavadocPropertyCustomizer

java.lang.Object
java.lang.Record
org.springdoc.core.customizers.JavadocPropertyCustomizer
All Implemented Interfaces:
io.swagger.v3.core.converter.ModelConverter
public record JavadocPropertyCustomizer(JavadocProvider javadocProvider, ObjectMapperProvider objectMapperProvider) extends Record implements io.swagger.v3.core.converter.ModelConverter
The type Javadoc property customizer.
Author:
bnasslahsen

  • Constructor Details

    • JavadocPropertyCustomizer

      public JavadocPropertyCustomizer(JavadocProvider javadocProvider, ObjectMapperProvider objectMapperProvider)
      Creates an instance of a JavadocPropertyCustomizer record class.
      Parameters:
      javadocProvider - the value for the javadocProvider record component
      objectMapperProvider - the value for the objectMapperProvider record component

  • Method Details

    • resolve

      public io.swagger.v3.oas.models.media.Schema resolve(io.swagger.v3.core.converter.AnnotatedType type, io.swagger.v3.core.converter.ModelConverterContext context, Iterator<io.swagger.v3.core.converter.ModelConverter> chain)
      Resolve schema.
      Specified by:
      resolve in interface io.swagger.v3.core.converter.ModelConverter
      Parameters:
      type - the type
      context - the context
      chain - the chain
      Returns:
      the schema

    • setJavadocDescription

      public void setJavadocDescription(Class<?> cls, List<Field> fields, List<PropertyDescriptor> clsProperties, io.swagger.v3.oas.models.media.Schema existingSchema, boolean isProcessedType)
      Sets javadoc description.
      Parameters:
      cls - the cls
      fields - the fields
      clsProperties - the bean properties of cls
      existingSchema - the existing schema
      isProcessedType - the is processed type

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • javadocProvider

      public JavadocProvider javadocProvider()
      Returns the value of the javadocProvider record component.
      Returns:
      the value of the javadocProvider record component

    • objectMapperProvider

      public ObjectMapperProvider objectMapperProvider()
      Returns the value of the objectMapperProvider record component.
      Returns:
      the value of the objectMapperProvider record component