CopyOptions (hutool-core 6.0.0-M6 API)

java.lang.Object
- org.dromara.hutool.core.bean.copier.CopyOptions

所有已实现的接口:

Serializable
```
public class CopyOptions
extends Object
implements Serializable
```
属性拷贝选项
包括：
1、限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
2、是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
3、忽略的属性列表，设置一个属性列表，不拷贝这些属性值

作者:

Looly

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected Converter`	`converter` 自定义类型转换器，默认使用全局万能转换器转换
`protected Class<?>`	`editable` 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类如果目标对象是Map，源对象是Bean，则作用于源对象上
`protected UnaryOperator<MutableEntry<String,Object>>`	`fieldEditor` 字段属性名和属性值编辑器，用于自定义属性转换规则（例如驼峰转下划线等），自定义属性值转换规则（例如null转""等）
`protected boolean`	`ignoreCase` 是否忽略字段大小写
`protected boolean`	`ignoreError` 是否忽略字段注入错误
`protected boolean`	`ignoreNullValue` 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
`protected boolean`	`override` 是否覆盖目标值，如果不覆盖，会先读取目标对象的值，为`null`则写，否则忽略。
`protected boolean`	`transientSupport` 是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。

构造器概要

构造器
构造器和说明
`CopyOptions()` 构造拷贝选项
`CopyOptions(Class<?> editable, boolean ignoreNullValue, String... ignoreProperties)` 构造拷贝选项

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected Object`	`convertField(Type targetType, Object fieldValue)` 使用自定义转换器转换字段值如果自定义转换器为`null`，则返回原值。
`protected MutableEntry<String,Object>`	`editField(String fieldName, Object fieldValue)` 编辑字段值
`CopyOptions`	`ignoreCase()` 设置忽略字段的大小写
`CopyOptions`	`ignoreError()` 设置忽略字段的注入错误
`CopyOptions`	`ignoreNullValue()` 设置忽略空值，当源对象的值为null时，忽略而不注入此值
`static CopyOptions`	`of()` 创建拷贝选项
`static CopyOptions`	`of(Class<?> editable, boolean ignoreNullValue, String... ignoreProperties)` 创建拷贝选项
`CopyOptions`	`setConverter(Converter converter)` 设置自定义类型转换器，默认使用全局万能转换器转换。
`CopyOptions`	`setEditable(Class<?> editable)` 设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
`CopyOptions`	`setFieldEditor(UnaryOperator<MutableEntry<String,Object>> editor)` 设置字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等此转换器只针对源端的字段做转换，请确认转换后与目标端字段一致当转换后的字段名为null时忽略这个字段需要注意的是，当使用ValueProvider作为数据提供者时，这个映射是相反的，即参数中key为目标Bean的名称，而返回值是提供者中的key，并且对值的修改无效
`CopyOptions`	`setFieldMapping(Map<String,String> fieldMapping)` 设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用需要注意的是，当使用ValueProvider作为数据提供者时，这个映射是相反的，即fieldMapping中key为目标Bean的名称，而value是提供者中的key
`CopyOptions`	`setIgnoreCase(boolean ignoreCase)` 设置是否忽略字段的大小写
`CopyOptions`	`setIgnoreError(boolean ignoreError)` 设置是否忽略字段的注入错误
`CopyOptions`	`setIgnoreNullValue(boolean ignoreNullVall)` 设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
`<P,R> CopyOptions`	`setIgnoreProperties(SerFunction<P,R>... funcs)` 设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值，Lambda方式
`CopyOptions`	`setIgnoreProperties(String... ignoreProperties)` 设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
`CopyOptions`	`setOverride(boolean override)` 设置是否覆盖目标值，如果不覆盖，会先读取目标对象的值，为`null`则写，否则忽略。
`CopyOptions`	`setPropertiesFilter(BiPredicate<Field,Object> propertiesFilter)` 属性过滤器，断言通过的属性才会被复制 `BiPredicate.test(Object, Object)`返回`true`则属性通过，`false`不通过，抛弃之
`CopyOptions`	`setTransientSupport(boolean transientSupport)` 设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
`protected boolean`	`testPropertyFilter(Field field, Object value)` 测试是否保留字段，`true`保留，`false`不保留

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

- 字段详细资料
  - editable
```
protected Class<?> editable
```
    限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
    如果目标对象是Map，源对象是Bean，则作用于源对象上
  - ignoreNullValue
```
protected boolean ignoreNullValue
```
    是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
  - ignoreError
```
protected boolean ignoreError
```
    是否忽略字段注入错误
  - ignoreCase
```
protected boolean ignoreCase
```
    是否忽略字段大小写
  - fieldEditor
```
protected UnaryOperator<MutableEntry<String,Object>> fieldEditor
```
    字段属性名和属性值编辑器，用于自定义属性转换规则（例如驼峰转下划线等），自定义属性值转换规则（例如null转""等）
  - transientSupport
```
protected boolean transientSupport
```
    是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
  - override
```
protected boolean override
```
    是否覆盖目标值，如果不覆盖，会先读取目标对象的值，为null则写，否则忽略。如果覆盖，则不判断直接写
  - converter
```
protected Converter converter
```
    自定义类型转换器，默认使用全局万能转换器转换
- 构造器详细资料
  - CopyOptions
```
public CopyOptions()
```
    构造拷贝选项
  - CopyOptions
```
public CopyOptions(Class<?> editable,
                   boolean ignoreNullValue,
                   String... ignoreProperties)
```
    构造拷贝选项
    
    参数:
    
    editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
- 方法详细资料
  - of
```
public static CopyOptions of()
```
    创建拷贝选项
    
    返回:
    
    拷贝选项
  - of
```
public static CopyOptions of(Class<?> editable,
                             boolean ignoreNullValue,
                             String... ignoreProperties)
```
    创建拷贝选项
    
    参数:
    
    editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    ignoreProperties - 忽略的属性列表，设置一个属性列表，不拷贝这些属性值
    
    返回:
    
    拷贝选项
  - setEditable
```
public CopyOptions setEditable(Class<?> editable)
```
    设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    参数:
    
    editable - 限制的类或接口
    
    返回:
    
    CopyOptions
  - setIgnoreNullValue
```
public CopyOptions setIgnoreNullValue(boolean ignoreNullVall)
```
    设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    参数:
    
    ignoreNullVall - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    返回:
    
    CopyOptions
  - ignoreNullValue
```
public CopyOptions ignoreNullValue()
```
    设置忽略空值，当源对象的值为null时，忽略而不注入此值
    
    返回:
    
    CopyOptions
    
    从以下版本开始:
    
    4.5.7
  - setPropertiesFilter
```
public CopyOptions setPropertiesFilter(BiPredicate<Field,Object> propertiesFilter)
```
    属性过滤器，断言通过的属性才会被复制
    BiPredicate.test(Object, Object)返回true则属性通过，false不通过，抛弃之
    
    参数:
    
    propertiesFilter - 属性过滤器
    
    返回:
    
    CopyOptions
  - setIgnoreProperties
```
public CopyOptions setIgnoreProperties(String... ignoreProperties)
```
    设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    参数:
    
    ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    返回:
    
    CopyOptions
  - setIgnoreProperties
```
public <P,R> CopyOptions setIgnoreProperties(SerFunction<P,R>... funcs)
```
    设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值，Lambda方式
    
    类型参数:
    
    P - 参数类型
    
    R - 返回值类型
    
    参数:
    
    funcs - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    返回:
    
    CopyOptions
    
    从以下版本开始:
    
    5.8.0
  - setIgnoreError
```
public CopyOptions setIgnoreError(boolean ignoreError)
```
    设置是否忽略字段的注入错误
    
    参数:
    
    ignoreError - 是否忽略注入错误
    
    返回:
    
    CopyOptions
  - ignoreError
```
public CopyOptions ignoreError()
```
    设置忽略字段的注入错误
    
    返回:
    
    CopyOptions
    
    从以下版本开始:
    
    4.5.7
  - setIgnoreCase
```
public CopyOptions setIgnoreCase(boolean ignoreCase)
```
    设置是否忽略字段的大小写
    
    参数:
    
    ignoreCase - 是否忽略大小写
    
    返回:
    
    CopyOptions
  - ignoreCase
```
public CopyOptions ignoreCase()
```
    设置忽略字段的大小写
    
    返回:
    
    CopyOptions
    
    从以下版本开始:
    
    4.5.7
  - setFieldMapping
```
public CopyOptions setFieldMapping(Map<String,String> fieldMapping)
```
    设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
    需要注意的是，当使用ValueProvider作为数据提供者时，这个映射是相反的，即fieldMapping中key为目标Bean的名称，而value是提供者中的key
    
    参数:
    
    fieldMapping - 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
    
    返回:
    
    CopyOptions
  - setFieldEditor
```
public CopyOptions setFieldEditor(UnaryOperator<MutableEntry<String,Object>> editor)
```
    设置字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
    此转换器只针对源端的字段做转换，请确认转换后与目标端字段一致
    当转换后的字段名为null时忽略这个字段
    需要注意的是，当使用ValueProvider作为数据提供者时，这个映射是相反的，即参数中key为目标Bean的名称，而返回值是提供者中的key，并且对值的修改无效
    
    参数:
    
    editor - 字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
    
    返回:
    
    CopyOptions
    
    从以下版本开始:
    
    5.4.2
  - editField
```
protected MutableEntry<String,Object> editField(String fieldName,
                                                Object fieldValue)
```
    编辑字段值
    
    参数:
    
    fieldName - 字段名
    
    fieldValue - 字段值
    
    返回:
    
    编辑后的字段值
    
    从以下版本开始:
    
    5.7.15
  - setTransientSupport
```
public CopyOptions setTransientSupport(boolean transientSupport)
```
    设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
    
    参数:
    
    transientSupport - 是否支持
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.2
  - setOverride
```
public CopyOptions setOverride(boolean override)
```
    设置是否覆盖目标值，如果不覆盖，会先读取目标对象的值，为null则写，否则忽略。如果覆盖，则不判断直接写
    
    参数:
    
    override - 是否覆盖目标值
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.7.17
  - setConverter
```
public CopyOptions setConverter(Converter converter)
```
    设置自定义类型转换器，默认使用全局万能转换器转换。
    
    参数:
    
    converter - 转换器
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.8.0
  - convertField
```
protected Object convertField(Type targetType,
                              Object fieldValue)
```
    使用自定义转换器转换字段值
    如果自定义转换器为null，则返回原值。
    
    参数:
    
    targetType - 目标类型
    
    fieldValue - 字段值
    
    返回:
    
    编辑后的字段值
    
    从以下版本开始:
    
    5.8.0
  - testPropertyFilter
```
protected boolean testPropertyFilter(Field field,
                                     Object value)
```
    测试是否保留字段，true保留，false不保留
    
    参数:
    
    field - 字段
    
    value - 值
    
    返回:
    
    是否保留

类 CopyOptions

字段概要

构造器概要

方法概要

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

字段详细资料

editable

ignoreNullValue

ignoreError

ignoreCase

fieldEditor

transientSupport

override

converter

构造器详细资料

CopyOptions

CopyOptions

方法详细资料

of

of

setEditable

setIgnoreNullValue

ignoreNullValue

setPropertiesFilter

setIgnoreProperties

setIgnoreProperties

setIgnoreError

ignoreError

setIgnoreCase

ignoreCase

setFieldMapping

setFieldEditor

editField

setTransientSupport

setOverride

setConverter

convertField

testPropertyFilter