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

java.lang.Object
- com.github.jarvisframework.tool.core.bean.copier.CopyOptions

所有已实现的接口:

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

从以下版本开始:

1.0, 2020-07-29 18:37:16

作者:

Doug Wang

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`protected Class<?>`	`editable` 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性，例如一个类我只想复制其父类的一些属性，就可以将editable设置为父类
`protected Map<String,String>`	`fieldMapping` 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
`protected Editor<String>`	`fieldNameEditor` 字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
`protected boolean`	`ignoreCase` 是否忽略字段大小写
`protected boolean`	`ignoreError` 是否忽略字段注入错误
`protected boolean`	`ignoreNullValue` 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
`protected String[]`	`ignoreProperties` 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
`private Map<String,String>`	`reversedFieldMapping` 反向映射表，自动生成用于反向查找
`private static long`	`serialVersionUID`
`private boolean`	`transientSupport` 是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。

构造器概要

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static CopyOptions`	`create()` 创建拷贝选项
`static CopyOptions`	`create(Class<?> editable, boolean ignoreNullValue, String... ignoreProperties)` 创建拷贝选项
`protected String`	`editFieldName(String fieldName)` 转换字段名为编辑后的字段名
`protected String`	`getMappedFieldName(String fieldName, boolean reversed)` 获得映射后的字段名当非反向，则根据源字段名获取目标字段名，反之根据目标字段名获取源字段名。
`private Map<String,String>`	`getReversedMapping()` 获取反转之后的映射
`CopyOptions`	`ignoreCase()` 设置忽略字段的大小写
`CopyOptions`	`ignoreError()` 设置忽略字段的注入错误
`CopyOptions`	`ignoreNullValue()` 设置忽略空值，当源对象的值为null时，忽略而不注入此值
`boolean`	`isTransientSupport()` 是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
`CopyOptions`	`setEditable(Class<?> editable)` 设置限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
`CopyOptions`	`setFieldMapping(Map<String,String> fieldMapping)` 设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
`CopyOptions`	`setFieldNameEditor(Editor<String> fieldNameEditor)` 设置字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等此转换器只针对源端的字段做转换，请确认转换后与目标端字段一致
`CopyOptions`	`setIgnoreCase(boolean ignoreCase)` 设置是否忽略字段的大小写
`CopyOptions`	`setIgnoreError(boolean ignoreError)` 设置是否忽略字段的注入错误
`CopyOptions`	`setIgnoreNullValue(boolean ignoreNullVall)` 设置是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
`CopyOptions`	`setIgnoreProperties(String... ignoreProperties)` 设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
`CopyOptions`	`setTransientSupport(boolean transientSupport)` 设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。

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

- 字段详细资料
  - serialVersionUID
```
private static final long serialVersionUID
```
    另请参阅:
    
    常量字段值
  - 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
```
    拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
  - reversedFieldMapping
```
private Map<String,String> reversedFieldMapping
```
    反向映射表，自动生成用于反向查找
  - fieldNameEditor
```
protected Editor<String> fieldNameEditor
```
    字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
  - transientSupport
```
private boolean transientSupport
```
    是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
- 构造器详细资料
  - CopyOptions
```
public CopyOptions()
```
    构造拷贝选项
  - CopyOptions
```
public CopyOptions(Class<?> editable,
                   boolean ignoreNullValue,
                   String... ignoreProperties)
```
    构造拷贝选项
    
    参数:
    
    editable - 限制的类或接口，必须为目标对象的实现接口或父类，用于限制拷贝的属性
    
    ignoreNullValue - 是否忽略空值，当源对象的值为null时，true: 忽略而不注入此值，false: 注入null
    
    ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
- 方法详细资料
  - create
```
public static CopyOptions create()
```
    创建拷贝选项
    
    返回:
    
    拷贝选项
  - create
```
public static CopyOptions create(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
  - setIgnoreProperties
```
public CopyOptions setIgnoreProperties(String... ignoreProperties)
```
    设置忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    参数:
    
    ignoreProperties - 忽略的目标对象中属性列表，设置一个属性列表，不拷贝这些属性值
    
    返回:
    
    CopyOptions
  - 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)
```
    设置拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
    
    参数:
    
    fieldMapping - 拷贝属性的字段映射，用于不同的属性之前拷贝做对应表用
    
    返回:
    
    CopyOptions
  - setFieldNameEditor
```
public CopyOptions setFieldNameEditor(Editor<String> fieldNameEditor)
```
    设置字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
    此转换器只针对源端的字段做转换，请确认转换后与目标端字段一致
    
    参数:
    
    fieldNameEditor - 字段属性编辑器，用于自定义属性转换规则，例如驼峰转下划线等
    
    返回:
    
    CopyOptions
    
    从以下版本开始:
    
    5.4.2
  - isTransientSupport
```
public boolean isTransientSupport()
```
    是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
    
    返回:
    
    是否支持
    
    从以下版本开始:
    
    5.4.2
  - setTransientSupport
```
public CopyOptions setTransientSupport(boolean transientSupport)
```
    设置是否支持transient关键字修饰和@Transient注解，如果支持，被修饰的字段或方法对应的字段将被忽略。
    
    参数:
    
    transientSupport - 是否支持
    
    返回:
    
    this
    
    从以下版本开始:
    
    5.4.2
  - getMappedFieldName
```
protected String getMappedFieldName(String fieldName,
                                    boolean reversed)
```
    获得映射后的字段名
    当非反向，则根据源字段名获取目标字段名，反之根据目标字段名获取源字段名。
    
    参数:
    
    fieldName - 字段名
    
    reversed - 是否反向映射
    
    返回:
    
    映射后的字段名
  - editFieldName
```
protected String editFieldName(String fieldName)
```
    转换字段名为编辑后的字段名
    
    参数:
    
    fieldName - 字段名
    
    返回:
    
    编辑后的字段名
    
    从以下版本开始:
    
    5.4.2
  - getReversedMapping
```
private Map<String,String> getReversedMapping()
```
    获取反转之后的映射
    
    返回:
    
    反转映射
    
    从以下版本开始:
    
    4.1.10

类 CopyOptions

字段概要

构造器概要

方法概要

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

字段详细资料

serialVersionUID

editable

ignoreNullValue

ignoreProperties

ignoreError

ignoreCase

fieldMapping

reversedFieldMapping

fieldNameEditor

transientSupport

构造器详细资料

CopyOptions

CopyOptions

方法详细资料

create

create

setEditable

setIgnoreNullValue

ignoreNullValue

setIgnoreProperties

setIgnoreError

ignoreError

setIgnoreCase

ignoreCase

setFieldMapping

setFieldNameEditor

isTransientSupport

setTransientSupport

getMappedFieldName

editFieldName

getReversedMapping