cn.easyutil.easyapi.filter

接口 ReadBeanApiFilter

所有已知实现类:

DefaultReadBeanApi

public interface ReadBeanApiFilter

读取文档时的配置

方法概要

限定符和类型	方法和说明
String	parseMock(String template) 解析mock实际值
Type	parseType(Type type) 将实体bean的类型转换为其他类型进行解析
String	readBeanFieldComments(Field field) 读取实体bean字段说明
boolean	readBeanFieldHidden(Field field) 读取实体bean属性是否隐藏
boolean	readBeanFieldIgnore(Field field) 读取实体bean属性是否忽略
String	readBeanFieldMock(Field field) 读取实体bean的mock数据
boolean	readBeanFieldRequired(Field field) 读取实体bean属性是否必须
JavaType	readBeanType(Type type) 读取实体bean类型

方法详细资料

readBeanType

JavaType readBeanType(Type type)

读取实体bean类型

参数:

type - 实体bean类型

返回:

实体bean类型

parseType

Type parseType(Type type)

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

参数:

type - 原始类型

返回:

转换后的类型

readBeanFieldComments

String readBeanFieldComments(Field field)

读取实体bean字段说明

参数:

field - 属性

返回:

属性说明

readBeanFieldMock

String readBeanFieldMock(Field field)

读取实体bean的mock数据

参数:

field - 注解上的mock配置

返回:

实际mock值

parseMock

String parseMock(String template)

解析mock实际值

参数:

template -

返回:

readBeanFieldRequired

boolean readBeanFieldRequired(Field field)

读取实体bean属性是否必须

参数:

field -

返回:

true：必须 false：非必须

readBeanFieldHidden

boolean readBeanFieldHidden(Field field)

读取实体bean属性是否隐藏

参数:

field -

返回:

true：隐藏 false：非隐藏

readBeanFieldIgnore

boolean readBeanFieldIgnore(Field field)

读取实体bean属性是否忽略

参数:

field -

返回:

true：忽略 false：非忽略