cn.weiguangfu.swagger2.plus.enums

枚举 ApiExecutionEnum

java.lang.Object

java.lang.Enum<ApiExecutionEnum>

cn.weiguangfu.swagger2.plus.enums.ApiExecutionEnum

所有已实现的接口:

Serializable, Comparable<ApiExecutionEnum>

public enum ApiExecutionEnum
extends Enum<ApiExecutionEnum>

API参数执行动作枚举类

从以下版本开始:

2.7.0-1-beta1

版本:

2.7.0

作者:

魏广甫

枚举常量概要

枚举常量

枚举常量和说明
EXCLUDE 排除动作,当前方式为排除,请求参数中配置此种方式,默认参数需要全部展示, 配置排除的字段不会展示到swagger页面
INCLUDE 包含动作,当前方式为包含,请求参数配置此种方式,默认参数全部不展示 参数中只有配置允许的字段才能展示.

方法概要

限定符和类型	方法和说明
static ApiExecutionEnum	valueOf(String name) 返回带有指定名称的该类型的枚举常量。
static ApiExecutionEnum[]	values() 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。

从类继承的方法 java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

INCLUDE

public static final ApiExecutionEnum INCLUDE

包含动作,当前方式为包含,请求参数配置此种方式,默认参数全部不展示 参数中只有配置允许的字段才能展示.

EXCLUDE

public static final ApiExecutionEnum EXCLUDE

排除动作,当前方式为排除,请求参数中配置此种方式,默认参数需要全部展示, 配置排除的字段不会展示到swagger页面

方法详细资料

values

public static ApiExecutionEnum[] values()

按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:

for (ApiExecutionEnum c : ApiExecutionEnum.values())
    System.out.println(c);

返回:

按照声明该枚举类型的常量的顺序返回的包含这些常量的数组

valueOf

public static ApiExecutionEnum valueOf(String name)

返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符完全匹配。(不允许有多余 的空格字符。)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量

NullPointerException - 如果参数为空值