KeyValueResource (magic-api 1.7.2 API)

java.lang.Object
- org.ssssssss.magicapi.adapter.resource.KeyValueResource

所有已实现的接口:

Resource

直接已知子类:

DatabaseResource, RedisResource
```
public abstract class KeyValueResource
extends Object
implements Resource
```
Key-Value形式的存储

作者:

mxd

字段概要

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

protected KeyValueResource parent

protected String path

protected boolean readonly

protected String separator

字段
限定符和类型	字段和说明
`protected KeyValueResource`	`parent`
`protected String`	`path`
`protected boolean`	`readonly`
`protected String`	`separator`

构造器概要

构造器
构造器和说明
`KeyValueResource(String separator, String path, boolean readonly, KeyValueResource parent)`
`KeyValueResource(String separator, String path, KeyValueResource parent)`

方法概要

All Methods Instance Methods Abstract Methods Concrete Methods
限定符和类型	方法和说明
`boolean`	`delete()` 删除
`protected boolean`	`deleteByKey(String key)`
`List<Resource>`	`dirs()` 目录
`List<Resource>`	`files(String suffix)` 遍历文件
`String`	`getAbsolutePath()` 获取所在位置
`Resource`	`getDirectory(String name)` 获取子目录
`String`	`getFilePath()` 获取文件路径
`Resource`	`getResource(String name)` 获取子资源
`boolean`	`isDirectory()` 判断是否是目录
`protected abstract Set<String>`	`keys()` 该资源下的keys
`protected abstract Function<String,Resource>`	`mappedFunction()` mapped函数，用于根据路径创建资源对象
`boolean`	`mkdir()` 创建目录
`String`	`name()` 获取资源名
`Resource`	`parent()` 父级资源
`boolean`	`readonly()` 判断是否是只读
`protected abstract boolean`	`renameTo(Map<String,String> renameKeys)` 需要做修改的key，原key: 新key
`boolean`	`renameTo(Resource resource)` 重命名
`List<Resource>`	`resources()` 获取子资源集合
`String`	`separator()` 获取分隔符
`boolean`	`write(byte[] bytes)` 写入

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

从接口继承的方法 org.ssssssss.magicapi.adapter.Resource
exists, export, processExport, read, readAll, write

- 字段详细资料
  - separator
```
protected String separator
```
  - path
```
protected String path
```
  - parent
```
protected KeyValueResource parent
```
  - readonly
```
protected boolean readonly
```
- 构造器详细资料
  - KeyValueResource
```
public KeyValueResource(String separator,
                        String path,
                        KeyValueResource parent)
```
  - KeyValueResource
```
public KeyValueResource(String separator,
                        String path,
                        boolean readonly,
                        KeyValueResource parent)
```
- 方法详细资料
  - separator
```
public String separator()
```
    从接口复制的说明: Resource
    
    获取分隔符
    
    指定者:
    
    separator 在接口中 Resource
    
    返回:
    
    返回分隔符
  - isDirectory
```
public boolean isDirectory()
```
    从接口复制的说明: Resource
    
    判断是否是目录
    
    指定者:
    
    isDirectory 在接口中 Resource
    
    返回:
    
    返回资源是否是目录
  - readonly
```
public boolean readonly()
```
    从接口复制的说明: Resource
    
    判断是否是只读
    
    指定者:
    
    readonly 在接口中 Resource
    
    返回:
    
    返回资源是否是只读
  - renameTo
```
public final boolean renameTo(Resource resource)
```
    从接口复制的说明: Resource
    
    重命名
    
    指定者:
    
    renameTo 在接口中 Resource
    
    参数:
    
    resource - 目标资源
    
    返回:
    
    是否重命名成功
  - delete
```
public boolean delete()
```
    从接口复制的说明: Resource
    
    删除
    
    指定者:
    
    delete 在接口中 Resource
    
    返回:
    
    返回是否删除成功
  - deleteByKey
```
protected boolean deleteByKey(String key)
```
  - renameTo
```
protected abstract boolean renameTo(Map<String,String> renameKeys)
```
    需要做修改的key，原key: 新key
    
    参数:
    
    renameKeys - 需重命名的key
    
    返回:
    
    是否修改成功
  - name
```
public String name()
```
    从接口复制的说明: Resource
    
    获取资源名
    
    指定者:
    
    name 在接口中 Resource
    
    返回:
    
    返回资源名称
  - getResource
```
public Resource getResource(String name)
```
    从接口复制的说明: Resource
    
    获取子资源
    
    指定者:
    
    getResource 在接口中 Resource
    
    参数:
    
    name - 文件名称
    
    返回:
    
    返回资源对象
  - getDirectory
```
public Resource getDirectory(String name)
```
    从接口复制的说明: Resource
    
    获取子目录
    
    指定者:
    
    getDirectory 在接口中 Resource
    
    参数:
    
    name - 目录名称
    
    返回:
    
    返回资源对象
  - mkdir
```
public boolean mkdir()
```
    从接口复制的说明: Resource
    
    创建目录
    
    指定者:
    
    mkdir 在接口中 Resource
    
    返回:
    
    返回是否创建成功
  - parent
```
public Resource parent()
```
    从接口复制的说明: Resource
    
    父级资源
    
    指定者:
    
    parent 在接口中 Resource
    
    返回:
    
    返回父级资源
  - write
```
public boolean write(byte[] bytes)
```
    从接口复制的说明: Resource
    
    写入
    
    指定者:
    
    write 在接口中 Resource
    
    参数:
    
    bytes - 写入的内容
    
    返回:
    
    是否写入成功
  - resources
```
public List<Resource> resources()
```
    从接口复制的说明: Resource
    
    获取子资源集合
    
    指定者:
    
    resources 在接口中 Resource
    
    返回:
    
    返回资源集合
  - mappedFunction
```
protected abstract Function<String,Resource> mappedFunction()
```
    mapped函数，用于根据路径创建资源对象
    
    返回:
    
    mapped函数
  - keys
```
protected abstract Set<String> keys()
```
    该资源下的keys
    
    返回:
    
    返回该资源下的keys
  - dirs
```
public List<Resource> dirs()
```
    从接口复制的说明: Resource
    
    目录
    
    指定者:
    
    dirs 在接口中 Resource
    
    返回:
    
    返回当前资源下的目录
  - files
```
public List<Resource> files(String suffix)
```
    从接口复制的说明: Resource
    
    遍历文件
    
    指定者:
    
    files 在接口中 Resource
    
    参数:
    
    suffix - 文件名后缀
    
    返回:
    
    返回当前资源下的文件
  - getAbsolutePath
```
public String getAbsolutePath()
```
    从接口复制的说明: Resource
    
    获取所在位置
    
    指定者:
    
    getAbsolutePath 在接口中 Resource
    
    返回:
    
    获取绝对路径
  - getFilePath
```
public String getFilePath()
```
    从接口复制的说明: Resource
    
    获取文件路径
    
    指定者:
    
    getFilePath 在接口中 Resource
    
    返回:
    
    返回文件路径

类 KeyValueResource

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.ssssssss.magicapi.adapter.Resource

字段详细资料

separator

path

parent

readonly

构造器详细资料

KeyValueResource

KeyValueResource

方法详细资料

separator

isDirectory

readonly

renameTo

delete

deleteByKey

renameTo

name

getResource

getDirectory

mkdir

parent

write

resources

mappedFunction

keys

dirs

files

getAbsolutePath

getFilePath