Entity (hutool-db 4.6.0 API)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap<K,V>
  - - java.util.LinkedHashMap<String,Object>
    - - cn.hutool.core.lang.Dict
      - cn.hutool.db.Entity

所有已实现的接口:

BasicTypeGetter<String>, Serializable, Cloneable, Map<String,Object>

直接已知子类:

ActiveEntity
```
public class Entity
extends Dict
```
数据实体对象
数据实体类充当两个角色：
1. 数据的载体，一个Entity对应数据库中的一个row
2. SQL条件，Entity中的每一个字段对应一个条件，字段值对应条件的值

作者:

loolly

另请参阅:
序列化表格

嵌套类概要
- 从类继承的嵌套类/接口 java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

构造器概要

构造器
构造器和说明

Entity()

Entity(String tableName)
构造

Entity(String tableName, boolean caseInsensitive)
构造

构造器
构造器和说明
`Entity()`
`Entity(String tableName)` 构造
`Entity(String tableName, boolean caseInsensitive)` 构造

方法概要

方法
限定符和类型	方法和说明
`Entity`	`addFieldNames(String... fieldNames)` 添加字段列表
`Entity`	`clone()`
`static Entity`	`create()` 创建Entity
`static Entity`	`create(String tableName)` 创建Entity
`Entity`	`filter(String... keys)` 过滤Map保留指定键值对，如果键不存在跳过
`Blob`	`getBlob(String field)` 获得Blob类型结果
`Clob`	`getClob(String field)` 获得Clob类型结果
`Date`	`getDate(String field)`
`Set<String>`	`getFieldNames()`
`RowId`	`getRowId()` 获得rowid
`RowId`	`getRowId(String field)` 获得rowid
`String`	`getStr(String field)`
`String`	`getStr(String field, Charset charset)` 获得字符串值支持Clob、Blob、RowId
`String`	`getTableName()`
`Time`	`getTime(String field)`
`Timestamp`	`getTimestamp(String field)`
`static <T> Entity`	`parse(T bean)` 将PO对象转为Entity
`static <T> Entity`	`parse(T bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 将PO对象转为Entity
`<T> Entity`	`parseBean(T bean)` 将值对象转换为Entity 类名会被当作表名，小写第一个字母
`<T> Entity`	`parseBean(T bean, boolean isToUnderlineCase, boolean ignoreNullValue)` 将值对象转换为Entity 类名会被当作表名，小写第一个字母
`static <T> Entity`	`parseWithUnderlineCase(T bean)` 将PO对象转为Entity,并采用下划线法转换字段
`Entity`	`set(String field, Object value)`
`Entity`	`setFieldNames(Collection<String> fieldNames)` 设置字段列表，用于限制加入的字段的值
`Entity`	`setFieldNames(String... fieldNames)` 设置字段列表，用于限制加入的字段的值
`Entity`	`setIgnoreNull(String field, Object value)`
`Entity`	`setTableName(String tableName)` 设置表名
`String`	`toString()`

从类继承的方法 cn.hutool.core.lang.Dict
get, getBigDecimal, getBigInteger, getBool, getByte, getBytes, getChar, getDouble, getEnum, getFloat, getInt, getLong, getNumber, getObj, getShort, put, removeEqual, toBean, toBean, toBean, toBeanIgnoreCase, toBeanIgnoreCase, toBeanWithCamelCase

从类继承的方法 java.util.LinkedHashMap
clear, containsValue, get, removeEldestEntry

从类继承的方法 java.util.HashMap
containsKey, entrySet, isEmpty, keySet, putAll, remove, size, values

从类继承的方法 java.util.AbstractMap
equals, hashCode

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

从接口继承的方法 java.util.Map
containsKey, entrySet, equals, hashCode, isEmpty, keySet, putAll, remove, size, values

- 构造器详细资料
  - Entity
```
public Entity()
```
  - Entity
```
public Entity(String tableName)
```
    构造
    
    参数:
    tableName - 数据表名
  - Entity
```
public Entity(String tableName,
      boolean caseInsensitive)
```
    构造
    
    参数:
    tableName - 数据表名
    caseInsensitive - 是否大小写不敏感
    从以下版本开始:
    
    4.5.16
- 方法详细资料
  - create
```
public static Entity create()
```
    创建Entity
    
    返回:
    Entity
  - create
```
public static Entity create(String tableName)
```
    创建Entity
    
    参数:
    tableName - 表名
    
    返回:
    Entity
  - parse
```
public static <T> Entity parse(T bean)
```
    将PO对象转为Entity
    
    类型参数:
    T - Bean对象类型
    参数:
    bean - Bean对象
    
    返回:
    Entity
  - parse
```
public static <T> Entity parse(T bean,
               boolean isToUnderlineCase,
               boolean ignoreNullValue)
```
    将PO对象转为Entity
    
    类型参数:
    T - Bean对象类型
    参数:
    bean - Bean对象
    isToUnderlineCase - 是否转换为下划线模式
    ignoreNullValue - 是否忽略值为空的字段
    
    返回:
    Entity
  - parseWithUnderlineCase
```
public static <T> Entity parseWithUnderlineCase(T bean)
```
    将PO对象转为Entity,并采用下划线法转换字段
    
    类型参数:
    T - Bean对象类型
    参数:
    bean - Bean对象
    
    返回:
    Entity
  - getTableName
```
public String getTableName()
```
    返回:
    获得表名
  - setTableName
```
public Entity setTableName(String tableName)
```
    设置表名
    
    参数:
    tableName - 表名
    
    返回:
    本身
  - getFieldNames
```
public Set<String> getFieldNames()
```
    返回:
    字段集合
  - setFieldNames
```
public Entity setFieldNames(Collection<String> fieldNames)
```
    设置字段列表，用于限制加入的字段的值
    
    参数:
    fieldNames - 字段列表
    
    返回:
    自身
  - setFieldNames
```
public Entity setFieldNames(String... fieldNames)
```
    设置字段列表，用于限制加入的字段的值
    
    参数:
    fieldNames - 字段列表
    
    返回:
    自身
  - addFieldNames
```
public Entity addFieldNames(String... fieldNames)
```
    添加字段列表
    
    参数:
    fieldNames - 字段列表
    
    返回:
    自身
  - parseBean
```
public <T> Entity parseBean(T bean)
```
    将值对象转换为Entity
    类名会被当作表名，小写第一个字母
    
    覆盖:
    
    parseBean 在类中 Dict
    
    类型参数:
    T - Bean对象类型
    参数:
    bean - Bean对象
    
    返回:
    自己
  - parseBean
```
public <T> Entity parseBean(T bean,
                   boolean isToUnderlineCase,
                   boolean ignoreNullValue)
```
    将值对象转换为Entity
    类名会被当作表名，小写第一个字母
    
    覆盖:
    
    parseBean 在类中 Dict
    
    类型参数:
    T - Bean对象类型
    参数:
    bean - Bean对象
    isToUnderlineCase - 是否转换为下划线模式
    ignoreNullValue - 是否忽略值为空的字段
    
    返回:
    自己
  - filter
```
public Entity filter(String... keys)
```
    过滤Map保留指定键值对，如果键不存在跳过
    
    覆盖:
    
    filter 在类中 Dict
    
    参数:
    keys - 键列表
    
    返回:
    Dict 结果
    从以下版本开始:
    
    4.0.10
  - set
```
public Entity set(String field,
         Object value)
```
    覆盖:
    
    set 在类中 Dict
  - setIgnoreNull
```
public Entity setIgnoreNull(String field,
                   Object value)
```
    覆盖:
    
    setIgnoreNull 在类中 Dict
  - getClob
```
public Clob getClob(String field)
```
    获得Clob类型结果
    
    参数:
    field - 参数
    
    返回:
    Clob
  - getBlob
```
public Blob getBlob(String field)
```
    获得Blob类型结果
    
    参数:
    field - 参数
    
    返回:
    Blob
    从以下版本开始:
    
    3.0.6
  - getTime
```
public Time getTime(String field)
```
    覆盖:
    
    getTime 在类中 Dict
  - getDate
```
public Date getDate(String field)
```
    指定者:
    
    getDate 在接口中 BasicTypeGetter<String>
    
    覆盖:
    
    getDate 在类中 Dict
  - getTimestamp
```
public Timestamp getTimestamp(String field)
```
    覆盖:
    
    getTimestamp 在类中 Dict
  - getStr
```
public String getStr(String field)
```
    指定者:
    
    getStr 在接口中 BasicTypeGetter<String>
    
    覆盖:
    
    getStr 在类中 Dict
  - getStr
```
public String getStr(String field,
            Charset charset)
```
    获得字符串值
    支持Clob、Blob、RowId
    
    参数:
    field - 字段名
    charset - 编码
    
    返回:
    字段对应值
    从以下版本开始:
    
    3.0.6
  - getRowId
```
public RowId getRowId()
```
    获得rowid
    
    返回:
    RowId
  - getRowId
```
public RowId getRowId(String field)
```
    获得rowid
    
    参数:
    field - rowid属性名
    
    返回:
    RowId
  - clone
```
public Entity clone()
```
    覆盖:
    
    clone 在类中 Dict
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 AbstractMap<String,Object>

类 Entity

嵌套类概要

从类继承的嵌套类/接口 java.util.AbstractMap

构造器概要

方法概要

从类继承的方法 cn.hutool.core.lang.Dict

从类继承的方法 java.util.LinkedHashMap

从类继承的方法 java.util.HashMap

从类继承的方法 java.util.AbstractMap

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

从接口继承的方法 java.util.Map

构造器详细资料

Entity

Entity

Entity

方法详细资料

create

create

parse

parse

parseWithUnderlineCase

getTableName

setTableName

getFieldNames

setFieldNames

setFieldNames

addFieldNames

parseBean

parseBean

filter

set

setIgnoreNull

getClob

getBlob

getTime

getDate

getTimestamp

getStr

getStr

getRowId

getRowId

clone

toString