IOUtilities (snuggletex-core 1.5.5 API)

java.lang.Object
- uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

```
public final class IOUtilities
extends java.lang.Object
```
A collection of vaguely useful utilities for doing common I/O and File-related tasks.
(This is a cut-down version of the Class of the same name in ph-commons-util.)

字段概要

字段
限定符和类型	字段和说明
`static int`	`BUFFER_SIZE` Buffer size when transferring streams
`static int`	`MAX_TEXT_STREAM_SIZE` Maximum size of characters we'll read from a text stream before complaining

构造器概要

构造器
构造器和说明

IOUtilities()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static void`	`ensureClose(java.io.Closeable... streams)` Ensures that as many of the given `Closeable`s are closed.
`static java.io.File`	`ensureDirectoryCreated(java.io.File directory)` Simple method to ensure that a given directory exists.
`static java.io.File`	`ensureFileCreated(java.io.File file)` Simple method to ensure that a given File exists.
`static java.lang.String`	`readCharacterStream(java.io.Reader reader)` Reads all character data from the given Reader, returning a String containing all of the data.
`static java.lang.String`	`readUnicodeFile(java.io.File file)` Same as `readUnicodeStream(InputStream)` but accepts a plain File object for convenience
`static java.lang.String`	`readUnicodeStream(java.io.InputStream in)` Same as `readCharacterStream(Reader)` but assumes the stream is encoded as UTF-8.
`static void`	`transfer(java.io.FileInputStream fileInStream, java.io.FileOutputStream fileOutStream)` Version of `transfer(InputStream, OutputStream)` for File streams that uses NIO to do a hopefully more efficient transfer.
`static void`	`transfer(java.io.InputStream inStream, java.io.OutputStream outStream)` "Transfers" data from the given InputStream to the given OutputStream, closing both streams once the InputStream has been exhausted.
`static void`	`transfer(java.io.InputStream inStream, java.io.OutputStream outStream, boolean closeOutputStream)` "Transfers" data from the given InputStream to the given OutputStream, closing the InputStream afterwards.
`static void`	`transfer(java.io.InputStream inStream, java.io.OutputStream outStream, boolean closeInputStream, boolean closeOutputStream)` "Transfers" data from the given InputStream to the given OutputStream, optionally closing the given input and output streams afterwards.

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

- 字段详细资料
  - BUFFER_SIZE
```
public static final int BUFFER_SIZE
```
    Buffer size when transferring streams
    
    另请参阅:
    
    常量字段值
  - MAX_TEXT_STREAM_SIZE
```
public static final int MAX_TEXT_STREAM_SIZE
```
    Maximum size of characters we'll read from a text stream before complaining
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - IOUtilities
```
public IOUtilities()
```
- 方法详细资料
  - ensureDirectoryCreated
```
public static java.io.File ensureDirectoryCreated(java.io.File directory)
                                           throws java.io.IOException
```
    Simple method to ensure that a given directory exists. If the directory does not exist then it is created, along with all required parents.
    
    抛出:
    
    java.io.IOException - if creation could not succeed for some reason.
  - ensureFileCreated
```
public static java.io.File ensureFileCreated(java.io.File file)
                                      throws java.io.IOException
```
    Simple method to ensure that a given File exists. If the File does not exist then it is created, along with all required parent directories.
    
    抛出:
    
    java.io.IOException - if creation could not succeed for some reason.
  - ensureClose
```
public static void ensureClose(java.io.Closeable... streams)
                        throws java.io.IOException
```
    Ensures that as many of the given Closeables are closed. If any fail to close, the first Exception is thrown after an attempt has been made to close the rest.
    For convenience, any number of the stream may be null, in which case they will be ignored.
    
    参数:
    
    streams - "streams" to close
    
    抛出:
    
    java.io.IOException
  - transfer
```
public static void transfer(java.io.InputStream inStream,
                            java.io.OutputStream outStream)
                     throws java.io.IOException
```
    "Transfers" data from the given InputStream to the given OutputStream, closing both streams once the InputStream has been exhausted.
    This will check to see if both streams are File streams and, if so, use the transfer(FileInputStream, FileOutputStream) version of this method instead.
    
    参数:
    
    inStream -
    
    outStream -
    
    抛出:
    
    java.io.IOException
  - transfer
```
public static void transfer(java.io.FileInputStream fileInStream,
                            java.io.FileOutputStream fileOutStream)
                     throws java.io.IOException
```
    Version of transfer(InputStream, OutputStream) for File streams that uses NIO to do a hopefully more efficient transfer.
    
    抛出:
    
    java.io.IOException
  - transfer
```
public static void transfer(java.io.InputStream inStream,
                            java.io.OutputStream outStream,
                            boolean closeOutputStream)
                     throws java.io.IOException
```
    "Transfers" data from the given InputStream to the given OutputStream, closing the InputStream afterwards. If the parameter closeOutputStream is true then the OutputStream is closed too. If not, it will be flushed.
    
    参数:
    
    inStream -
    
    outStream -
    
    抛出:
    
    java.io.IOException
  - transfer
```
public static void transfer(java.io.InputStream inStream,
                            java.io.OutputStream outStream,
                            boolean closeInputStream,
                            boolean closeOutputStream)
                     throws java.io.IOException
```
    "Transfers" data from the given InputStream to the given OutputStream, optionally closing the given input and output streams afterwards.
    Even if not closing the output stream, it will still be flushed.
    
    参数:
    
    inStream -
    
    outStream -
    
    抛出:
    
    java.io.IOException
  - readCharacterStream
```
public static java.lang.String readCharacterStream(java.io.Reader reader)
                                            throws java.io.IOException
```
    Reads all character data from the given Reader, returning a String containing all of the data. The Reader will be buffered for efficiency and will be closed once finished with. Be careful reading in very large files - we will barf if MAX_FILE_SIZE is passed as a safety precaution.
    
    参数:
    
    reader - source of string data
    
    返回:
    
    String representing the data read
    
    抛出:
    
    java.io.IOException
  - readUnicodeStream
```
public static java.lang.String readUnicodeStream(java.io.InputStream in)
                                          throws java.io.IOException
```
    Same as readCharacterStream(Reader) but assumes the stream is encoded as UTF-8.
    
    参数:
    
    in - InputStream supplying character data
    
    返回:
    
    String representing the data read in
    
    抛出:
    
    java.io.IOException
  - readUnicodeFile
```
public static java.lang.String readUnicodeFile(java.io.File file)
                                        throws java.io.IOException
```
    Same as readUnicodeStream(InputStream) but accepts a plain File object for convenience
    
    参数:
    
    file - File to read from
    
    返回:
    
    String representing the data we read in
    
    抛出:
    
    java.io.IOException

类 IOUtilities

字段概要

构造器概要

方法概要

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

字段详细资料

BUFFER_SIZE

MAX_TEXT_STREAM_SIZE

构造器详细资料

IOUtilities

方法详细资料

ensureDirectoryCreated

ensureFileCreated

ensureClose

transfer

transfer

transfer

transfer

readCharacterStream

readUnicodeStream

readUnicodeFile