PropDesc (jarvis-tool-core 1.0.3.RELEASE API)

java.lang.Object
- com.github.jarvisframework.tool.core.bean.PropDesc

```
public class PropDesc
extends Object
```
属性描述，包括了字段、getter、setter和相应的方法执行

从以下版本开始:

1.0, 2020-09-23 14:51:10

作者:

Doug Wang

字段概要

字段
限定符和类型字段和说明

(专用程序包) Field field
字段

protected Method getter
Getter方法

protected Method setter
Setter方法

字段
限定符和类型	字段和说明
`(专用程序包) Field`	`field` 字段
`protected Method`	`getter` Getter方法
`protected Method`	`setter` Setter方法

构造器概要

构造器
构造器和说明

PropDesc(Field field, Method getter, Method setter)
构造
Getter和Setter方法设置为默认可访问

构造器
构造器和说明
`PropDesc(Field field, Method getter, Method setter)` 构造 Getter和Setter方法设置为默认可访问

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`private Class<?>`	`findPropClass(Method getter, Method setter)` 通过Getter和Setter方法中找到属性类型
`private Type`	`findPropType(Method getter, Method setter)` 通过Getter和Setter方法中找到属性类型
`Field`	`getField()` 获取字段
`Class<?>`	`getFieldClass()` 获得字段类型先获取字段的类型，如果字段不存在，则获取Getter方法的返回类型，否则获取Setter的第一个参数类型
`String`	`getFieldName()` 获取字段名，如果存在Alias注解，读取注解的值作为名称
`Type`	`getFieldType()` 获得字段类型先获取字段的类型，如果字段不存在，则获取Getter方法的返回类型，否则获取Setter的第一个参数类型
`Method`	`getGetter()` 获取Getter方法，可能为`null`
`String`	`getRawFieldName()` 获取字段名称
`Method`	`getSetter()` 获取Setter方法，可能为`null`
`Object`	`getValue(Object bean)` 获取属性值首先调用字段对应的Getter方法获取值，如果Getter方法不存在，则判断字段如果为public，则直接获取字段值此方法不检查任何注解，使用前需调用 `isReadable(boolean)` 检查是否可读
`Object`	`getValue(Object bean, Type targetType, boolean ignoreError)` 获取属性值，自动转换属性值类型首先调用字段对应的Getter方法获取值，如果Getter方法不存在，则判断字段如果为public，则直接获取字段值
`private boolean`	`isIgnoreGet()` 检查字段是否被忽略读，通过`PropIgnore` 注解完成，规则为： 1.
`private boolean`	`isIgnoreSet()` 检查字段是否被忽略写，通过`PropIgnore` 注解完成，规则为： 1.
`boolean`	`isReadable(boolean checkTransient)` 检查属性是否可读（即是否可以通过`getValue(Object)`获取到值）
`private boolean`	`isTransientForGet()` 字段和Getter方法是否为Transient关键字修饰的
`private boolean`	`isTransientForSet()` 字段和Getter方法是否为Transient关键字修饰的
`boolean`	`isWritable(boolean checkTransient)` 检查属性是否可读（即是否可以通过`getValue(Object)`获取到值）
`PropDesc`	`setValue(Object bean, Object value)` 设置Bean的字段值首先调用字段对应的Setter方法，如果Setter方法不存在，则判断字段如果为public，则直接赋值字段值此方法不检查任何注解，使用前需调用 `isWritable(boolean)` 检查是否可写
`PropDesc`	`setValue(Object bean, Object value, boolean ignoreNull, boolean ignoreError)` 设置属性值，可以自动转换字段类型为目标类型

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - field
```
final Field field
```
    字段
  - getter
```
protected Method getter
```
    Getter方法
  - setter
```
protected Method setter
```
    Setter方法
- 构造器详细资料
  - PropDesc
```
public PropDesc(Field field,
                Method getter,
                Method setter)
```
    构造
    Getter和Setter方法设置为默认可访问
    
    参数:
    
    field - 字段
    
    getter - get方法
    
    setter - set方法
- 方法详细资料
  - getFieldName
```
public String getFieldName()
```
    获取字段名，如果存在Alias注解，读取注解的值作为名称
    
    返回:
    
    字段名
  - getRawFieldName
```
public String getRawFieldName()
```
    获取字段名称
    
    返回:
    
    字段名
    
    从以下版本开始:
    
    5.1.6
  - getField
```
public Field getField()
```
    获取字段
    
    返回:
    
    字段
  - getFieldType
```
public Type getFieldType()
```
    获得字段类型
    先获取字段的类型，如果字段不存在，则获取Getter方法的返回类型，否则获取Setter的第一个参数类型
    
    返回:
    
    字段类型
  - getFieldClass
```
public Class<?> getFieldClass()
```
    获得字段类型
    先获取字段的类型，如果字段不存在，则获取Getter方法的返回类型，否则获取Setter的第一个参数类型
    
    返回:
    
    字段类型
  - getGetter
```
public Method getGetter()
```
    获取Getter方法，可能为null
    
    返回:
    
    Getter方法
  - getSetter
```
public Method getSetter()
```
    获取Setter方法，可能为null
    
    返回:
    
    MethodSetter 方法对象
  - isReadable
```
public boolean isReadable(boolean checkTransient)
```
    检查属性是否可读（即是否可以通过getValue(Object)获取到值）
    
    参数:
    
    checkTransient - 是否检查Transient关键字或注解
    
    返回:
    
    是否可读
    
    从以下版本开始:
    
    5.4.2
  - getValue
```
public Object getValue(Object bean)
```
    获取属性值
    首先调用字段对应的Getter方法获取值，如果Getter方法不存在，则判断字段如果为public，则直接获取字段值
    此方法不检查任何注解，使用前需调用 isReadable(boolean) 检查是否可读
    
    参数:
    
    bean - Bean对象
    
    返回:
    
    字段值
    
    从以下版本开始:
    
    4.0.5
  - getValue
```
public Object getValue(Object bean,
                       Type targetType,
                       boolean ignoreError)
```
    获取属性值，自动转换属性值类型
    首先调用字段对应的Getter方法获取值，如果Getter方法不存在，则判断字段如果为public，则直接获取字段值
    
    参数:
    
    bean - Bean对象
    
    targetType - 返回属性值需要转换的类型，null表示不转换
    
    ignoreError - 是否忽略错误，包括转换错误和注入错误
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.2
  - isWritable
```
public boolean isWritable(boolean checkTransient)
```
    检查属性是否可读（即是否可以通过getValue(Object)获取到值）
    
    参数:
    
    checkTransient - 是否检查Transient关键字或注解
    
    返回:
    
    是否可读
    
    从以下版本开始:
    
    5.4.2
  - setValue
```
public PropDesc setValue(Object bean,
                         Object value)
```
    设置Bean的字段值
    首先调用字段对应的Setter方法，如果Setter方法不存在，则判断字段如果为public，则直接赋值字段值
    此方法不检查任何注解，使用前需调用 isWritable(boolean) 检查是否可写
    
    参数:
    
    bean - Bean对象
    
    value - 值，必须与字段值类型匹配
    
    返回:
    
    this
    
    从以下版本开始:
    
    4.0.5
  - setValue
```
public PropDesc setValue(Object bean,
                         Object value,
                         boolean ignoreNull,
                         boolean ignoreError)
```
    设置属性值，可以自动转换字段类型为目标类型
    
    参数:
    
    bean - Bean对象
    
    value - 属性值，可以为任意类型
    
    ignoreNull - 是否忽略null值，true表示忽略
    
    ignoreError - 是否忽略错误，包括转换错误和注入错误
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.2
  - findPropType
```
private Type findPropType(Method getter,
                          Method setter)
```
    通过Getter和Setter方法中找到属性类型
    
    参数:
    
    getter - Getter方法
    
    setter - Setter方法
    
    返回:
    
    Type
  - findPropClass
```
private Class<?> findPropClass(Method getter,
                               Method setter)
```
    通过Getter和Setter方法中找到属性类型
    
    参数:
    
    getter - Getter方法
    
    setter - Setter方法
    
    返回:
    
    Type
  - isIgnoreSet
```
private boolean isIgnoreSet()
```
    检查字段是否被忽略写，通过PropIgnore 注解完成，规则为：
```
     1. 在字段上有PropIgnore 注解
     2. 在setXXX方法上有PropIgnore 注解
 
```
    返回:
    
    是否忽略写
    
    从以下版本开始:
    
    5.4.2
  - isIgnoreGet
```
private boolean isIgnoreGet()
```
    检查字段是否被忽略读，通过PropIgnore 注解完成，规则为：
```
     1. 在字段上有PropIgnore 注解
     2. 在getXXX方法上有PropIgnore 注解
 
```
    返回:
    
    是否忽略读
    
    从以下版本开始:
    
    5.4.2
  - isTransientForGet
```
private boolean isTransientForGet()
```
    字段和Getter方法是否为Transient关键字修饰的
    
    返回:
    
    是否为Transient关键字修饰的
    
    从以下版本开始:
    
    5.3.11
  - isTransientForSet
```
private boolean isTransientForSet()
```
    字段和Getter方法是否为Transient关键字修饰的
    
    返回:
    
    是否为Transient关键字修饰的
    
    从以下版本开始:
    
    5.3.11

类 PropDesc

字段概要

构造器概要

方法概要

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

字段详细资料

field

getter

setter

构造器详细资料

PropDesc

方法详细资料

getFieldName

getRawFieldName

getField

getFieldType

getFieldClass

getGetter

getSetter

isReadable

getValue

getValue

isWritable

setValue

setValue

findPropType

findPropClass

isIgnoreSet

isIgnoreGet

isTransientForGet

isTransientForSet