Package com.arc_e_tect.gradle.apionly.transcriberj.model

Enum Class Construct

java.lang.Object
java.lang.Enum<Construct>
com.arc_e_tect.gradle.apionly.transcriberj.model.Construct
All Implemented Interfaces:
Serializable, Comparable<Construct>, Constable
public enum Construct extends Enum<Construct>
A construct the model classifies wherever it occurs, so that its treatment in generated code is reported rather than discovered.

  • Enum Constant Details

    • ONE_OF_REF_BRANCHES

      public static final Construct ONE_OF_REF_BRANCHES
      oneOf whose branches are all references to components.

    • ONE_OF_INLINE_BRANCHES

      public static final Construct ONE_OF_INLINE_BRANCHES
      oneOf with at least one anonymous, inline branch.

    • ANY_OF_REF_BRANCHES

      public static final Construct ANY_OF_REF_BRANCHES
      anyOf whose branches are all references to components.

    • ANY_OF_INLINE_BRANCHES

      public static final Construct ANY_OF_INLINE_BRANCHES
      anyOf with at least one anonymous, inline branch.

    • DISCRIMINATOR

      public static final Construct DISCRIMINATOR
      discriminator.

    • ADDITIONAL_PROPERTIES

      public static final Construct ADDITIONAL_PROPERTIES
      additionalProperties, in any of its forms.

    • PATTERN_PROPERTIES

      public static final Construct PATTERN_PROPERTIES
      patternProperties.

    • RECURSIVE_REF

      public static final Construct RECURSIVE_REF
      A $ref that closes a cycle of components.

    • MULTIPLE_TYPES

      public static final Construct MULTIPLE_TYPES
      type naming more than one type, such as [string, 'null'].

    • BOOLEAN_SCHEMA

      public static final Construct BOOLEAN_SCHEMA
      A schema written as the literal true or false.

    • UNMODELLED_KEYWORD

      public static final Construct UNMODELLED_KEYWORD
      A schema keyword the model does not type, kept as a raw value.

    • UNMODELLED_COMPONENT_TYPE

      public static final Construct UNMODELLED_COMPONENT_TYPE
      A component of a type the model does not type -- anything but schemas, responses, parameters and request bodies -- kept as a raw value.

  • Method Details

    • values

      public static Construct[] 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 Construct 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

    • treatment

      public Treatment treatment()
      How generated code treats this construct.
      Returns:
      the treatment

    • remedy

      public String remedy()
      What a specification author can do so the construct is represented in full.
      Returns:
      the remedy, or null when there is nothing to remedy