cn.easyutil.easyapi.filter

类 ReadJavaBeanApiFilter

java.lang.Object

cn.easyutil.easyapi.filter.ReadJavaBeanApiFilter

直接已知子类:

DefaultReadJavaBeanApi

public abstract class ReadJavaBeanApiFilter
extends Object

读取文档时的配置

构造器概要

构造器

构造器和说明
ReadJavaBeanApiFilter()

方法概要

限定符和类型	方法和说明
abstract List<String>	conditons(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 参数校验,返回el表达式
abstract String	description(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean字段说明
abstract boolean	ignore(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean属性是否忽略
abstract JavaType	javaType(Class aClass, GenericTypeBind bind, Type type, ApiExtra extra) 读取实体bean类型
abstract String	mockTemplate(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean的mock数据
abstract String	name(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 字段名称
abstract boolean	required(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean属性是否必须
abstract boolean	show(Class aClass, GenericTypeBind bind, Field field, ApiExtra extra) 读取实体bean属性是否显示
abstract Type	type(Class aClass, GenericTypeBind bind, Type type, ApiExtra extra) 将实体bean的类型转换为其他类型进行解析

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ReadJavaBeanApiFilter

public ReadJavaBeanApiFilter()

方法详细资料

javaType

public abstract JavaType javaType(Class aClass,
                                  GenericTypeBind bind,
                                  Type type,
                                  ApiExtra extra)

读取实体bean类型

参数:

type - 实体bean类型

返回:

实体bean类型

type

public abstract Type type(Class aClass,
                          GenericTypeBind bind,
                          Type type,
                          ApiExtra extra)

将实体bean的类型转换为其他类型进行解析

参数:

type - 原始类型

返回:

转换后的类型

description

public abstract String description(Class aClass,
                                   GenericTypeBind bind,
                                   Field field,
                                   ApiExtra extra)

读取实体bean字段说明

参数:

field - 属性

返回:

属性说明

mockTemplate

public abstract String mockTemplate(Class aClass,
                                    GenericTypeBind bind,
                                    Field field,
                                    ApiExtra extra)

读取实体bean的mock数据

参数:

field - 注解上的mock配置

返回:

实际mock值

required

public abstract boolean required(Class aClass,
                                 GenericTypeBind bind,
                                 Field field,
                                 ApiExtra extra)

读取实体bean属性是否必须

参数:

field -

返回:

true：必须 false：非必须

show

public abstract boolean show(Class aClass,
                             GenericTypeBind bind,
                             Field field,
                             ApiExtra extra)

读取实体bean属性是否显示

name

public abstract String name(Class aClass,
                            GenericTypeBind bind,
                            Field field,
                            ApiExtra extra)

字段名称

参数:

aClass - 字段类型

bind - 绑定的泛型

field - 字段

extra - 冗余信息

ignore

public abstract boolean ignore(Class aClass,
                               GenericTypeBind bind,
                               Field field,
                               ApiExtra extra)

读取实体bean属性是否忽略

参数:

field -

返回:

true：忽略 false：非忽略

conditons

public abstract List<String> conditons(Class aClass,
                                       GenericTypeBind bind,
                                       Field field,
                                       ApiExtra extra)

参数校验,返回el表达式

参数:

aClass -

bind -

field -

返回: