net.openhft.chronicle.core.io

Class IOTools

java.lang.Object

net.openhft.chronicle.core.io.IOTools

public final class IOTools
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	IOSTATUS_INTERRUPTED

Method Summary

Modifier and Type	Method and Description
static long	addressFor(ByteBuffer byteBuffer)
static void	clean(ByteBuffer bb)
static void	createDirectories(Path dir)
static Path	createTempDirectory(String s)
static File	createTempFile(String s)
static boolean	deleteDirWithFiles(@NotNull File dir)
static boolean	deleteDirWithFiles(@NotNull File dir, int maxDepth)
static boolean	deleteDirWithFiles(String... dirs)
static boolean	deleteDirWithFiles(@NotNull String dir, int maxDepth)
static void	deleteDirWithFilesOrThrow(File... dirs) Canonical usage is to call this *before* your test so you fail fast if you can't delete
static void	deleteDirWithFilesOrThrow(String... dirs)
static void	deleteDirWithFilesOrWait(long timeoutMs, @NotNull File dir) Ensures that directory is absent or deleted, awaits for given timeout if necessary.
static boolean	isDirectBuffer(ByteBuffer byteBuffer)
static int	normaliseIOStatus(int n)
static InputStream	open(URL url) Creates and returns a new InputStream from the provided url.
static byte[]	readAsBytes(InputStream is)
static byte[]	readFile(Class<?> clazz, @NotNull String name) This method first looks for the file in the classpath.
static boolean	shallowDeleteDirWithFiles(@NotNull File dir)
static boolean	shallowDeleteDirWithFiles(@NotNull String directory)
static @NotNull String	tempName(@NotNull String filename)
static void	unmonitor(Object t)
static @NotNull URL	urlFor(Class<?> clazz, String name)
static @NotNull URL	urlFor(ClassLoader classLoader, String name)
static void	writeFile(@NotNull String filename, @NotNull byte[] bytes)

Methods inherited from class java.lang.Object

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

Field Detail

IOSTATUS_INTERRUPTED

public static final int IOSTATUS_INTERRUPTED

See Also:

Constant Field Values

Method Detail

shallowDeleteDirWithFiles

public static boolean shallowDeleteDirWithFiles(@NotNull
                                                @NotNull String directory)
                                         throws IORuntimeException

Throws:

IORuntimeException

shallowDeleteDirWithFiles

public static boolean shallowDeleteDirWithFiles(@NotNull
                                                @NotNull File dir)
                                         throws IORuntimeException

Throws:

IORuntimeException

deleteDirWithFiles

public static boolean deleteDirWithFiles(@NotNull
                                         String... dirs)
                                  throws IORuntimeException

Throws:

IORuntimeException

deleteDirWithFiles

public static boolean deleteDirWithFiles(@NotNull
                                         @NotNull String dir,
                                         int maxDepth)
                                  throws IORuntimeException

Throws:

IORuntimeException

deleteDirWithFiles

public static boolean deleteDirWithFiles(@NotNull
                                         @NotNull File dir)
                                  throws IORuntimeException

Throws:

IORuntimeException

deleteDirWithFiles

public static boolean deleteDirWithFiles(@NotNull
                                         @NotNull File dir,
                                         int maxDepth)
                                  throws IORuntimeException

Throws:

IORuntimeException

deleteDirWithFilesOrThrow

public static void deleteDirWithFilesOrThrow(@NotNull
                                             String... dirs)
                                      throws IORuntimeException

Throws:

IORuntimeException

deleteDirWithFilesOrThrow

public static void deleteDirWithFilesOrThrow(@NotNull
                                             File... dirs)
                                      throws IORuntimeException

Canonical usage is to call this *before* your test so you fail fast if you can't delete

Parameters:

dirs - dirs

Throws:

IORuntimeException

deleteDirWithFilesOrWait

public static void deleteDirWithFilesOrWait(long timeoutMs,
                                            @NotNull
                                            @NotNull File dir)

Ensures that directory is absent or deleted, awaits for given timeout if necessary.

Parameters:

timeoutMs - Time to ensure that the directory is absent.

dir - Dir to delete.

Throws:

AssertionError - If timeout passed and the directory is still present.

urlFor

@NotNull
public static @NotNull URL urlFor(Class<?> clazz,
                                           String name)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

urlFor

@NotNull
public static @NotNull URL urlFor(ClassLoader classLoader,
                                           String name)
                                    throws FileNotFoundException

Throws:

FileNotFoundException

open

public static InputStream open(URL url)
                        throws IOException

Creates and returns a new InputStream from the provided url.

It is up to the caller to close the returned InputStream after being used.

Parameters:

url - to create an InputStream from

Returns:

an InputStream

Throws:

IOException - if the URL cannot be opened

readFile

public static byte[] readFile(Class<?> clazz,
                              @NotNull
                              @NotNull String name)
                       throws IOException

This method first looks for the file in the classpath. If this is not found it appends the suffix .gz and looks again in the classpath to see if it is present. If it is still not found it looks for the file on the file system. If it not found it appends the suffix .gz and looks again on the file system. If it still not found a FileNotFoundException is thrown.

Parameters:

clazz - file to use to determine the class loader.

name - Name of the file

Returns:

A byte[] containing the contents of the file

Throws:

IOException - FileNotFoundException thrown if file is not found

readAsBytes

public static byte[] readAsBytes(InputStream is)
                          throws IOException

Throws:

IOException

writeFile

public static void writeFile(@NotNull
                             @NotNull String filename,
                             @NotNull
                             @NotNull byte[] bytes)
                      throws IOException

Throws:

IOException

tempName

@NotNull
public static @NotNull String tempName(@NotNull
                                                @NotNull String filename)

clean

public static void clean(ByteBuffer bb)

createDirectories

public static void createDirectories(Path dir)
                              throws IOException

Throws:

IOException

createTempFile

public static File createTempFile(String s)

createTempDirectory

public static Path createTempDirectory(String s)

unmonitor

public static void unmonitor(Object t)

isDirectBuffer

public static boolean isDirectBuffer(ByteBuffer byteBuffer)

addressFor

public static long addressFor(ByteBuffer byteBuffer)

normaliseIOStatus

public static int normaliseIOStatus(int n)