org.apache.lucene.util

Class IOUtils

java.lang.Object

org.apache.lucene.util.IOUtils

public final class IOUtils
extends Object

This class emulates the new Java 7 "Try-With-Resources" statement. Remove once Lucene is on Java 7.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	CHARSET_UTF_8 Deprecated. Use StandardCharsets.UTF_8 instead.
static String	UTF_8 UTF-8 charset string.

Method Summary

Methods

Modifier and Type	Method and Description
static void	close(Closeable... objects) Closes all given Closeables.
static void	close(Iterable<? extends Closeable> objects) Closes all given Closeables.
static void	closeWhileHandlingException(Closeable... objects) Closes all given Closeables, suppressing all thrown exceptions.
static void	closeWhileHandlingException(Iterable<? extends Closeable> objects) Closes all given Closeables, suppressing all thrown exceptions.
static void	copy(File source, File target) Copy one file's contents to another file.
static void	deleteFilesIgnoringExceptions(Directory dir, String... files) Deletes all given files, suppressing all thrown IOExceptions.
static void	fsync(File fileToSync, boolean isDir) Ensure that any writes to the given file is written to the storage device that contains it.
static Reader	getDecodingReader(Class<?> clazz, String resource, Charset charSet) Opens a Reader for the given resource using a CharsetDecoder.
static Reader	getDecodingReader(File file, Charset charSet) Opens a Reader for the given File using a CharsetDecoder.
static Reader	getDecodingReader(InputStream stream, Charset charSet) Wrapping the given InputStream in a reader using a CharsetDecoder.
static void	reThrow(Throwable th) Simple utility method that takes a previously caught Throwable and rethrows either IOException or an unchecked exception.
static void	reThrowUnchecked(Throwable th) Simple utility method that takes a previously caught Throwable and rethrows it as an unchecked exception.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHARSET_UTF_8

@Deprecated
public static final Charset CHARSET_UTF_8

Deprecated. Use StandardCharsets.UTF_8 instead.

UTF-8 Charset instance to prevent repeated Charset.forName(String) lookups

UTF_8

public static final String UTF_8

UTF-8 charset string.

Where possible, use StandardCharsets.UTF_8 instead, as using the String constant may slow things down.

See Also:

StandardCharsets.UTF_8

Method Detail

close

public static void close(Closeable... objects)
                  throws IOException

Closes all given Closeables. Some of the Closeables may be null; they are ignored. After everything is closed, the method either throws the first exception it hit while closing, or completes normally if there were no exceptions.

Parameters:

objects - objects to call close() on

Throws:

IOException

close

public static void close(Iterable<? extends Closeable> objects)
                  throws IOException

Closes all given Closeables.

Throws:

IOException

See Also:

close(Closeable...)

closeWhileHandlingException

public static void closeWhileHandlingException(Closeable... objects)

Closes all given Closeables, suppressing all thrown exceptions. Some of the Closeables may be null, they are ignored.

Parameters:

objects - objects to call close() on

closeWhileHandlingException

public static void closeWhileHandlingException(Iterable<? extends Closeable> objects)

Closes all given Closeables, suppressing all thrown exceptions.

See Also:

closeWhileHandlingException(Closeable...)

getDecodingReader

public static Reader getDecodingReader(InputStream stream,
                       Charset charSet)

Wrapping the given InputStream in a reader using a CharsetDecoder. Unlike Java's defaults this reader will throw an exception if your it detects the read charset doesn't match the expected Charset.

Decoding readers are useful to load configuration files, stopword lists or synonym files to detect character set problems. However, its not recommended to use as a common purpose reader.

Parameters:

stream - the stream to wrap in a reader

charSet - the expected charset

Returns:

a wrapping reader

getDecodingReader

public static Reader getDecodingReader(File file,
                       Charset charSet)
                                throws IOException

Opens a Reader for the given File using a CharsetDecoder. Unlike Java's defaults this reader will throw an exception if your it detects the read charset doesn't match the expected Charset.

Decoding readers are useful to load configuration files, stopword lists or synonym files to detect character set problems. However, its not recommended to use as a common purpose reader.

Parameters:

file - the file to open a reader on

charSet - the expected charset

Returns:

a reader to read the given file

Throws:

IOException

getDecodingReader

public static Reader getDecodingReader(Class<?> clazz,
                       String resource,
                       Charset charSet)
                                throws IOException

Opens a Reader for the given resource using a CharsetDecoder. Unlike Java's defaults this reader will throw an exception if your it detects the read charset doesn't match the expected Charset.

Decoding readers are useful to load configuration files, stopword lists or synonym files to detect character set problems. However, its not recommended to use as a common purpose reader.

Parameters:

clazz - the class used to locate the resource

resource - the resource name to load

charSet - the expected charset

Returns:

a reader to read the given file

Throws:

IOException

deleteFilesIgnoringExceptions

public static void deleteFilesIgnoringExceptions(Directory dir,
                                 String... files)

Deletes all given files, suppressing all thrown IOExceptions.

Note that the files should not be null.

copy

public static void copy(File source,
        File target)
                 throws IOException

Copy one file's contents to another file. The target will be overwritten if it exists. The source must exist.

Throws:

IOException

reThrow

public static void reThrow(Throwable th)
                    throws IOException

Simple utility method that takes a previously caught Throwable and rethrows either IOException or an unchecked exception. If the argument is null then this method does nothing.

Throws:

IOException

reThrowUnchecked

public static void reThrowUnchecked(Throwable th)

Simple utility method that takes a previously caught Throwable and rethrows it as an unchecked exception. If the argument is null then this method does nothing.

fsync

public static void fsync(File fileToSync,
         boolean isDir)
                  throws IOException

Ensure that any writes to the given file is written to the storage device that contains it.

Parameters:

fileToSync - the file to fsync

isDir - if true, the given file is a directory (we open for read and ignore IOExceptions, because not all file systems and operating systems allow to fsync on a directory)

Throws:

IOException