Package com.github.victools.jsonschema.module.swagger15

Enum SwaggerOption

    • Enum Constant Detail

      • IGNORING_HIDDEN_PROPERTIES

        public static final SwaggerOption IGNORING_HIDDEN_PROPERTIES
        Use this option to ignore properties annotated with @ApiModelProperty(hidden = true).

      • ENABLE_PROPERTY_NAME_OVERRIDES

        public static final SwaggerOption ENABLE_PROPERTY_NAME_OVERRIDES
        Use this option to apply alternative property names specified via @ApiModelProperty(name = "...").

      • NO_APIMODEL_DESCRIPTION

        public static final SwaggerOption NO_APIMODEL_DESCRIPTION
        Use this option to NOT set the "description" property (based on @ApiModel(description = "...")).

      • NO_APIMODEL_TITLE

        public static final SwaggerOption NO_APIMODEL_TITLE
        Use this option to NOT set the "title" property (based on @ApiModel(value = "...")).

    • Method Detail

      • values

        public static SwaggerOption[] 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 (SwaggerOption c : SwaggerOption.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static SwaggerOption 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