Package com.mohamnag.jstatic.plugins.openapi_processor

Record Class OpenApiProcessorConfig

java.lang.Object
java.lang.Record
com.mohamnag.jstatic.plugins.openapi_processor.OpenApiProcessorConfig
public record OpenApiProcessorConfig(Map<ComponentType,ComponentConfig> components) extends Record
Will parse config with root key "open-api-processor".

To override defaults for each component type, define a sub-key with name of that component type as used in OpenAPI spec. For each component type a "template" and a "package" key might be configured. See OpenApiProcessor docs to find out how these values are used.

For example use following to configure template and package for request bodies only: 

 "open-api-processor":
    requestBodies:
      template: openapi/req_body
      package: dtos.request_bodies

  • Constructor Details

    • OpenApiProcessorConfig

      public OpenApiProcessorConfig(Map<ComponentType,ComponentConfig> components)
      Creates an instance of a OpenApiProcessorConfig record class.
      Parameters:
      components - the value for the components record component

  • Method Details

    • extract

      public static OpenApiProcessorConfig extract(Config globalConfig)

    • getPackageName

      public String getPackageName(ComponentType componentType)

    • getTemplate

      public String getTemplate(ComponentType componentType)

    • 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.

    • components

      public Map<ComponentType,ComponentConfig> components()
      Returns the value of the components record component.
      Returns:
      the value of the components record component