Package org.brapi.schematools.core.openapi.generator.options

Class AbstractOpenAPIOptions

java.lang.Object
org.brapi.schematools.core.options.AbstractGeneratorSubOptions
org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions
All Implemented Interfaces:
Options, Validatable
Direct Known Subclasses:
DeleteOptions, ListGetOptions, PostOptions, PutOptions, SearchOptions, SingleGetOptions
public abstract class AbstractOpenAPIOptions extends AbstractGeneratorSubOptions
Provides general options for the generation of Endpoints

  • Constructor Details

    • AbstractOpenAPIOptions

      public AbstractOpenAPIOptions()

  • Method Details

    • validate

      public Validation validate()
      Description copied from class: AbstractGeneratorSubOptions
      Checks if the current options are valid, return a list of errors if the options are not valid
      Specified by:
      validate in interface Validatable
      Overrides:
      validate in class AbstractGeneratorSubOptions
      Returns:
      a Validation object than can be used queried to find if the options are valid and any errors if the options are not valid

    • override

      public void override(AbstractOpenAPIOptions overrideOptions)
      Overrides the values in this Options Object from the provided Options Object if they are non-null
      Parameters:
      overrideOptions - the options which will be used to override this Options Object

    • getSummaryFor

      public final String getSummaryFor(@NonNull @NonNull String name)
      Gets the summary for a specific primary model
      Parameters:
      name - the name of the primary model
      Returns:
      the summary for a specific primary model

    • getSummaryFor

      public final String getSummaryFor(@NonNull @NonNull BrAPIType type)
      Gets the summary for a specific primary model
      Parameters:
      type - the primary model
      Returns:
      the summary for a specific primary model