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

Class PutOptions

java.lang.Object
org.brapi.schematools.core.options.AbstractGeneratorSubOptions
org.brapi.schematools.core.openapi.generator.options.AbstractOpenAPIOptions
org.brapi.schematools.core.openapi.generator.options.PutOptions
All Implemented Interfaces:
Options, Validatable
public class PutOptions extends AbstractOpenAPIOptions
Provides options for the generation of Put Endpoints

  • Constructor Details

    • PutOptions

      public PutOptions()

  • Method Details

    • override

      public void override(PutOptions 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

    • isMultipleFor

      public final boolean isMultipleFor(@NonNull @NonNull String name)
      Determines if the PUT Endpoint accepts multiple entities for a specific model
      Parameters:
      name - the name of the primary model
      Returns:
      true if the PUT Endpoint accepts multiple entities for the primary model, false otherwise

    • isMultipleFor

      public final boolean isMultipleFor(@NonNull @NonNull BrAPIType type)
      Determines if the PUT Endpoint accepts multiple entities for a specific model
      Parameters:
      type - the primary model
      Returns:
      true if the PUT Endpoint accepts multiple entities for the primary model, false otherwise

    • setMultipleFor

      public PutOptions setMultipleFor(String name, boolean multiple)
      Sets if the PUT Endpoint accepts multiple entities for a specific model
      Parameters:
      name - the name of the primary model
      multiple - set to true if the PUT Endpoint accepts multiple entities for a specific model false otherwise
      Returns:
      the options for chaining

    • setMultipleFor

      public PutOptions setMultipleFor(BrAPIType type, boolean multiple)
      Sets if the PUT Endpoint accepts multiple entities for a specific model
      Parameters:
      type - the primary model
      multiple - set to true if the PUT Endpoint accepts multiple entities for a specific model false otherwise
      Returns:
      the options for chaining

    • isGeneratingEndpointFor

      public boolean isGeneratingEndpointFor(String name)
      Determines if generating a PUT endpoint with no ID parameter for a specific model
      Parameters:
      name - the name of the primary model
      Returns:
      true if generating a PUT endpoint with no ID parameter for a specific model, false otherwise

    • isGeneratingEndpointFor

      public boolean isGeneratingEndpointFor(BrAPIObjectType type)
      Determines if generating a PUT endpoint with no ID parameter for a specific model
      Parameters:
      type - the primary model
      Returns:
      true if generating a PUT endpoint with no ID parameter for a specific model, false otherwise

    • isGeneratingEndpointNameWithIdFor

      public boolean isGeneratingEndpointNameWithIdFor(String name)
      Determines if generating a PUT endpoint with an ID parameter for a specific model
      Parameters:
      name - the name of the primary model
      Returns:
      true if generating a PUT endpoint with an ID parameter for a specific model, false otherwise

    • isGeneratingEndpointNameWithIdFor

      public boolean isGeneratingEndpointNameWithIdFor(BrAPIObjectType type)
      Determines if generating a PUT endpoint with an ID parameter for a specific model
      Parameters:
      type - the primary model
      Returns:
      true if generating a PUT endpoint with an ID parameter for a specific model, false otherwise