CopyOptions (hutool-码云(gitee.com))

java.lang.Object
- cn.hutool.core.bean.copier.CopyOptions

All Implemented Interfaces:

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

Author:

Looly

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Class<?>`	`editable` 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
`protected Map<String,String>`	`fieldMapping` 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
`protected boolean`	`ignoreCase` 是否忽略字段大小写
`protected boolean`	`ignoreError` 是否忽略字段注入错误
`protected boolean`	`ignoreNullValue` 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
`protected String[]`	`ignoreProperties` 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值

Constructor Summary

Constructors
Constructor and Description
`CopyOptions()` 构造拷贝选项
`CopyOptions(Class<?> editable, boolean ignoreNullValue, String... ignoreProperties)` 构造拷贝选项

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CopyOptions`	`create()` 创建拷贝选项
`static CopyOptions`	`create(Class<?> editable, boolean ignoreNullValue, String... ignoreProperties)` 创建拷贝选项
`protected Map<String,String>`	`getReversedMapping()` 获取反转之后的映射
`CopyOptions`	`ignoreCase()` 设置忽略字段的大小写
`CopyOptions`	`ignoreError()` 设置忽略字段的注入错误
`CopyOptions`	`ignoreNullValue()` 设置忽略空值，当源对象的值为null时，忽略而不注入此值
`CopyOptions`	`setEditable(Class<?> editable)` 设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
`CopyOptions`	`setFieldMapping(Map<String,String> fieldMapping)` 设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
`CopyOptions`	`setIgnoreCase(boolean ignoreCase)` 设置是否忽略字段的大小写
`CopyOptions`	`setIgnoreError(boolean ignoreError)` 设置是否忽略字段的注入错误
`CopyOptions`	`setIgnoreNullValue(boolean ignoreNullVall)` 设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
`CopyOptions`	`setIgnoreProperties(String... ignoreProperties)` 设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - editable
```
protected Class<?> editable
```
    限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
  - ignoreNullValue
```
protected boolean ignoreNullValue
```
    是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
  - ignoreProperties
```
protected String[] ignoreProperties
```
    忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
  - ignoreError
```
protected boolean ignoreError
```
    是否忽略字段注入错误
  - ignoreCase
```
protected boolean ignoreCase
```
    是否忽略字段大小写
  - fieldMapping
```
protected Map<String,String> fieldMapping
```
    拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
- Constructor Detail
  - CopyOptions
```
public CopyOptions()
```
    构造拷贝选项
  - CopyOptions
```
public CopyOptions(Class<?> editable,
                   boolean ignoreNullValue,
                   String... ignoreProperties)
```
    构造拷贝选项
    
    Parameters:
    
    editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
- Method Detail
  - create
```
public static CopyOptions create()
```
    创建拷贝选项
    
    Returns:
    
    拷贝选项
  - create
```
public static CopyOptions create(Class<?> editable,
                                 boolean ignoreNullValue,
                                 String... ignoreProperties)
```
    创建拷贝选项
    
    Parameters:
    
    editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    ignoreProperties - 忽略的属性列表，设置一个属性列表，不拷贝这些属性值
    
    Returns:
    
    拷贝选项
  - setEditable
```
public CopyOptions setEditable(Class<?> editable)
```
    设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    Parameters:
    
    editable - 限制的类或接口
    
    Returns:
    
    CopyOptions
  - setIgnoreNullValue
```
public CopyOptions setIgnoreNullValue(boolean ignoreNullVall)
```
    设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    Parameters:
    
    ignoreNullVall - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    Returns:
    
    CopyOptions
  - ignoreNullValue
```
public CopyOptions ignoreNullValue()
```
    设置忽略空值，当源对象的值为null时，忽略而不注入此值
    
    Returns:
    
    CopyOptions
    
    Since:
    
    4.5.7
  - setIgnoreProperties
```
public CopyOptions setIgnoreProperties(String... ignoreProperties)
```
    设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    Parameters:
    
    ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    Returns:
    
    CopyOptions
  - setIgnoreError
```
public CopyOptions setIgnoreError(boolean ignoreError)
```
    设置是否忽略字段的注入错误
    
    Parameters:
    
    ignoreError - 是否忽略注入错误
    
    Returns:
    
    CopyOptions
  - ignoreError
```
public CopyOptions ignoreError()
```
    设置忽略字段的注入错误
    
    Returns:
    
    CopyOptions
    
    Since:
    
    4.5.7
  - setIgnoreCase
```
public CopyOptions setIgnoreCase(boolean ignoreCase)
```
    设置是否忽略字段的大小写
    
    Parameters:
    
    ignoreCase - 是否忽略大小写
    
    Returns:
    
    CopyOptions
  - ignoreCase
```
public CopyOptions ignoreCase()
```
    设置忽略字段的大小写
    
    Returns:
    
    CopyOptions
    
    Since:
    
    4.5.7
  - setFieldMapping
```
public CopyOptions setFieldMapping(Map<String,String> fieldMapping)
```
    设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
    
    Parameters:
    
    fieldMapping - 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
    
    Returns:
    
    CopyOptions
  - getReversedMapping
```
protected Map<String,String> getReversedMapping()
```
    获取反转之后的映射
    
    Returns:
    
    反转映射
    
    Since:
    
    4.1.10

Class CopyOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

editable

ignoreNullValue

ignoreProperties

ignoreError

ignoreCase

fieldMapping

Constructor Detail

CopyOptions

CopyOptions

Method Detail

create

create

setEditable

setIgnoreNullValue

ignoreNullValue

setIgnoreProperties

setIgnoreError

ignoreError

setIgnoreCase

ignoreCase

setFieldMapping

getReversedMapping