Enum OpenAPIComponent

    • Field Detail

      • VALID_COMPONENTS

        public static final String VALID_COMPONENTS
    • Method Detail

      • values

        public static OpenAPIComponent[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OpenAPIComponent c : OpenAPIComponent.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OpenAPIComponent valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null
      • getComponentTypeLabel

        public String getComponentTypeLabel()
        Returns the component type label as defined by the OpenAPI 3.0 Specification
        Returns:
        the componentTypeLabel
      • isReferenceComponentValid

        public static boolean isReferenceComponentValid​(String reference)
        Returns true if the references being validated matches the OpenAPI component structure of '#/components/<type>/<name>', returns false otherwise.
        Parameters:
        reference -
        Returns:
        true if reference is valid, false otherwise