DiskUtils (nacos-control-plugin 2.2.3 2.2.3 API)

java.lang.Object
- com.alibaba.nacos.plugin.control.ruleactivator.DiskUtils

```
public final class DiskUtils
extends Object
```
IO operates on the utility class.

作者:

liaochuntao

嵌套类概要

嵌套类
限定符和类型类和说明

static class DiskUtils.LineIterator

嵌套类
限定符和类型	类和说明
`static class`	`DiskUtils.LineIterator`

构造器概要

构造器
构造器和说明

DiskUtils()

构造器
构造器和说明
`DiskUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`compress(String rootDir, String sourceDir, String outputFile, Checksum checksum)` Compress a folder in a directory.
`static void`	`compressIntoZipFile(String childName, InputStream inputStream, String outputFile, Checksum checksum)` Compress an input stream to zip file.
`static void`	`copyDirectory(File srcDir, File destDir)`
`static void`	`copyFile(File src, File target)`
`static File`	`createTmpFile(String prefix, String suffix)` Creates an empty file in the default temporary-file directory, using the given prefix and suffix to generate its name.
`static File`	`createTmpFile(String dir, String prefix, String suffix)` Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name.
`static byte[]`	`decompress(String sourceFile, Checksum checksum)` Unzip the target file to byte array.
`static void`	`decompress(String sourceFile, String outputDir, Checksum checksum)` Unzip the target file to the specified folder.
`static void`	`deleteDirectory(String path)`
`static void`	`deleteDirThenMkdir(String path)`
`static boolean`	`deleteFile(String path, String fileName)` delete target file.
`static void`	`deleteQuietly(File file)`
`static void`	`deleteQuietly(Path path)`
`static void`	`forceMkdir(File file)`
`static void`	`forceMkdir(String path)`
`static DiskUtils.LineIterator`	`lineIterator(File file)` Returns an Iterator for the lines in a `File` using the default encoding for the VM.
`static DiskUtils.LineIterator`	`lineIterator(File file, String encoding)` Returns an Iterator for the lines in a `File`.
`static File`	`openFile(String path, String fileName)`
`static File`	`openFile(String path, String fileName, boolean rewrite)` open file.
`static String`	`readFile(File file)` read this file content.
`static String`	`readFile(InputStream is)` read file content by `InputStream`.
`static String`	`readFile(String path, String fileName)` read file which under the path.
`static byte[]`	`readFileBytes(File file)` read this file content then return bytes.
`static byte[]`	`readFileBytes(String path, String fileName)`
`static void`	`touch(File file)` Implements the same behaviour as the "touch" utility on Unix.
`static void`	`touch(String path, String fileName)`
`static boolean`	`writeFile(File file, byte[] content, boolean append)` Writes the contents to the target file.

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

- 构造器详细资料
  - DiskUtils
```
public DiskUtils()
```
- 方法详细资料
  - touch
```
public static void touch(String path,
                         String fileName)
                  throws IOException
```
    抛出:
    
    IOException
  - touch
```
public static void touch(File file)
                  throws IOException
```
    Implements the same behaviour as the "touch" utility on Unix. It creates a new file with size 0 or, if the file exists already, it is opened and closed without modifying it, but updating the file date and time.
    NOTE: As from v1.3, this method throws an IOException if the last modified date of the file cannot be set. Also, as from v1.3 this method creates parent directories if they do not exist.
    
    参数:
    
    file - the File to touch
    
    抛出:
    
    IOException - If an I/O problem occurs
  - createTmpFile
```
public static File createTmpFile(String dir,
                                 String prefix,
                                 String suffix)
                          throws IOException
```
    Creates a new empty file in the specified directory, using the given prefix and suffix strings to generate its name. The resulting Path is associated with the same FileSystem as the given directory.
    The details as to how the name of the file is constructed is implementation dependent and therefore not specified. Where possible the prefix and suffix are used to construct candidate names in the same manner as the File.createTempFile(String, String, File) method.
    
    参数:
    
    dir - the path to directory in which to create the file
    
    prefix - the prefix string to be used in generating the file's name; may be null
    
    suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
    
    返回:
    
    the path to the newly created file that did not exist before this method was invoked
    
    抛出:
    
    IllegalArgumentException - if the prefix or suffix parameters cannot be used to generate a candidate file name
    
    UnsupportedOperationException - if the array contains an attribute that cannot be set atomically when creating the directory
    
    IOException - if an I/O error occurs or dir does not exist
    
    SecurityException - In the case of the default provider, and a security manager is installed, the checkWrite method is invoked to check write access to the file.
  - createTmpFile
```
public static File createTmpFile(String prefix,
                                 String suffix)
                          throws IOException
```
    Creates an empty file in the default temporary-file directory, using the given prefix and suffix to generate its name. The resulting Path is associated with the default FileSystem.
    
    参数:
    
    prefix - the prefix string to be used in generating the file's name; may be null
    
    suffix - the suffix string to be used in generating the file's name; may be null, in which case ".tmp" is used
    
    返回:
    
    the path to the newly created file that did not exist before this method was invoked
    
    抛出:
    
    IllegalArgumentException - if the prefix or suffix parameters cannot be used to generate a candidate file name
    
    UnsupportedOperationException - if the array contains an attribute that cannot be set atomically when creating the directory
    
    IOException - if an I/O error occurs or the temporary-file directory does not exist
    
    SecurityException - In the case of the default provider, and a security manager is installed, the checkWrite method is invoked to check write access to the file.
  - readFile
```
public static String readFile(String path,
                              String fileName)
```
    read file which under the path.
    
    参数:
    
    path - directory
    
    fileName - filename
    
    返回:
    
    content
  - readFile
```
public static String readFile(InputStream is)
```
    read file content by InputStream.
    
    参数:
    
    is - InputStream
    
    返回:
    
    content
  - readFile
```
public static String readFile(File file)
```
    read this file content.
    
    参数:
    
    file - File
    
    返回:
    
    content
  - readFileBytes
```
public static byte[] readFileBytes(File file)
```
    read this file content then return bytes.
    
    参数:
    
    file - File
    
    返回:
    
    content bytes
  - readFileBytes
```
public static byte[] readFileBytes(String path,
                                   String fileName)
```
  - writeFile
```
public static boolean writeFile(File file,
                                byte[] content,
                                boolean append)
```
    Writes the contents to the target file.
    
    参数:
    
    file - target file
    
    content - content
    
    append - write append mode
    
    返回:
    
    write success
  - deleteQuietly
```
public static void deleteQuietly(File file)
```
  - deleteQuietly
```
public static void deleteQuietly(Path path)
```
  - deleteFile
```
public static boolean deleteFile(String path,
                                 String fileName)
```
    delete target file.
    
    参数:
    
    path - directory
    
    fileName - filename
    
    返回:
    
    delete success
  - deleteDirectory
```
public static void deleteDirectory(String path)
                            throws IOException
```
    抛出:
    
    IOException
  - forceMkdir
```
public static void forceMkdir(String path)
                       throws IOException
```
    抛出:
    
    IOException
  - forceMkdir
```
public static void forceMkdir(File file)
                       throws IOException
```
    抛出:
    
    IOException
  - deleteDirThenMkdir
```
public static void deleteDirThenMkdir(String path)
                               throws IOException
```
    抛出:
    
    IOException
  - copyDirectory
```
public static void copyDirectory(File srcDir,
                                 File destDir)
                          throws IOException
```
    抛出:
    
    IOException
  - copyFile
```
public static void copyFile(File src,
                            File target)
                     throws IOException
```
    抛出:
    
    IOException
  - openFile
```
public static File openFile(String path,
                            String fileName)
```
  - openFile
```
public static File openFile(String path,
                            String fileName,
                            boolean rewrite)
```
    open file.
    
    参数:
    
    path - directory
    
    fileName - filename
    
    rewrite - if rewrite is true, will delete old file and create new one
    
    返回:
    
    File
  - compress
```
public static void compress(String rootDir,
                            String sourceDir,
                            String outputFile,
                            Checksum checksum)
                     throws IOException
```
    Compress a folder in a directory.
    
    参数:
    
    rootDir - directory
    
    sourceDir - folder
    
    outputFile - output file
    
    checksum - checksum
    
    抛出:
    
    IOException - IOException
  - compressIntoZipFile
```
public static void compressIntoZipFile(String childName,
                                       InputStream inputStream,
                                       String outputFile,
                                       Checksum checksum)
                                throws IOException
```
    Compress an input stream to zip file.
    
    参数:
    
    childName - child name in zip file
    
    inputStream - input stream needed compress
    
    outputFile - output file
    
    checksum - check sum
    
    抛出:
    
    IOException - IOException during compress
  - decompress
```
public static void decompress(String sourceFile,
                              String outputDir,
                              Checksum checksum)
                       throws IOException
```
    Unzip the target file to the specified folder.
    
    参数:
    
    sourceFile - target file
    
    outputDir - specified folder
    
    checksum - checksum
    
    抛出:
    
    IOException - IOException
  - decompress
```
public static byte[] decompress(String sourceFile,
                                Checksum checksum)
                         throws IOException
```
    Unzip the target file to byte array.
    
    参数:
    
    sourceFile - target file
    
    checksum - checksum
    
    返回:
    
    decompress byte array
    
    抛出:
    
    IOException - IOException during decompress
  - lineIterator
```
public static DiskUtils.LineIterator lineIterator(File file,
                                                  String encoding)
                                           throws IOException
```
    Returns an Iterator for the lines in a File.
    This method opens an InputStream for the file. When you have finished with the iterator you should close the stream to free internal resources. This can be done by calling the LineIterator.close() or LineIterator.closeQuietly(org.apache.commons.io.LineIterator) method.
    The recommended usage pattern is:
```
 LineIterator it = FileUtils.lineIterator(file, "UTF-8");
 try {
   while (it.hasNext()) {
     String line = it.nextLine();
     /// do something with line
   }
 } finally {
   LineIterator.closeQuietly(iterator);
 }
 
```
    If an exception occurs during the creation of the iterator, the underlying stream is closed.
    参数:
    
    file - the file to open for input, must not be null
    
    encoding - the encoding to use, null means platform default
    
    返回:
    
    an Iterator of the lines in the file, never null
    
    抛出:
    
    IOException - in case of an I/O error (file closed)
    
    从以下版本开始:
    
    1.2
  - lineIterator
```
public static DiskUtils.LineIterator lineIterator(File file)
                                           throws IOException
```
    Returns an Iterator for the lines in a File using the default encoding for the VM.
    
    参数:
    
    file - the file to open for input, must not be null
    
    返回:
    
    an Iterator of the lines in the file, never null
    
    抛出:
    
    IOException - in case of an I/O error (file closed)
    
    从以下版本开始:
    
    1.3
    
    另请参阅:
    
    lineIterator(File, String)

类 DiskUtils

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

DiskUtils

方法详细资料

touch

touch

createTmpFile

createTmpFile

readFile

readFile

readFile

readFileBytes

readFileBytes

writeFile

deleteQuietly

deleteQuietly

deleteFile

deleteDirectory

forceMkdir

forceMkdir

deleteDirThenMkdir

copyDirectory

copyFile

openFile

openFile

compress

compressIntoZipFile

decompress

decompress

lineIterator

lineIterator