com.gooddata.util

Class FileUtil

java.lang.Object

com.gooddata.util.FileUtil

public class FileUtil
extends Object

File utils

Version:

1.0

Author:

zd

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static void	compressDir(String dirPath, String archiveName) Compresses local directory to the archiveName
static void	copy(InputStream is, OutputStream os) writes the data from the input stream to the provided output stream
static BufferedReader	createBufferedUtf8Reader(File file) Opens a file given by a path and returns its BufferedReader using the UTF-8 encoding
static BufferedReader	createBufferedUtf8Reader(InputStream is) Creates a BufferedReader on the top of the given InputStream using the UTF-8 encoding
static BufferedReader	createBufferedUtf8Reader(String path) Opens a file given by a path and returns its BufferedReader using the UTF-8 encoding
static BufferedReader	createBufferedUtf8Reader(URL url) Opens a URL and returns its BufferedReader using the UTF-8 encoding
static BufferedWriter	createBufferedUtf8Writer(File file) Opens a file given by a path and returns its BufferedWriter using the UTF-8 encoding
static BufferedWriter	createBufferedUtf8Writer(String path) Opens a file given by a path and returns its BufferedWriter using the UTF-8 encoding
static BufferedWriter	createBufferedUtf8Writer(String path, boolean append) Opens a file given by a path and returns its BufferedWriter using the UTF-8 encoding
static File	createTempDir() Create a new temporary directory.
static File	createTempDir(String baseDir) Create a new temporary directory.
static CSVWriter	createUtf8CsvEscapingWriter(File file) Creates a UTF-8 CSVWriter of the given file.
static CSVReader	createUtf8CsvReader(File file) Creates a UTF-8 CSVReader of the given file.
static CSVReader	createUtf8CsvReader(File file, char separator) Creates a UTF-8 CSVReader of the given file.
static CSVReader	createUtf8CsvReader(InputStream inputStream) Creates a UTF-8 CSVReader of the given inputStream.
static CSVReader	createUtf8CsvReader(InputStream inputStream, char separator) Creates a UTF-8 CSVReader of the given inputStream.
static CSVWriter	createUtf8CsvWriter(File file) Creates a UTF-8 CSVWriter of the given file.
static CSVWriter	createUtf8CsvWriter(OutputStream outputStream) Creates a UTF-8 CSVWriter of the given outputStream.
static String[]	getCsvHeader(URL url, char separator) Retrieves CSV headers from an URL
static String[]	getCsvHeader(URL url, CsvConfiguration csvConfiguration) Retrieves CSV headers from an URL
static File	getFile(String fileName) Constructs a new File and checks if it exists
static File	getFile(String fileName, boolean ignoreMissingFile) Constructs a new File and optionally checks if it exists
static String	getFileName(URL url) returns the last element of the URL's path
static CSVReader	getResourceAsCsvReader(String path) Creates a UTF-8 CSVReader of the resource on classpath represented by given path.
static File	getTempFile() Create a new temporary file.
static net.sf.json.JSONObject	readJSONFromFile(String fileName) Reads a JSON object from a file
static String	readStringFromClasspath(String path, Class c) Reads the entire InputStream and returns its content as a single String
static String	readStringFromFile(String fileName) Reads the entire file and returns its content as a single String
static String	readStringFromStream(InputStream is) Reads the entire InputStream and returns its content as a single String
static boolean	recursiveDelete(File fileOrDir) Recursively delete file or directory
static void	writeJSONToFile(net.sf.json.JSON content, String fileName) Writes a JSON object to a file.
static void	writeStringToFile(String content, String fileName) Writes a string to a file.
static void	writeStringToFile(String content, String fileName, boolean append) Writes a string to a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtil

public FileUtil()

Method Detail

compressDir

public static void compressDir(String dirPath,
                               String archiveName)
                        throws IOException

Compresses local directory to the archiveName

Parameters:

dirPath - path to the directory

archiveName - the name of the ZIP archive that is going to be created

Throws:

IOException

copy

public static void copy(InputStream is,
                        OutputStream os)
                 throws IOException

writes the data from the input stream to the provided output stream

Parameters:

is -

os -

Throws:

IOException

createTempDir

public static File createTempDir()
                          throws IOException

Create a new temporary directory. Use something like recursiveDelete(File) to clean this directory up since it isn't deleted automatically

Returns:

the new directory

Throws:

IOException - if there is an error creating the temporary directory

createTempDir

public static File createTempDir(String baseDir)
                          throws IOException

Create a new temporary directory. Use something like recursiveDelete(File) to clean this directory up since it isn't deleted automatically

Parameters:

root - directory where new directory will be created

Returns:

the new directory

Throws:

IOException - if there is an error creating the temporary directory

getTempFile

public static File getTempFile()
                        throws IOException

Create a new temporary file. Use something like

Returns:

the new file

Throws:

IOException - if there is an error creating the temporary file

recursiveDelete

public static boolean recursiveDelete(File fileOrDir)

Recursively delete file or directory

Parameters:

fileOrDir - the file or dir to delete

Returns:

true if all files are successfully deleted

writeStringToFile

public static void writeStringToFile(String content,
                                     String fileName)
                              throws IOException

Writes a string to a file.

Parameters:

content - the content

fileName - the file

Throws:

IOException

writeStringToFile

public static void writeStringToFile(String content,
                                     String fileName,
                                     boolean append)
                              throws IOException

Writes a string to a file.

Parameters:

content - the content

fileName - the file

append - should be the content appended?

Throws:

IOException

readStringFromFile

public static String readStringFromFile(String fileName)
                                 throws IOException

Reads the entire file and returns its content as a single String

Parameters:

fileName - the file

Returns:

the file content as String

Throws:

IOException

writeJSONToFile

public static void writeJSONToFile(net.sf.json.JSON content,
                                   String fileName)
                            throws IOException

Writes a JSON object to a file.

Parameters:

content - the content

fileName - the file

Throws:

IOException

readJSONFromFile

public static net.sf.json.JSONObject readJSONFromFile(String fileName)
                                               throws IOException

Reads a JSON object from a file

Parameters:

fileName - the file

Returns:

the file content as JSON object

Throws:

IOException

readStringFromStream

public static String readStringFromStream(InputStream is)
                                   throws IOException

Reads the entire InputStream and returns its content as a single String

Parameters:

is - the file

Returns:

the file content as String

Throws:

IOException

readStringFromClasspath

public static String readStringFromClasspath(String path,
                                             Class c)
                                      throws IOException

Reads the entire InputStream and returns its content as a single String

Parameters:

path - the loacation of the file on the CLASSPATH (e.g. /com/gooddata/processor/COMMANDS.txt)

c - Class for determining the Java classloader

Returns:

the file content as String

Throws:

IOException

getCsvHeader

public static String[] getCsvHeader(URL url,
                                    CsvConfiguration csvConfiguration)
                             throws IOException

Retrieves CSV headers from an URL

Parameters:

url - CSV url

Returns:

the headers as String[]

Throws:

IOException - in case of IO issues

getCsvHeader

public static String[] getCsvHeader(URL url,
                                    char separator)
                             throws IOException

Retrieves CSV headers from an URL

Parameters:

url - CSV url

Returns:

the headers as String[]

Throws:

IOException - in case of IO issues

getFile

public static File getFile(String fileName,
                           boolean ignoreMissingFile)
                    throws IOException

Constructs a new File and optionally checks if it exists

Parameters:

fileName - file name

ignoreMissingFile - flag that ignores the fact that the file doesn't exists

Returns:

the File

Throws:

IOException - if the file doesn't exists and the ignoreMissingFile is false

getFile

public static File getFile(String fileName)
                    throws IOException

Constructs a new File and checks if it exists

Parameters:

fileName - file name

Returns:

the File

Throws:

IOException - if the file doesn't exists

getFileName

public static String getFileName(URL url)

returns the last element of the URL's path

Parameters:

url - to parse

Returns:

the last element of the URL's path

createBufferedUtf8Reader

public static BufferedReader createBufferedUtf8Reader(String path)
                                               throws IOException

Opens a file given by a path and returns its BufferedReader using the UTF-8 encoding

Parameters:

path - path to a file to be read

Returns:

UTF8 BufferedReader of the file path

Throws:

IOException

createBufferedUtf8Writer

public static BufferedWriter createBufferedUtf8Writer(String path)
                                               throws IOException

Opens a file given by a path and returns its BufferedWriter using the UTF-8 encoding

Parameters:

path - path to a file to write to

Returns:

UTF8 BufferedWriter of the file path

Throws:

IOException

createBufferedUtf8Writer

public static BufferedWriter createBufferedUtf8Writer(String path,
                                                      boolean append)
                                               throws IOException

Opens a file given by a path and returns its BufferedWriter using the UTF-8 encoding

Parameters:

path - path to a file to write to

append - should be the content appended?

Returns:

UTF8 BufferedWriter of the file path

Throws:

IOException

createBufferedUtf8Reader

public static BufferedReader createBufferedUtf8Reader(File file)
                                               throws IOException

Opens a file given by a path and returns its BufferedReader using the UTF-8 encoding

Parameters:

file - file to be read

Returns:

UTF8 BufferedReader of the file

Throws:

IOException

createBufferedUtf8Writer

public static BufferedWriter createBufferedUtf8Writer(File file)
                                               throws IOException

Opens a file given by a path and returns its BufferedWriter using the UTF-8 encoding

Parameters:

file - file to write to

Returns:

UTF8 BufferedWriter of the file

Throws:

IOException

createBufferedUtf8Reader

public static BufferedReader createBufferedUtf8Reader(URL url)
                                               throws IOException

Opens a URL and returns its BufferedReader using the UTF-8 encoding

Parameters:

url - to be read

Returns:

UTF8 BufferedReader of the url

Throws:

IOException

createBufferedUtf8Reader

public static BufferedReader createBufferedUtf8Reader(InputStream is)
                                               throws IOException

Creates a BufferedReader on the top of the given InputStream using the UTF-8 encoding

Parameters:

is - file to be read

Returns:

UTF8 BufferedReader of the file

Throws:

IOException

getResourceAsCsvReader

public static CSVReader getResourceAsCsvReader(String path)
                                        throws IOException

Creates a UTF-8 CSVReader of the resource on classpath represented by given path. Calls Class.getResourceAsStream(String) internally to create the underlying InputStream.

Parameters:

path -

Returns:

Throws:

IOException

createUtf8CsvReader

public static CSVReader createUtf8CsvReader(File file)
                                     throws IOException

Creates a UTF-8 CSVReader of the given file.

Parameters:

file -

Returns:

Throws:

IOException

createUtf8CsvReader

public static CSVReader createUtf8CsvReader(File file,
                                            char separator)
                                     throws IOException

Creates a UTF-8 CSVReader of the given file.

Parameters:

file -

separator - field separator

Returns:

Throws:

IOException

createUtf8CsvReader

public static CSVReader createUtf8CsvReader(InputStream inputStream,
                                            char separator)
                                     throws IOException

Creates a UTF-8 CSVReader of the given inputStream.

Parameters:

inputStream -

separator - field separator

Returns:

Throws:

IOException

createUtf8CsvReader

public static CSVReader createUtf8CsvReader(InputStream inputStream)
                                     throws IOException

Creates a UTF-8 CSVReader of the given inputStream.

Parameters:

inputStream -

Returns:

Throws:

IOException

createUtf8CsvWriter

public static CSVWriter createUtf8CsvWriter(File file)
                                     throws IOException

Creates a UTF-8 CSVWriter of the given file.

Parameters:

file -

Returns:

Throws:

IOException

createUtf8CsvWriter

public static CSVWriter createUtf8CsvWriter(OutputStream outputStream)
                                     throws IOException

Creates a UTF-8 CSVWriter of the given outputStream.

Parameters:

outputStream -

Returns:

Throws:

IOException

createUtf8CsvEscapingWriter

public static CSVWriter createUtf8CsvEscapingWriter(File file)
                                             throws IOException

Creates a UTF-8 CSVWriter of the given file.

Parameters:

file -

Returns:

Throws:

IOException