net.openhft.chronicle.core.io

Enum IOTools

java.lang.Object

java.lang.Enum<IOTools>

net.openhft.chronicle.core.io.IOTools

All Implemented Interfaces:

Serializable, Comparable<IOTools>

public enum IOTools
extends Enum<IOTools>

Method Summary

Modifier and Type	Method and Description
static void	clean(ByteBuffer bb)
static void	createDirectories(Path dir)
static boolean	deleteDirWithFiles(File dir)
static boolean	deleteDirWithFiles(File dir, int maxDepth)
static boolean	deleteDirWithFiles(String dir)
static boolean	deleteDirWithFiles(String dir, int maxDepth)
static InputStream	open(URL url)
static byte[]	readAsBytes(InputStream is)
static byte[]	readFile(Class clazz, String name)
static byte[]	readFile(String name) This method first looks for the file in the classpath.
static boolean	shallowDeleteDirWithFiles(File dir)
static boolean	shallowDeleteDirWithFiles(String directory)
static String	tempName(String filename)
static URL	urlFor(ClassLoader classLoader, String name)
static URL	urlFor(Class clazz, String name)
static URL	urlFor(String name) Deprecated.
static IOTools	valueOf(String name) Returns the enum constant of this type with the specified name.
static IOTools[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static void	writeFile(String filename, byte[] bytes)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static IOTools[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IOTools c : IOTools.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IOTools valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

shallowDeleteDirWithFiles

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

Throws:

IORuntimeException

shallowDeleteDirWithFiles

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

Throws:

IORuntimeException

deleteDirWithFiles

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

Throws:

IORuntimeException

deleteDirWithFiles

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

Throws:

IORuntimeException

deleteDirWithFiles

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

Throws:

IORuntimeException

deleteDirWithFiles

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

Throws:

IORuntimeException

urlFor

@Deprecated
public static URL urlFor(String name)
                              throws FileNotFoundException

Deprecated.

Throws:

FileNotFoundException

urlFor

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

Throws:

FileNotFoundException

urlFor

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

Throws:

FileNotFoundException

open

public static InputStream open(URL url)
                        throws IOException

Throws:

IOException

readFile

public static byte[] readFile(@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:

name - Name of the file

Returns:

A byte[] containing the contents of the file

Throws:

IOException - FileNotFoundException thrown if file is not found

readFile

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

Throws:

IOException

readAsBytes

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

Throws:

IOException

writeFile

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

Throws:

IOException

tempName

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

clean

public static void clean(ByteBuffer bb)

createDirectories

public static void createDirectories(Path dir)
                              throws IOException

Throws:

IOException