org.owasp.dependencycheck.utils

Class FileUtils

java.lang.Object

org.owasp.dependencycheck.utils.FileUtils

public final class FileUtils
extends java.lang.Object

A collection of utilities for processing information about files.

Author:

Jeremy Long

Method Summary

Modifier and Type	Method and Description
static void	close(@Nullable java.io.Closeable closeable) Close the given Closeable instance, ignoring nulls, and logging any thrown IOException.
static @NotNull java.io.File	createTempDirectory(@Nullable java.io.File base) Creates a unique temporary directory in the given directory.
static boolean	delete(@Nullable java.io.File file) Deletes a file.
static @NotNull java.lang.String	getBitBucket() Return the bit bucket for the OS.
static @Nullable java.lang.String	getFileExtension(@NotNull java.lang.String fileName) Returns the (lowercase) file extension for a specified file.
static java.io.File	getResourceAsFile(java.lang.String resource) Returns a File object for the given resource.
static @Nullable java.io.InputStream	getResourceAsStream(@NotNull java.lang.String resource) Gets the InputStream for this resource.

Methods inherited from class java.lang.Object

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

Method Detail

getFileExtension

@Nullable
public static @Nullable java.lang.String getFileExtension(@NotNull
                                                                    @NotNull java.lang.String fileName)

Returns the (lowercase) file extension for a specified file.

Parameters:

fileName - the file name to retrieve the file extension from.

Returns:

the file extension.

delete

public static boolean delete(@Nullable
                             @Nullable java.io.File file)

Deletes a file. If the File is a directory it will recursively delete the contents.

Parameters:

file - the File to delete

Returns:

true if the file was deleted successfully, otherwise false

createTempDirectory

@NotNull
public static @NotNull java.io.File createTempDirectory(@Nullable
                                                                 @Nullable java.io.File base)
                                                          throws java.io.IOException

Creates a unique temporary directory in the given directory.

Parameters:

base - the base directory to create a temporary directory within

Returns:

the temporary directory

Throws:

java.io.IOException - thrown when a directory cannot be created within the base directory

getBitBucket

@NotNull
public static @NotNull java.lang.String getBitBucket()

Return the bit bucket for the OS. '/dev/null' for Unix and 'NUL' for Windows

Returns:

a String containing the bit bucket

close

public static void close(@Nullable
                         @Nullable java.io.Closeable closeable)

Close the given Closeable instance, ignoring nulls, and logging any thrown IOException.

Parameters:

closeable - to be closed

getResourceAsStream

@Nullable
public static @Nullable java.io.InputStream getResourceAsStream(@NotNull
                                                                          @NotNull java.lang.String resource)
                                                                   throws java.io.FileNotFoundException

Gets the InputStream for this resource.

Parameters:

resource - path

Returns:

the input stream for the given resource

Throws:

java.io.FileNotFoundException - if the file could not be found

getResourceAsFile

public static java.io.File getResourceAsFile(java.lang.String resource)

Returns a File object for the given resource. The resource is attempted to be loaded from the class loader.

Parameters:

resource - path

Returns:

the file reference for the resource