API 参考
TMFStorage
静态方法
/**
* 初始化统一存储组件
* @param appContext Application的上下文
* @param config 统一存储组件配置
*/
public static void initialize(Context appContext, TMFStorageConfig config)
/**
* 获取全局存储环境
* @return 全局存储环境
*/
public static TMFStorage getDefault()
/**
* 获取用户存储环境
* @param identifier 标识用户的UID
* @return UID对应的存储环境
*/
public static TMFStorage getByUser(String identifier)
/**
* 获取临时存储环境
* @return 临时存储环境
*/
public static TMFStorage getTemporary()
成员方法
/**
* 获取当前环境的SharedPreferences
* @return 当前环境的SharedPreferences
*/
public TMFSharedPreferences sp()
/**
* 获取当前环境的文件
* @return 当前环境的文件
*/
public TMFFile file()
/**
* 获取当前环境的数据库
* @return 当前环境的数据库
*/
public TMFDatabase database()
TMFSharedPreferences
成员方法
/**
* 获取当前存储的所有key
* @return 返回所有的key
*/
public String[] allKeys()
/**
* 获取key对应的字符串值
* @param key 要获取的key
* @param defValue 当key不存在时返回的默认值
* @return 如果key存在返回key对应的字符串，否则返回defValue
*/
public String getString(String key, String defValue)
/**
* 获取key对应的字符串set
* @param key 要获取的key
* @param defValues 当key不存在时返回的默认值
* @return 如果key存在返回key对应的字符串set，否则返回defValue
*/
public Set<String> getStringSet(String key, Set<String> defValues)
/**
* 获取key对应的整形数
* @param key 要获取的key
* @param defValue 当key不存在时返回的默认值
* @return 如果key存在返回key对应的整形数，否则返回defValue
*/
public int getInt(String key, int defValue)
/**
* 获取key对应的长整形数
* @param key 要获取的key
* @param defValue 当key不存在时返回的默认值
* @return 如果key存在返回key对应的长整形数，否则返回defValue
*/
public long getLong(String key, long defValue)
/**
* 获取key对应的浮点数
* @param key 要获取的key
* @param defValue 当key不存在时返回的默认值
* @return 如果key存在返回key对应的浮点数，否则返回defValue
*/
public float getFloat(String key, float defValue)
/**
* 获取key对应的布尔值
* @param key 要获取的key
* @param defValue 当key不存在时返回的默认值
* @return 如果key存在返回key对应的布尔值，否则返回defValue
*/
public boolean getBoolean(String key, boolean defValue)
/**
* 查询sp中是否存在某个key
* @param key 要查询的key
* @return 如果key存在返回true，否则返回false
*/
public boolean contains(String key)
/**
* 获取编辑sp的接口
* @return 返回编辑sp的Editor接口
*/
public SharedPreferences.Editor edit()
TMFFile
成员方法
/**
* 根据相对路径获取app内部存储的文件对象
* @param relativePath 文件相对路径
* @return 相对路径下的文件对象
*/
public File getInternalFile(String relativePath)
/**
* 根据相对路径获取app sd卡存储的文件对象
* @param relativePath 文件相对路径
* @return 相对路径下的文件对象
*/
public File getExternalFile(String relativePath)
/**
* 删除当前存储环境下的所有文件
*/
public void removeAllFiles()
FileUtils
静态方法
/**
* 将字节写入到文件
* @param data 待写入的字节
* @param dest 目标文件
* @return 是否写入文件成功
*/
public static boolean writeFile(byte[] data, File dest)
/**
* 将字节加密后写入到文件
* @param data 待写入的字节
* @param dest 目标文件
* @param key 加密使用的密钥
* @param type 加密算法
* @return 是否写入文件成功
*/
public static boolean writeFileEncrypted(byte[] data, File dest, byte[] key,
TMFCipher.AlgorithmType type)
/**
* 从文件读取字节
* @param src 待读取的文件
* @return 从文件读取到的字节，可能返回null
*/
public static byte[] readFile(File src)
/**
* 从加密文件读取字节
* @param src 待读取的文件
* @param key 加密使用的密钥
* @param type 加密算法
* @return 从文件读取到的字节，可能返回null
*/
public static byte[] readFileEncrypted(File src, byte[] key,
TMFCipher.AlgorithmType type)
/**
* 加密文件
* @param src 待加密的原文件
* @param dest 加密后输出的文件
* @param key 加密使用的密钥
* @param type 加密算法
* @return 是否加密成功
*/
public static boolean encryptFile(File src, File dest, byte[] key,
TMFCipher.AlgorithmType type)
/**
* 解密文件
* @param src 待解密的原文件
* @param dest 解密后输出的文件
* @param key 加密使用的密钥
* @param type 加密算法
* @return 是否解密成功
*/
public static boolean decryptFile(File src, File dest, byte[] key,
TMFCipher.AlgorithmType type)
/**
* 删除文件或目录
* @param target 待删除的文件或者目录对象
* @return 是否删除成功
*/
public static boolean removeFileOrDirectory(File target)
/**
* 静默关闭一个io流，并捕获可能发生的异常
* @param ioStream 待关闭的io流
* @return 是否关闭成功
*/
public static boolean closeQuietly(Closeable ioStream)
TMFDatabase
成员方法
/**
* 创建当前存储环境的WCDB SQLiteOpenHelper
* @param name 数据库名称
* @param factory CursorFactory
* @param version 数据库版本
* @param errorHandler DatabaseErrorHandler
* @param callback 代理SQLiteOpenHelper的回调
* @return SQLiteOpenHelper
*/
public SQLiteOpenHelper createWCDBHelper(
String name,
SQLiteDatabase.CursorFactory factory, int version,
DatabaseErrorHandler errorHandler,
TMFWCDBOpenHelper.DatabaseCallback callback)
/**
* 创建当前存储环境带加密的WCDB SQLiteOpenHelper
* @param name 数据库名称
* @param password 数据库加密密钥
* @param cipher 加密算法
* @param factory CursorFactory
* @param version 数据库版本
* @param errorHandler DatabaseErrorHandler
* @param callback 代理SQLiteOpenHelper的回调
* @return SQLiteOpenHelper
*/
public SQLiteOpenHelper createWCDBHelper(
String name, byte[] password, SQLiteCipherSpec cipher,
SQLiteDatabase.CursorFactory factory, int version,
DatabaseErrorHandler errorHandler,
TMFWCDBOpenHelper.DatabaseCallback callback)
/**
* 删除数据库
* @param name 待删除的数据库名称
*/
public void dropDatabase(String name)
/**
* 删除当前环境下的所有数据库
*/
public void dropAllDatabases()
/**
* 获取数据库名对应的数据库文件
* @param name 数据库的名称
* @return 数据库文件对象
*/
public File getDatabasePath(String name)