com.graphdbapi.file

Interface FileObject

public interface FileObject

用于IO的文件操作接口

Method Summary

Modifier and Type	Method and Description
BufferedReaderObject	bufferedReader(java.lang.String path, java.nio.charset.Charset charsets) BufferedReader流
BufferedWriterObject	bufferedWriter(java.lang.String path, boolean append, java.nio.charset.Charset charsets) BufferedWriter流
default BufferedWriterObject	bufferedWriter(java.lang.String path, java.nio.charset.Charset charsets) BufferedWriter流(默认覆盖文件内容)
boolean	copy(java.lang.String path, java.lang.String newPath) 复制文件/文件夹
boolean	createDir(java.lang.String path) 创建文件夹
boolean	createDirs(java.lang.String path) 递归创建文件夹
boolean	createFile(java.lang.String path) 创建文件
default CsvReader	csvReader(java.lang.String path, java.nio.charset.Charset charset) 获取csvReader(默认定界符‘,’)
CsvReader	csvReader(java.lang.String path, java.lang.String delimiter, java.nio.charset.Charset charset) 获取csvReader
default CsvWriter	csvWriter(java.lang.String path, java.nio.charset.Charset charset) 获取csvWriter(默认定界符‘,’)
CsvWriter	csvWriter(java.lang.String path, java.lang.String delimiter, java.nio.charset.Charset charset) 获取csvWriter
boolean	delete(java.lang.String path) 删除文件/文件夹。 文件：若删除成功，返回true。若删除失败，返回false。 文件夹：若文件夹中有文件，则抛出异常
boolean	deleteForce(java.lang.String path) 强制删除文件/文件夹。 文件：若删除成功，返回true。若删除失败，返回false。 文件夹：删除所有文件
java.lang.String	getBasePath() 获取基础路径
boolean	isDir(java.lang.String path) 是否是文件夹
boolean	isExist(java.lang.String path) 文件/文件夹，是否存在
long	length(java.lang.String path) 文件大小
java.util.List<java.lang.String>	list(java.lang.String path) 查看文件夹下所有 文件/文件夹 名称列表
RandomAccessFileObject	randomAccessFile(java.lang.String path, java.lang.String mode) 返回RandomAccessFileObject
void	releaseResources() 主动释放所有FileObject产生的资源
boolean	rename(java.lang.String oldPath, java.lang.String newName) 修改名称
boolean	sendFile(int affinity, java.lang.String path, boolean overwrite) 指定affinity，同步发送文件。若远端不存在文件夹，默认为远端创建。单机版不可用。
java.util.concurrent.Future<java.lang.Boolean>	sendFileAsync(int affinity, java.lang.String path, boolean overwrite) 指定affinity，异步发送文件。若远端不存在文件夹，默认为远端创建。单机版不可用。

Method Detail

isExist

boolean isExist(java.lang.String path)
         throws GraphDbFileIOException

文件/文件夹，是否存在

Parameters:

path - 文件路径

Returns:

true存在，false不存在

Throws:

GraphDbFileIOException - IO异常

isDir

boolean isDir(java.lang.String path)
       throws GraphDbFileIOException

是否是文件夹

Parameters:

path - 文件路径

Returns:

true文件夹，false文件

Throws:

GraphDbFileIOException - IO异常

list

java.util.List<java.lang.String> list(java.lang.String path)
                               throws GraphDbFileIOException

查看文件夹下所有 文件/文件夹 名称列表

Parameters:

path - 文件夹路径

Returns:

文件/文件夹 名称列表

Throws:

GraphDbFileIOException - IO异常

length

long length(java.lang.String path)
     throws GraphDbFileIOException

文件大小

Parameters:

path - 文件路径

Returns:

文件大小

Throws:

GraphDbFileIOException - IO异常

rename

boolean rename(java.lang.String oldPath,
               java.lang.String newName)
        throws GraphDbFileIOException

修改名称

Parameters:

oldPath - 旧路经

newName - 新名称

Returns:

{true 修改成功 | false 修改失败}

Throws:

GraphDbFileIOException - IO异常

createFile

boolean createFile(java.lang.String path)
            throws GraphDbFileIOException

创建文件

Parameters:

path - 文件路径

Returns:

true创建成功，false创建失败

Throws:

GraphDbFileIOException - IO异常

createDir

boolean createDir(java.lang.String path)
           throws GraphDbFileIOException

创建文件夹

Parameters:

path - 文件路径

Returns:

true创建成功，false创建失败

Throws:

GraphDbFileIOException - IO异常

createDirs

boolean createDirs(java.lang.String path)
            throws GraphDbFileIOException

递归创建文件夹

Parameters:

path - 文件路径

Returns:

true创建成功，false创建失败

Throws:

GraphDbFileIOException - IO异常

delete

boolean delete(java.lang.String path)
        throws GraphDbFileIOException

删除文件/文件夹。 文件：若删除成功，返回true。若删除失败，返回false。 文件夹：若文件夹中有文件，则抛出异常

Parameters:

path - 文件/文件夹路径

Returns:

true删除成功，false删除失败

Throws:

GraphDbFileIOException - IO异常

deleteForce

boolean deleteForce(java.lang.String path)
             throws GraphDbFileIOException

强制删除文件/文件夹。 文件：若删除成功，返回true。若删除失败，返回false。 文件夹：删除所有文件

Parameters:

path - 文件/文件夹路径

Returns:

true删除成功，false删除失败

Throws:

GraphDbFileIOException - IO异常

copy

boolean copy(java.lang.String path,
             java.lang.String newPath)
      throws GraphDbFileIOException

复制文件/文件夹

Parameters:

path - 文件/文件夹路径

newPath - 需要复制到的路径

Returns:

true复制成功，false复制失败

Throws:

GraphDbFileIOException - IO异常

sendFile

boolean sendFile(int affinity,
                 java.lang.String path,
                 boolean overwrite)
          throws GraphDbFileIOException

指定affinity，同步发送文件。若远端不存在文件夹，默认为远端创建。单机版不可用。

Parameters:

affinity - 节点编号

path - 文件路径

overwrite - 若远端有同盟文件是否覆盖。true覆盖，false跳过

Returns:

true发送成功，false发送失败

Throws:

GraphDbFileIOException - IO异常

sendFileAsync

java.util.concurrent.Future<java.lang.Boolean> sendFileAsync(int affinity,
                                                             java.lang.String path,
                                                             boolean overwrite)

指定affinity，异步发送文件。若远端不存在文件夹，默认为远端创建。单机版不可用。

Parameters:

affinity - 节点编号

path - 文件路径

overwrite - 若远端有同盟文件是否覆盖。true覆盖，false跳过

Returns:

异步对象

bufferedReader

BufferedReaderObject bufferedReader(java.lang.String path,
                                    java.nio.charset.Charset charsets)
                             throws GraphDbFileIOException

BufferedReader流

Parameters:

path - 文件路径

charsets - 字符编码

Returns:

BufferedReader流

Throws:

GraphDbFileIOException - IO异常

bufferedWriter

default BufferedWriterObject bufferedWriter(java.lang.String path,
                                            java.nio.charset.Charset charsets)
                                     throws GraphDbFileIOException

BufferedWriter流(默认覆盖文件内容)

Parameters:

path - 文件路径

charsets - 字符编码

Returns:

BufferedWriter流

Throws:

GraphDbFileIOException - IO异常

bufferedWriter

BufferedWriterObject bufferedWriter(java.lang.String path,
                                    boolean append,
                                    java.nio.charset.Charset charsets)
                             throws GraphDbFileIOException

BufferedWriter流

Parameters:

path - 文件路径

append - 写入时追加（true）或覆盖（false）

charsets - 字符编码

Returns:

BufferedWriter流

Throws:

GraphDbFileIOException - IO异常

randomAccessFile

RandomAccessFileObject randomAccessFile(java.lang.String path,
                                        java.lang.String mode)
                                 throws GraphDbFileIOException

返回RandomAccessFileObject

Parameters:

path - 文件路径

mode - 读写模式（r:只读 rw:读、写 rws:读、写同步，刷新内容、元数据 rwd:读、写同步，刷新内容）

Returns:

BufferedReader流

Throws:

GraphDbFileIOException - IO异常

csvReader

CsvReader csvReader(java.lang.String path,
                    java.lang.String delimiter,
                    java.nio.charset.Charset charset)
             throws java.lang.Exception

获取csvReader

Parameters:

path - csv文件路径

delimiter - csv的自定义定界符

charset - 字符集编码格式

Returns:

CsvReader

Throws:

java.lang.Exception - 所读文件不存在

csvReader

default CsvReader csvReader(java.lang.String path,
                            java.nio.charset.Charset charset)
                     throws java.lang.Exception

获取csvReader(默认定界符‘,’)

Parameters:

path - csv文件路径

charset - 字符集编码格式

Returns:

CsvReader

Throws:

java.lang.Exception - 所读文件不存在

csvWriter

CsvWriter csvWriter(java.lang.String path,
                    java.lang.String delimiter,
                    java.nio.charset.Charset charset)

获取csvWriter

Parameters:

path - csv文件路径

delimiter - csv的自定义定界符

charset - 字符集编码格式

Returns:

CsvWriter

csvWriter

default CsvWriter csvWriter(java.lang.String path,
                            java.nio.charset.Charset charset)

获取csvWriter(默认定界符‘,’)

Parameters:

path - csv文件路径

charset - 字符集编码格式

Returns:

CsvWriter

releaseResources

void releaseResources()
               throws GraphDbFileIOException

主动释放所有FileObject产生的资源

Throws:

GraphDbFileIOException - IO异常

getBasePath

java.lang.String getBasePath()

获取基础路径

Returns:

获取基础路径