IO (parent 4.3.1 API)

java.lang.Object
- aQute.lib.io.IO

```
public class IO
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static File home

static File JAVA_HOME

static OutputStream nullStream

static Writer nullWriter

static File work

Fields
Modifier and Type	Field and Description
`static File`	`home`
`static File`	`JAVA_HOME`
`static OutputStream`	`nullStream`
`static Writer`	`nullWriter`
`static File`	`work`

Constructor Summary

Constructors
Constructor and Description

IO()

Constructors
Constructor and Description
`IO()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`absolutePath(File file)`
`static String`	`absolutePath(Path path)`
`static Throwable`	`close(AutoCloseable in)`
`static Throwable`	`close(Closeable in)`
`static String`	`collect(ByteBuffer bb, Charset encoding)`
`static String`	`collect(File file)`
`static String`	`collect(File file, Charset encoding)`
`static String`	`collect(File file, String encoding)`
`static String`	`collect(InputStream in)`
`static String`	`collect(InputStream in, Charset encoding)`
`static String`	`collect(InputStream in, String encoding)`
`static String`	`collect(Path path)`
`static String`	`collect(Path path, Charset encoding)`
`static String`	`collect(Reader r)`
`static String`	`collect(String path)`
`static String`	`collect(URL url)`
`static String`	`collect(URL url, Charset encoding)`
`static String`	`collect(URL url, String encoding)`
`static File`	`copy(byte[] data, File file)`
`static OutputStream`	`copy(byte[] data, OutputStream out)`
`static Path`	`copy(byte[] data, Path path)`
`static Writer`	`copy(byte[] data, Writer w)`
`static DataOutput`	`copy(ByteBuffer bb, DataOutput out)`
`static OutputStream`	`copy(ByteBuffer bb, OutputStream out)`
`static OutputStream`	`copy(Collection<?> c, OutputStream out)`
`static File`	`copy(File src, File tgt)`
`static MessageDigest`	`copy(File file, MessageDigest md)`
`static OutputStream`	`copy(File file, OutputStream out)`
`static byte[]`	`copy(InputStream in, byte[] data)`
`static byte[]`	`copy(InputStream in, byte[] data, int off, int len)`
`static ByteBuffer`	`copy(InputStream in, ByteBuffer bb)`
`static ByteBufferOutputStream`	`copy(InputStream in, ByteBufferOutputStream out)`
`static DataOutput`	`copy(InputStream in, DataOutput out)`
`static File`	`copy(InputStream in, File file)`
`static MessageDigest`	`copy(InputStream in, MessageDigest md)`
`static OutputStream`	`copy(InputStream in, OutputStream out)`
`static Path`	`copy(InputStream in, Path path)`
`static URL`	`copy(InputStream in, URL url)`
`static URL`	`copy(InputStream in, URL url, String method)`
`static WritableByteChannel`	`copy(InputStream in, WritableByteChannel out)`
`static Writer`	`copy(InputStream in, Writer w)`
`static Writer`	`copy(InputStream in, Writer w, Charset charset)`
`static Writer`	`copy(InputStream in, Writer w, String charset)`
`static MessageDigest`	`copy(Path path, MessageDigest md)`
`static OutputStream`	`copy(Path path, OutputStream out)`
`static Path`	`copy(Path src, Path tgt)`
`static MessageDigest`	`copy(ReadableByteChannel in, MessageDigest md)`
`static OutputStream`	`copy(ReadableByteChannel in, OutputStream out)`
`static WritableByteChannel`	`copy(ReadableByteChannel in, WritableByteChannel out)`
`static OutputStream`	`copy(Reader r, OutputStream out)`
`static OutputStream`	`copy(Reader r, OutputStream out, Charset charset)`
`static OutputStream`	`copy(Reader r, OutputStream out, String charset)`
`static Writer`	`copy(Reader r, Writer w)`
`static File`	`copy(URLConnection conn, File file)`
`static MessageDigest`	`copy(URLConnection conn, MessageDigest md)`
`static File`	`copy(URL url, File file)`
`static MessageDigest`	`copy(URL url, MessageDigest md)`
`static boolean`	`createSymbolicLink(File link, File target)`
`static boolean`	`createSymbolicLink(Path link, Path target)`
`static boolean`	`createSymbolicLinkOrCopy(File link, File target)` Creates a symbolic link from `link` to the `target`, or copies `target` to `link` if running on Windows.
`static boolean`	`createSymbolicLinkOrCopy(Path link, Path target)` Creates a symbolic link from `link` to the `target`, or copies `target` to `link` if running on Windows.
`static File`	`createTempFile(File directory, String pattern, String suffix)` Create a temporary file.
`static CharBuffer`	`decode(ByteBuffer bb, Charset encoding)`
`static void`	`delete(File file)` Deletes the specified file.
`static void`	`delete(Path path)` Deletes the specified path.
`static void`	`deleteWithException(File file)` Deletes the specified file.
`static void`	`deleteWithException(Path path)` Deletes the specified path.
`static long`	`drain(InputStream in)`
`static ByteBuffer`	`encode(CharBuffer cb, Charset encoding)`
`static File`	`getBasedFile(File base, String file)`
`static Path`	`getBasedPath(Path base, String file)`
`static String`	`getExtension(String fileName, String deflt)`
`static File`	`getFile(File base, String file)`
`static File`	`getFile(String file)`
`static Path`	`getPath(Path base, String file)`
`static Path`	`getPath(String file)`
`static void`	`initialize(File dir)` Deletes and creates directories
`static boolean`	`isSymbolicLink(File link)`
`static boolean`	`isSymbolicLink(Path link)`
`static boolean`	`isWindows()`
`static File`	`mkdirs(File dir)`
`static Path`	`mkdirs(Path dir)`
`static String`	`normalizePath(File file)`
`static String`	`normalizePath(Path path)`
`static String`	`normalizePath(String path)`
`static OutputStream`	`outputStream(File file)`
`static OutputStream`	`outputStream(Path path)`
`static byte[]`	`read(ByteBuffer bb)`
`static byte[]`	`read(File file)`
`static byte[]`	`read(InputStream in)`
`static ByteBuffer`	`read(Path path)`
`static byte[]`	`read(URL url)`
`static FileChannel`	`readChannel(Path path)`
`static BufferedReader`	`reader(ByteBuffer bb, Charset encoding)`
`static BufferedReader`	`reader(CharBuffer cb)`
`static BufferedReader`	`reader(File file)`
`static BufferedReader`	`reader(File file, Charset encoding)`
`static BufferedReader`	`reader(File file, String encoding)`
`static BufferedReader`	`reader(InputStream in)`
`static BufferedReader`	`reader(InputStream in, Charset encoding)`
`static BufferedReader`	`reader(InputStream in, String encoding)`
`static BufferedReader`	`reader(Path path, Charset encoding)`
`static BufferedReader`	`reader(ReadableByteChannel in, Charset encoding)`
`static BufferedReader`	`reader(String s)`
`static String`	`readUTF(DataInput in)`
`static File`	`rename(File from, File to)` Renames `from` to `to` replacing the target file if necessary.
`static Path`	`rename(Path from, Path to)` Renames `from` to `to` replacing the target file if necessary.
`static void`	`store(Object o, File file)`
`static void`	`store(Object o, File file, String encoding)`
`static void`	`store(Object o, OutputStream out)`
`static void`	`store(Object o, OutputStream out, Charset encoding)`
`static void`	`store(Object o, OutputStream out, String encoding)`
`static void`	`store(Object o, Path path, Charset encoding)`
`static void`	`store(Object o, Writer w)`
`static InputStream`	`stream(byte[] data)`
`static InputStream`	`stream(ByteBuffer bb)`
`static InputStream`	`stream(File file)`
`static InputStream`	`stream(Path path)`
`static InputStream`	`stream(String s)`
`static InputStream`	`stream(String s, Charset encoding)`
`static InputStream`	`stream(String s, String encoding)`
`static InputStream`	`stream(URL url)`
`static String`	`toSafeFileName(String string)`
`static URL`	`toURL(String s, File base)`
`static Collection<File>`	`tree(File current)`
`static Collection<File>`	`tree(File current, String glob)`
`static void`	`write(byte[] data, File file)`
`static void`	`write(byte[] data, OutputStream out)`
`static FileChannel`	`writeChannel(Path path)`
`static PrintWriter`	`writer(File file)`
`static PrintWriter`	`writer(File file, Charset encoding)`
`static PrintWriter`	`writer(File file, String encoding)`
`static PrintWriter`	`writer(OutputStream out)`
`static PrintWriter`	`writer(OutputStream out, Charset encoding)`
`static PrintWriter`	`writer(OutputStream out, String encoding)`
`static PrintWriter`	`writer(Path path)`
`static PrintWriter`	`writer(Path path, Charset encoding)`
`static PrintWriter`	`writer(WritableByteChannel out, Charset encoding)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

work
```
public static final File work
```

home
```
public static final File home
```

JAVA_HOME
```
public static final File JAVA_HOME
```

nullStream

public static final OutputStream nullStream

nullWriter
```
public static final Writer nullWriter
```

Constructor Detail
- IO
```
public IO()
```

Method Detail

getExtension

public static String getExtension(String fileName,
                                  String deflt)

tree

public static Collection<File> tree(File current)

tree

public static Collection<File> tree(File current,
                                    String glob)

copy

public static File copy(byte[] data,
                        File file)
                 throws IOException

Throws:: IOException

copy

public static Path copy(byte[] data,
                        Path path)
                 throws IOException

Throws:: IOException

copy

public static Writer copy(byte[] data,
                          Writer w)
                   throws IOException

Throws:: IOException

copy

public static OutputStream copy(byte[] data,
                                OutputStream out)
                         throws IOException

Throws:: IOException

copy

public static Writer copy(Reader r,
                          Writer w)
                   throws IOException

Throws:: IOException

copy

public static OutputStream copy(Reader r,
                                OutputStream out)
                         throws IOException

Throws:: IOException

copy

public static OutputStream copy(Reader r,
                                OutputStream out,
                                String charset)
                         throws IOException

Throws:: IOException

copy

public static OutputStream copy(Reader r,
                                OutputStream out,
                                Charset charset)
                         throws IOException

Throws:: IOException

copy

public static Writer copy(InputStream in,
                          Writer w)
                   throws IOException

Throws:: IOException

copy

public static Writer copy(InputStream in,
                          Writer w,
                          String charset)
                   throws IOException

Throws:: IOException

copy

public static Writer copy(InputStream in,
                          Writer w,
                          Charset charset)
                   throws IOException

Throws:: IOException

copy

public static OutputStream copy(InputStream in,
                                OutputStream out)
                         throws IOException

Throws:: IOException

copy

public static ByteBufferOutputStream copy(InputStream in,
                                          ByteBufferOutputStream out)
                                   throws IOException

Throws:: IOException

copy

public static DataOutput copy(InputStream in,
                              DataOutput out)
                       throws IOException

Throws:: IOException

copy

public static WritableByteChannel copy(ReadableByteChannel in,
                                       WritableByteChannel out)
                                throws IOException

Throws:: IOException

copy

public static ByteBuffer copy(InputStream in,
                              ByteBuffer bb)
                       throws IOException

Throws:: IOException

copy

public static byte[] copy(InputStream in,
                          byte[] data)
                   throws IOException

Throws:: IOException

copy

public static byte[] copy(InputStream in,
                          byte[] data,
                          int off,
                          int len)
                   throws IOException

Throws:: IOException

copy

public static OutputStream copy(ByteBuffer bb,
                                OutputStream out)
                         throws IOException

Throws:: IOException

copy

public static DataOutput copy(ByteBuffer bb,
                              DataOutput out)
                       throws IOException

Throws:: IOException

copy

public static MessageDigest copy(URL url,
                                 MessageDigest md)
                          throws IOException

Throws:: IOException

copy

public static MessageDigest copy(File file,
                                 MessageDigest md)
                          throws IOException

Throws:: IOException

copy

public static MessageDigest copy(Path path,
                                 MessageDigest md)
                          throws IOException

Throws:: IOException

copy

public static MessageDigest copy(URLConnection conn,
                                 MessageDigest md)
                          throws IOException

Throws:: IOException

copy

public static MessageDigest copy(InputStream in,
                                 MessageDigest md)
                          throws IOException

Throws:: IOException

copy

public static MessageDigest copy(ReadableByteChannel in,
                                 MessageDigest md)
                          throws IOException

Throws:: IOException

copy

public static File copy(URL url,
                        File file)
                 throws IOException

Throws:: IOException

copy

public static File copy(URLConnection conn,
                        File file)
                 throws IOException

Throws:: IOException

copy

public static URL copy(InputStream in,
                       URL url)
                throws IOException

Throws:: IOException

copy

public static URL copy(InputStream in,
                       URL url,
                       String method)
                throws IOException

Throws:: IOException

copy

public static File copy(File src,
                        File tgt)
                 throws IOException

Throws:: IOException

copy

public static Path copy(Path src,
                        Path tgt)
                 throws IOException

Throws:: IOException

copy

public static File copy(InputStream in,
                        File file)
                 throws IOException

Throws:: IOException

copy

public static Path copy(InputStream in,
                        Path path)
                 throws IOException

Throws:: IOException

copy

public static OutputStream copy(File file,
                                OutputStream out)
                         throws IOException

Throws:: IOException

copy

public static OutputStream copy(Path path,
                                OutputStream out)
                         throws IOException

Throws:: IOException

copy

public static WritableByteChannel copy(InputStream in,
                                       WritableByteChannel out)
                                throws IOException

Throws:: IOException

copy

public static OutputStream copy(ReadableByteChannel in,
                                OutputStream out)
                         throws IOException

Throws:: IOException

read

public static byte[] read(File file)
                   throws IOException

Throws:: IOException

read

public static ByteBuffer read(Path path)
                       throws IOException

Throws:: IOException

read

public static byte[] read(ByteBuffer bb)

read

public static byte[] read(URL url)
                   throws IOException

Throws:: IOException

read

public static byte[] read(InputStream in)
                   throws IOException

Throws:: IOException

write

public static void write(byte[] data,
                         OutputStream out)
                  throws IOException

Throws:: IOException

write

public static void write(byte[] data,
                         File file)
                  throws IOException

Throws:: IOException

collect

public static String collect(File file)
                      throws IOException

Throws:: IOException

collect

public static String collect(File file,
                             String encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(File file,
                             Charset encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(Path path)
                      throws IOException

Throws:: IOException

collect

public static String collect(Path path,
                             Charset encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(ByteBuffer bb,
                             Charset encoding)

collect

public static String collect(URL url,
                             String encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(URL url,
                             Charset encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(URL url)
                      throws IOException

Throws:: IOException

collect

public static String collect(String path)
                      throws IOException

Throws:: IOException

collect

public static String collect(InputStream in)
                      throws IOException

Throws:: IOException

collect

public static String collect(InputStream in,
                             String encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(InputStream in,
                             Charset encoding)
                      throws IOException

Throws:: IOException

collect

public static String collect(Reader r)
                      throws IOException

Throws:: IOException

createTempFile
```
public static File createTempFile(File directory,
                                  String pattern,
                                  String suffix)
                           throws IllegalArgumentException,
                                  IOException
```
Create a temporary file.

Parameters:

directory - the directory in which to create the file. Can be null, in which case the system TMP directory is used

pattern - the filename prefix pattern. Must be at least 3 characters long

suffix - the filename suffix. Can be null, in which case (system) default suffix is used

Returns:

temp file

Throws:

IllegalArgumentException - when pattern is null or too short

IOException - when the specified (non-null) directory is not a directory

absolutePath

public static String absolutePath(File file)

absolutePath

public static String absolutePath(Path path)

normalizePath

public static String normalizePath(Path path)

normalizePath

public static String normalizePath(File file)

normalizePath

public static String normalizePath(String path)

getFile

public static File getFile(String file)

getFile

public static File getFile(File base,
                           String file)

getBasedFile

public static File getBasedFile(File base,
                                String file)
                         throws IOException

Throws:: IOException

getPath

public static Path getPath(String file)

getPath

public static Path getPath(Path base,
                           String file)

getBasedPath

public static Path getBasedPath(Path base,
                                String file)
                         throws IOException

Throws:: IOException

delete
```
public static void delete(File file)
```
Deletes the specified file. Folders are recursively deleted.
If file(s) cannot be deleted, no feedback is provided (fail silently).

Parameters:

file - file to be deleted

delete
```
public static void delete(Path path)
```
Deletes the specified path. Folders are recursively deleted.
If file(s) cannot be deleted, no feedback is provided (fail silently).

Parameters:

path - path to be deleted

initialize

public static void initialize(File dir)

Deletes and creates directories

deleteWithException
```
public static void deleteWithException(File file)
                                throws IOException
```
Deletes the specified file. Folders are recursively deleted.
Throws exception if any of the files could not be deleted.

Parameters:

file - file to be deleted

Throws:

IOException - if the file (or contents of a folder) could not be deleted

deleteWithException
```
public static void deleteWithException(Path path)
                                throws IOException
```
Deletes the specified path. Folders are recursively deleted.
Throws exception if any of the files could not be deleted.

Parameters:

path - path to be deleted

Throws:

IOException - if the path (or contents of a folder) could not be deleted

rename
```
public static File rename(File from,
                          File to)
                   throws IOException
```
Renames from to to replacing the target file if necessary.

Parameters:

from - source file

to - destination file

Throws:

IOException - if the rename operation fails

rename
```
public static Path rename(Path from,
                          Path to)
                   throws IOException
```
Renames from to to replacing the target file if necessary.

Parameters:

from - source path

to - destination path

Throws:

IOException - if the rename operation fails

mkdirs

public static File mkdirs(File dir)
                   throws IOException

Throws:: IOException

mkdirs

public static Path mkdirs(Path dir)
                   throws IOException

Throws:: IOException

drain

public static long drain(InputStream in)
                  throws IOException

Throws:: IOException

copy

public static OutputStream copy(Collection<?> c,
                                OutputStream out)
                         throws IOException

Throws:: IOException

close

public static Throwable close(AutoCloseable in)

close

public static Throwable close(Closeable in)

toURL

public static URL toURL(String s,
                        File base)
                 throws MalformedURLException

Throws:: MalformedURLException

store

public static void store(Object o,
                         File file)
                  throws IOException

Throws:: IOException

store

public static void store(Object o,
                         File file,
                         String encoding)
                  throws IOException

Throws:: IOException

store

public static void store(Object o,
                         Path path,
                         Charset encoding)
                  throws IOException

Throws:: IOException

store

public static void store(Object o,
                         OutputStream out)
                  throws IOException

Throws:: IOException

store

public static void store(Object o,
                         OutputStream out,
                         String encoding)
                  throws IOException

Throws:: IOException

store

public static void store(Object o,
                         OutputStream out,
                         Charset encoding)
                  throws IOException

Throws:: IOException

store

public static void store(Object o,
                         Writer w)
                  throws IOException

Throws:: IOException

stream

public static InputStream stream(byte[] data)

stream

public static InputStream stream(ByteBuffer bb)

stream

public static InputStream stream(String s)

stream

public static InputStream stream(String s,
                                 String encoding)

stream

public static InputStream stream(String s,
                                 Charset encoding)

stream

public static InputStream stream(File file)
                          throws IOException

Throws:: IOException

stream

public static InputStream stream(Path path)
                          throws IOException

Throws:: IOException

stream

public static InputStream stream(URL url)
                          throws IOException

Throws:: IOException

readChannel

public static FileChannel readChannel(Path path)
                               throws IOException

Throws:: IOException

outputStream

public static OutputStream outputStream(File file)
                                 throws IOException

Throws:: IOException

outputStream

public static OutputStream outputStream(Path path)
                                 throws IOException

Throws:: IOException

writeChannel

public static FileChannel writeChannel(Path path)
                                throws IOException

Throws:: IOException

decode

public static CharBuffer decode(ByteBuffer bb,
                                Charset encoding)

encode

public static ByteBuffer encode(CharBuffer cb,
                                Charset encoding)

reader

public static BufferedReader reader(String s)

reader

public static BufferedReader reader(File file)
                             throws IOException

Throws:: IOException

reader

public static BufferedReader reader(File file,
                                    String encoding)
                             throws IOException

Throws:: IOException

reader

public static BufferedReader reader(File file,
                                    Charset encoding)
                             throws IOException

Throws:: IOException

reader

public static BufferedReader reader(Path path,
                                    Charset encoding)
                             throws IOException

Throws:: IOException

reader

public static BufferedReader reader(ByteBuffer bb,
                                    Charset encoding)

reader

public static BufferedReader reader(CharBuffer cb)

reader

public static BufferedReader reader(ReadableByteChannel in,
                                    Charset encoding)

reader

public static BufferedReader reader(InputStream in)

reader

public static BufferedReader reader(InputStream in,
                                    String encoding)

reader

public static BufferedReader reader(InputStream in,
                                    Charset encoding)

writer

public static PrintWriter writer(File file)
                          throws IOException

Throws:: IOException

writer

public static PrintWriter writer(File file,
                                 String encoding)
                          throws IOException

Throws:: IOException

writer

public static PrintWriter writer(File file,
                                 Charset encoding)
                          throws IOException

Throws:: IOException

writer

public static PrintWriter writer(Path path)
                          throws IOException

Throws:: IOException

writer

public static PrintWriter writer(Path path,
                                 Charset encoding)
                          throws IOException

Throws:: IOException

writer

public static PrintWriter writer(WritableByteChannel out,
                                 Charset encoding)

writer

public static PrintWriter writer(OutputStream out)

writer

public static PrintWriter writer(OutputStream out,
                                 String encoding)

writer

public static PrintWriter writer(OutputStream out,
                                 Charset encoding)

createSymbolicLink

public static boolean createSymbolicLink(File link,
                                         File target)
                                  throws IOException

Throws:: IOException

createSymbolicLink

public static boolean createSymbolicLink(Path link,
                                         Path target)
                                  throws IOException

Throws:: IOException

isSymbolicLink

public static boolean isSymbolicLink(File link)

isSymbolicLink

public static boolean isSymbolicLink(Path link)

createSymbolicLinkOrCopy
```
public static boolean createSymbolicLinkOrCopy(File link,
                                               File target)
```
Creates a symbolic link from link to the target, or copies target to link if running on Windows.
Creating symbolic links on Windows requires administrator permissions, so copying is a safer fallback. Copy only happens if timestamp and and file length are different than target

Parameters:

link - the location of the symbolic link, or destination of the copy.

target - the source of the symbolic link, or source of the copy.

Returns:

true if the operation succeeds, false otherwise.

createSymbolicLinkOrCopy
```
public static boolean createSymbolicLinkOrCopy(Path link,
                                               Path target)
```
Creates a symbolic link from link to the target, or copies target to link if running on Windows.
Creating symbolic links on Windows requires administrator permissions, so copying is a safer fallback. Copy only happens if timestamp and and file length are different than target

Parameters:

link - the location of the symbolic link, or destination of the copy.

target - the source of the symbolic link, or source of the copy.

Returns:

true if the operation succeeds, false otherwise.

toSafeFileName

public static String toSafeFileName(String string)

isWindows
```
public static boolean isWindows()
```

readUTF

public static String readUTF(DataInput in)
                      throws IOException

Throws:: IOException

Class IO

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

work

home

JAVA_HOME

nullStream

nullWriter

Constructor Detail

IO

Method Detail

getExtension

tree

tree

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

copy

read

read

read

read

read

write

write

collect

collect

collect

collect

collect

collect

collect

collect

collect

collect

collect

collect

collect

collect

createTempFile

absolutePath

absolutePath

normalizePath