VirtualContainer (ofdrw-pkg 2.0.3 API)

java.lang.Object
- org.ofdrw.pkg.container.VirtualContainer

所有已实现的接口:

Closeable, AutoCloseable

直接已知子类:

AnnotsDir, DocDir, OFDDir, PageDir, PagesDir, ResDir, SignDir, SignsDir, TempsDir
```
public class VirtualContainer
extends Object
implements Closeable
```
虚拟容器对象

从以下版本开始:

2020-04-02 19:01:04

作者:

权观宇

构造器概要

构造器
构造器和说明
`VirtualContainer(Path fullDir)` 通过完整路径构造一个虚拟容器
`VirtualContainer(Path parent, String dirName)` 创建一个虚拟容器

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`VirtualContainer`	`addRaw(String fileName, InputStream in)` 向虚拟容器中直接加入流类型资源根据提供文件名称创建文件输入流内容将直接写入文件内，不做检查若文件已经存在，那么将会覆盖原文件！
`void`	`clean()` 删除整个虚拟容器
`void`	`close()`
`boolean`	`exist(String fileName)` 判断文件或对象是否存在
`boolean`	`exit(String fileName)` 已过时。 `exist(String)`
`void`	`flush()` 将缓存中的对象写入到文件系统中
`VirtualContainer`	`flushContainerByName(String name)` 从缓存中刷新指定容器到文件系统中
`VirtualContainer`	`flushFileByName(String name)` 从缓存将指定对象写入到文件系统中
`ST_Loc`	`getAbsLoc()` 获取在容器中的绝对路径
`<R extends VirtualContainer> R`	`getContainer(String name, Function<Path,R> mapper)` 获取虚拟容器
`String`	`getContainerName()` 获取虚拟容器的名称
`Path`	`getContainerPath()` 获取虚拟容器所处的文件系统路径
`Path`	`getFile(String fileName)` 获取容器中的文件对象
`org.dom4j.Element`	`getObj(String fileName)` 通过文件名获取元素对象
`VirtualContainer`	`getParent()` 获取该容器所属容器
`String`	`getSysAbsPath()` 获取当前容器完整路径
`<R extends VirtualContainer> R`	`obtainContainer(String name, Function<Path,R> mapper)` 获取一个虚拟容器对象如果容器存在，那么取出元素如果容器不存在，那么创建一个新的对象
`VirtualContainer`	`putFile(Path file)` 向虚拟容器中加入文件
`Path`	`putFileWithPath(Path file)` 向虚拟容器中加入文件，并获取文件在容器中的绝对路径
`VirtualContainer`	`putObj(String fileName, org.dom4j.Element element)` 向虚拟容器加入对象
`protected VirtualContainer`	`setParent(VirtualContainer parent)` 设置所属容器

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

- 构造器详细资料
  - VirtualContainer
```
public VirtualContainer(Path fullDir)
                 throws IllegalArgumentException
```
    通过完整路径构造一个虚拟容器
    
    参数:
    
    fullDir - 容器完整路径
    
    抛出:
    
    IllegalArgumentException - 参数错误
  - VirtualContainer
```
public VirtualContainer(Path parent,
                        String dirName)
                 throws IllegalArgumentException
```
    创建一个虚拟容器
    
    参数:
    
    parent - 根目录
    
    dirName - 新建目录的名称
    
    抛出:
    
    IllegalArgumentException - 参数异常
- 方法详细资料
  - getContainerName
```
public String getContainerName()
```
    获取虚拟容器的名称
    
    返回:
    
    名称
  - getSysAbsPath
```
public String getSysAbsPath()
```
    获取当前容器完整路径
    
    返回:
    
    容器完整路径（绝对路径）
  - putFile
```
public VirtualContainer putFile(Path file)
                         throws IOException
```
    向虚拟容器中加入文件
    
    参数:
    
    file - 文件路径对象
    
    返回:
    
    this
    
    抛出:
    
    IOException - IO异常
  - putFileWithPath
```
public Path putFileWithPath(Path file)
                     throws IOException
```
    向虚拟容器中加入文件，并获取文件在容器中的绝对路径
    
    参数:
    
    file - 文件路径对象
    
    返回:
    
    null 或文件在容器中的绝对路径
    
    抛出:
    
    IOException - IO异常
  - addRaw
```
public VirtualContainer addRaw(String fileName,
                               InputStream in)
                        throws IOException
```
    向虚拟容器中直接加入流类型资源
    根据提供文件名称创建文件
    输入流内容将直接写入文件内，不做检查
    若文件已经存在，那么将会覆盖原文件！
    
    参数:
    
    fileName - 文件名称
    
    in - 输入流，流的关闭应由调用者负责
    
    返回:
    
    this
    
    抛出:
    
    IOException - 文件复制异常
  - putObj
```
public VirtualContainer putObj(String fileName,
                               org.dom4j.Element element)
```
    向虚拟容器加入对象
    
    参数:
    
    fileName - 文件名
    
    element - 元素对象
    
    返回:
    
    this
  - getObj
```
public org.dom4j.Element getObj(String fileName)
                         throws FileNotFoundException,
                                org.dom4j.DocumentException
```
    通过文件名获取元素对象
    
    参数:
    
    fileName - 文件名
    
    返回:
    
    元素对象（不含代理）
    
    抛出:
    
    FileNotFoundException - 文件不存在
    
    org.dom4j.DocumentException - 元素序列化异常
  - getFile
```
public Path getFile(String fileName)
             throws FileNotFoundException
```
    获取容器中的文件对象
    
    参数:
    
    fileName - 文件名称
    
    返回:
    
    文件路径对象
    
    抛出:
    
    FileNotFoundException - 文件不存在
  - obtainContainer
```
public <R extends VirtualContainer> R obtainContainer(String name,
                                                      Function<Path,R> mapper)
```
    获取一个虚拟容器对象
    如果容器存在，那么取出元素
    如果容器不存在，那么创建一个新的对象
    
    类型参数:
    
    R - 容器子类
    
    参数:
    
    name - 容器名称
    
    mapper - 容器构造器引用
    
    返回:
    
    新建或已经存在的容器
  - getContainer
```
public <R extends VirtualContainer> R getContainer(String name,
                                                   Function<Path,R> mapper)
                                            throws FileNotFoundException
```
    获取虚拟容器
    
    类型参数:
    
    R - 容器子类
    
    参数:
    
    name - 容器名称
    
    mapper - 容器构造器引用
    
    返回:
    
    容器对象
    
    抛出:
    
    FileNotFoundException - 文件不存在
  - getParent
```
public VirtualContainer getParent()
```
    获取该容器所属容器
    
    返回:
    
    所属容器对象
  - setParent
```
protected VirtualContainer setParent(VirtualContainer parent)
```
    设置所属容器
    
    参数:
    
    parent - 容器
    
    返回:
    
    this
  - getContainerPath
```
public Path getContainerPath()
```
    获取虚拟容器所处的文件系统路径
    
    返回:
    
    文件系统路径
  - exit
```
@Deprecated
public boolean exit(String fileName)
```
    已过时。 exist(String)
    
    判断文件或对象是否存在（错误的函数名称）
    
    参数:
    
    fileName - 文件名称
    
    返回:
    
    true - 存在;false - 不存在
  - exist
```
public boolean exist(String fileName)
```
    判断文件或对象是否存在
    
    参数:
    
    fileName - 文件名称
    
    返回:
    
    true - 存在;false - 不存在
  - clean
```
public void clean()
```
    删除整个虚拟容器
  - flush
```
public void flush()
           throws IOException
```
    将缓存中的对象写入到文件系统中
    
    抛出:
    
    IOException - 文件读写IO异常
  - flushContainerByName
```
public VirtualContainer flushContainerByName(String name)
                                      throws IOException
```
    从缓存中刷新指定容器到文件系统中
    
    参数:
    
    name - 容器名称
    
    返回:
    
    this
    
    抛出:
    
    IOException - 写入文件IO异常
  - flushFileByName
```
public VirtualContainer flushFileByName(String name)
                                 throws IOException
```
    从缓存将指定对象写入到文件系统中
    
    参数:
    
    name - 文件名称
    
    返回:
    
    this
    
    抛出:
    
    IOException - 写入文件IO异常
  - getAbsLoc
```
public ST_Loc getAbsLoc()
```
    获取在容器中的绝对路径
    
    返回:
    
    绝对路径对象
  - close
```
public void close()
           throws IOException
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    IOException

类 VirtualContainer

构造器概要

方法概要

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

构造器详细资料

VirtualContainer

VirtualContainer

方法详细资料

getContainerName

getSysAbsPath

putFile

putFileWithPath

addRaw

putObj

getObj

getFile

obtainContainer

getContainer

getParent

setParent

getContainerPath

exit

exist

clean

flush

flushContainerByName

flushFileByName

getAbsLoc

close