cn.hutool.core.bean.copier

类 CopyOptions

java.lang.Object

cn.hutool.core.bean.copier.CopyOptions

public class CopyOptions
extends java.lang.Object

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

作者:

Looly

字段概要

字段

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

构造器概要

构造器

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

方法概要

方法

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

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

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

字段详细资料

editable

protected java.lang.Class<?> editable

限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类

ignoreNullValue

protected boolean ignoreNullValue

是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null

ignoreProperties

protected java.lang.String[] ignoreProperties

忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值

ignoreError

protected boolean ignoreError

是否忽略字段注入错误

ignoreCase

protected boolean ignoreCase

是否忽略字段大小写

fieldMapping

protected java.util.Map<java.lang.String,java.lang.String> fieldMapping

拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用

构造器详细资料

CopyOptions

public CopyOptions()

构造拷贝选项

CopyOptions

public CopyOptions(java.lang.Class<?> editable,
           boolean ignoreNullValue,
           java.lang.String... ignoreProperties)

构造拷贝选项

参数:

editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性

ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null

ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值

方法详细资料

create

public static CopyOptions create()

创建拷贝选项

返回:

拷贝选项

create

public static CopyOptions create(java.lang.Class<?> editable,
                 boolean ignoreNullValue,
                 java.lang.String... ignoreProperties)

创建拷贝选项

参数:

editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性

ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null

ignoreProperties - 忽略的属性列表，设置一个属性列表，不拷贝这些属性值

返回:

拷贝选项

setEditable

public CopyOptions setEditable(java.lang.Class<?> editable)

设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性

参数:

editable - 限制的类或接口

返回:

CopyOptions

setIgnoreNullValue

public CopyOptions setIgnoreNullValue(boolean ignoreNullVall)

设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null

参数:

ignoreNullVall - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null

返回:

CopyOptions

setIgnoreProperties

public CopyOptions setIgnoreProperties(java.lang.String... ignoreProperties)

设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值

参数:

ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值

返回:

CopyOptions

setIgnoreError

public CopyOptions setIgnoreError(boolean ignoreError)

设置是否忽略字段的注入错误

参数:

ignoreError - 是否忽略注入错误

返回:

CopyOptions

setIgnoreCase

public CopyOptions setIgnoreCase(boolean ignoreCase)

设置是否忽略字段的注入错误

参数:

ignoreCase - 是否忽略大小写

返回:

CopyOptions

setFieldMapping

public CopyOptions setFieldMapping(java.util.Map<java.lang.String,java.lang.String> fieldMapping)

设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用

参数:

fieldMapping - 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用

返回:

CopyOptions

getReversedMapping

protected java.util.Map<java.lang.String,java.lang.String> getReversedMapping()

获取反转之后的映射

返回:

反转映射

从以下版本开始:

4.1.10