LitePalSupport (core API)

java.lang.Object
- org.litepal.crud.LitePalSupport

```
public class LitePalSupport
extends java.lang.Object
```
LitePalSupport connects classes to SQLite database tables to establish an almost zero-configuration persistence layer for applications. In the context of an application, these classes are commonly referred to as models. Models can also be connected to other models.
LitePalSupport relies heavily on naming in that it uses class and association names to establish mappings between respective database tables and foreign key columns.
Automated mapping between classes and tables, attributes and columns.
```
 public class Person extends LitePalSupport {
        private int id;
        private String name;
        private int age;
 }
 
 The Person class is automatically mapped to the table named "person",
 which might look like this:
 
 CREATE TABLE person (
        id integer primary key autoincrement,
        age integer, 
        name text
 );
 
```
从以下版本开始:

2.0

字段概要

字段
限定符和类型字段和说明

protected static java.lang.String AES
Constant for AES encryption.

protected static java.lang.String MD5
Constant for MD5 encryption.

字段
限定符和类型	字段和说明
`protected static java.lang.String`	`AES` Constant for AES encryption.
`protected static java.lang.String`	`MD5` Constant for MD5 encryption.

构造器概要

构造器
限定符构造器和说明

protected LitePalSupport()
Disable developers to create instance of LitePalSupport directly.

构造器
限定符	构造器和说明
`protected`	`LitePalSupport()` Disable developers to create instance of LitePalSupport directly.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`assignBaseObjId(long baseObjId)` Assigns value to baseObjId.
`void`	`clearSavedState()` It model is saved, clear the saved state and model becomes unsaved.
`int`	`delete()` Deletes the record in the database.
`UpdateOrDeleteExecutor`	`deleteAsync()` 已过时。
`protected long`	`getBaseObjId()` Get the baseObjId of this model if it's useful for developers.
`protected java.lang.String`	`getClassName()` Get the full class name of self.
`protected java.lang.String`	`getTableName()` Get the corresponding table name of current model.
`boolean`	`isSaved()` Current model is saved or not.
`boolean`	`save()` Saves the model.
`SaveExecutor`	`saveAsync()` 已过时。
`boolean`	`saveOrUpdate(java.lang.String... conditions)` Save the model if the conditions data not exist, or update the matching models if the conditions data exist.
`SaveExecutor`	`saveOrUpdateAsync(java.lang.String... conditions)` 已过时。
`void`	`saveThrows()` Saves the model.
`void`	`setToDefault(java.lang.String fieldName)` When updating database with `update(long)`, you must use this method to update a field into default value.
`int`	`update(long id)` Updates the corresponding record by id.
`int`	`updateAll(java.lang.String... conditions)` Updates all records with details given if they match a set of conditions supplied.
`UpdateOrDeleteExecutor`	`updateAllAsync(java.lang.String... conditions)` 已过时。
`UpdateOrDeleteExecutor`	`updateAsync(long id)` 已过时。

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

- 字段详细资料
  - MD5
```
protected static final java.lang.String MD5
```
    Constant for MD5 encryption.
    
    另请参阅:
    
    常量字段值
  - AES
```
protected static final java.lang.String AES
```
    Constant for AES encryption.
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - LitePalSupport
```
protected LitePalSupport()
```
    Disable developers to create instance of LitePalSupport directly. They should inherit this class with subclasses and operate on them.
- 方法详细资料
  - delete
```
public int delete()
```
    Deletes the record in the database. The record must be saved already.
    The data in other tables which is referenced with the record will be removed too.
```
 Person person;
 ....
 if (person.isSaved()) {
                person.delete();
 }
 
```
    返回:
    
    The number of rows affected. Including cascade delete rows.
  - deleteAsync
```
@Deprecated
public UpdateOrDeleteExecutor deleteAsync()
```
    已过时。
    
    This method is deprecated and will be removed in the future releases. Handle async db operation in your own logic instead.
  - update
```
public int update(long id)
```
    Updates the corresponding record by id. Use setXxx to decide which columns to update.
```
 Person person = new Person();
 person.setName("Jim");
 person.update(1);
 
```
    This means that the name of record 1 will be updated into Jim.
    Note: 1. If you set a default value to a field, the corresponding column won't be updated. Use setToDefault(String) to update columns into default value. 2. This method couldn't update foreign key in database. So do not use setXxx to set associations between models.
    参数:
    
    id - Which record to update.
    
    返回:
    
    The number of rows affected.
  - updateAsync
```
@Deprecated
public UpdateOrDeleteExecutor updateAsync(long id)
```
    已过时。
    
    This method is deprecated and will be removed in the future releases. Handle async db operation in your own logic instead.
  - updateAll
```
public int updateAll(java.lang.String... conditions)
```
    Updates all records with details given if they match a set of conditions supplied. This method constructs a single SQL UPDATE statement and sends it to the database.
```
 Person person = new Person();
 person.setName("Jim");
 person.updateAll("name = ?", "Tom");
 
```
    This means that all the records which name is Tom will be updated into Jim.
    Note: 1. If you set a default value to a field, the corresponding column won't be updated. Use setToDefault(String) to update columns into default value. 2. This method couldn't update foreign key in database. So do not use setXxx to set associations between models.
    参数:
    
    conditions - A string array representing the WHERE part of an SQL statement. First parameter is the WHERE clause to apply when updating. The way of specifying place holders is to insert one or more question marks in the SQL. The first question mark is replaced by the second element of the array, the next question mark by the third, and so on. Passing empty string will update all rows.
    
    返回:
    
    The number of rows affected.
  - updateAllAsync
```
@Deprecated
public UpdateOrDeleteExecutor updateAllAsync(java.lang.String... conditions)
```
    已过时。
    
    This method is deprecated and will be removed in the future releases. Handle async db operation in your own logic instead.
  - save
```
public boolean save()
```
    Saves the model.
```
 Person person = new Person();
 person.setName("Tom");
 person.setAge(22);
 person.save();
 
```
    If the model is a new record gets created in the database, otherwise the existing record gets updated.
    If saving process failed by any accident, the whole action will be cancelled and your database will be rolled back.
    If the model has a field named id or _id and field type is int or long, the id value generated by database will assign to it after the model is saved.
    Note that if the associated models of this model is already saved. The associations between them will be built automatically in database after it saved.
    返回:
    
    If the model is saved successfully, return true. Any exception happens, return false.
  - saveAsync
```
@Deprecated
public SaveExecutor saveAsync()
```
    已过时。
    
    This method is deprecated and will be removed in the future releases. Handle async db operation in your own logic instead.
  - saveThrows
```
public void saveThrows()
```
    Saves the model.
```
 Person person = new Person();
 person.setName("Tom");
 person.setAge(22);
 person.saveThrows();
 
```
    If the model is a new record gets created in the database, otherwise the existing record gets updated.
    If saving process failed by any accident, the whole action will be cancelled and your database will be rolled back and throws LitePalSupportException
    If the model has a field named id or _id and field type is int or long, the id value generated by database will assign to it after the model is saved.
    Note that if the associated models of this model is already saved. The associations between them will be built automatically in database after it saved.
    抛出:
    
    LitePalSupportException
  - saveOrUpdate
```
public boolean saveOrUpdate(java.lang.String... conditions)
```
    Save the model if the conditions data not exist, or update the matching models if the conditions data exist.
```
 Person person = new Person();
 person.setName("Tom");
 person.setAge(22);
 person.saveOrUpdate("name = ?", "Tom");
 
```
    If person table doesn't have a name with Tom, a new record gets created in the database, otherwise all records which names are Tom will be updated.
    If saving process failed by any accident, the whole action will be cancelled and your database will be rolled back.
    If the model has a field named id or _id and field type is int or long, the id value generated by database will assign to it after the model is saved.
    Note that if the associated models of this model is already saved. The associations between them will be built automatically in database after it saved.
    参数:
    
    conditions - A string array representing the WHERE part of an SQL statement. First parameter is the WHERE clause to apply when updating. The way of specifying place holders is to insert one or more question marks in the SQL. The first question mark is replaced by the second element of the array, the next question mark by the third, and so on. Passing empty string will update all rows.
    
    返回:
    
    If the model saved or updated successfully, return true. Otherwise return false.
  - saveOrUpdateAsync
```
@Deprecated
public SaveExecutor saveOrUpdateAsync(java.lang.String... conditions)
```
    已过时。
    
    This method is deprecated and will be removed in the future releases. Handle async db operation in your own logic instead.
  - isSaved
```
public boolean isSaved()
```
    Current model is saved or not.
    
    返回:
    
    If saved return true, or return false.
  - clearSavedState
```
public void clearSavedState()
```
    It model is saved, clear the saved state and model becomes unsaved. Otherwise nothing will happen.
  - setToDefault
```
public void setToDefault(java.lang.String fieldName)
```
    When updating database with update(long), you must use this method to update a field into default value. Use setXxx with default value of the model won't update anything.
    
    参数:
    
    fieldName - The name of field to update into default value.
  - assignBaseObjId
```
public void assignBaseObjId(long baseObjId)
```
    Assigns value to baseObjId. This will override the original value. Never call this method unless you know exactly what you are doing.
    
    参数:
    
    baseObjId - Assigns value to baseObjId.
  - getBaseObjId
```
protected long getBaseObjId()
```
    Get the baseObjId of this model if it's useful for developers. It's for system use usually. Do not try to assign or modify it.
    
    返回:
    
    The base object id.
  - getClassName
```
protected java.lang.String getClassName()
```
    Get the full class name of self.
    
    返回:
    
    The full class name of self.
  - getTableName
```
protected java.lang.String getTableName()
```
    Get the corresponding table name of current model.
    
    返回:
    
    The corresponding table name of current model.

类 LitePalSupport

字段概要

构造器概要

方法概要

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

字段详细资料

MD5

AES

构造器详细资料

LitePalSupport

方法详细资料

delete

deleteAsync

update

updateAsync

updateAll

updateAllAsync

save

saveAsync

saveThrows

saveOrUpdate

saveOrUpdateAsync

isSaved

clearSavedState

setToDefault

assignBaseObjId

getBaseObjId

getClassName

getTableName