Package com.consol.citrus.util

Class FileUtils

java.lang.Object

com.consol.citrus.util.FileUtils

public abstract class FileUtils
extends Object

Class to provide general file utilities, such as listing all XML files in a directory, or finding certain tests in a directory.

Since:

2007

Author:

Christoph Deppisch

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE_EXTENSION_JAVA
static String	FILE_EXTENSION_XML
static String	FILE_PATH_CHARSET_PARAMETER

Method Summary

Modifier and Type	Method	Description
static List<File>	findFiles(String startDir, Set<String> fileNamePatterns)	Method to retrieve all files with given file name pattern in given directory.
static String	getBaseName(String fileName)	Remove file extension from file name.
static Charset	getCharset(String path)	Extract charset information from file path.
static Charset	getDefaultCharset()	Gets the default charset.
static String	getFileExtension(String path)	Extract file extension form given path.
static org.springframework.core.io.Resource	getFileResource(String filePath)	Reads file resource from path with variable replacement support.
static org.springframework.core.io.Resource	getFileResource(String filePath, com.consol.citrus.context.TestContext context)	Reads file resource from path with variable replacement support.
static Properties	loadAsProperties(org.springframework.core.io.Resource resource)	Load properties from file.
static String	readToString(File file)	Read file content to string value with default charset settings.
static String	readToString(InputStream inputStream)	Read file input stream to string value with default charset settings.
static String	readToString(InputStream inputStream, Charset charset)	Read file input stream to string value.
static String	readToString(org.springframework.core.io.Resource resource)	Read file resource to string value with default charset settings.
static String	readToString(org.springframework.core.io.Resource resource, Charset charset)	Read file resource to string value.
static void	setSimulationMode(boolean mode)	Sets the simulation mode.
static void	writeToFile(InputStream inputStream, File file)	Writes inputStream content to file.
static void	writeToFile(String content, File file)	Writes String content to file.
static void	writeToFile(String content, File file, Charset charset)	Writes String content to file with given charset encoding.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION_JAVA

public static final String FILE_EXTENSION_JAVA

See Also:

Constant Field Values

FILE_EXTENSION_XML

public static final String FILE_EXTENSION_XML

See Also:

Constant Field Values

FILE_PATH_CHARSET_PARAMETER

public static final String FILE_PATH_CHARSET_PARAMETER

See Also:

Constant Field Values

Method Detail

setSimulationMode

public static void setSimulationMode(boolean mode)

Sets the simulation mode.

readToString

public static String readToString(org.springframework.core.io.Resource resource)
                           throws IOException

Read file resource to string value with default charset settings.

Parameters:

resource -

Returns:

Throws:

IOException

readToString

public static String readToString(InputStream inputStream)
                           throws IOException

Read file input stream to string value with default charset settings.

Parameters:

inputStream -

Returns:

Throws:

IOException

readToString

public static String readToString(File file)
                           throws IOException

Read file content to string value with default charset settings.

Parameters:

file -

Returns:

Throws:

IOException

readToString

public static String readToString(org.springframework.core.io.Resource resource,
                                  Charset charset)
                           throws IOException

Read file resource to string value.

Parameters:

resource -

charset -

Returns:

Throws:

IOException

readToString

public static String readToString(InputStream inputStream,
                                  Charset charset)
                           throws IOException

Read file input stream to string value.

Parameters:

inputStream -

charset -

Returns:

Throws:

IOException

writeToFile

public static void writeToFile(InputStream inputStream,
                               File file)

Writes inputStream content to file. Uses default charset encoding.

Parameters:

inputStream -

file -

writeToFile

public static void writeToFile(String content,
                               File file)

Writes String content to file. Uses default charset encoding.

Parameters:

content -

file -

writeToFile

public static void writeToFile(String content,
                               File file,
                               Charset charset)

Writes String content to file with given charset encoding. Automatically closes file output streams when done.

Parameters:

content -

file -

findFiles

public static List<File> findFiles(String startDir,
                                   Set<String> fileNamePatterns)

Method to retrieve all files with given file name pattern in given directory. Hierarchy of folders is supported.

Parameters:

startDir - the directory to hold the files

fileNamePatterns - the file names to include

Returns:

list of test files as filename paths

getFileResource

public static org.springframework.core.io.Resource getFileResource(String filePath,
                                                                   com.consol.citrus.context.TestContext context)

Reads file resource from path with variable replacement support.

Parameters:

filePath -

context -

Returns:

getFileResource

public static org.springframework.core.io.Resource getFileResource(String filePath)

Reads file resource from path with variable replacement support.

Parameters:

filePath -

Returns:

getDefaultCharset

public static Charset getDefaultCharset()

Gets the default charset. If set by Citrus system property (citrus.file.encoding) use this one otherwise use system default.

Returns:

getCharset

public static Charset getCharset(String path)

Extract charset information from file path. If not set return default charset. Charset is read as path parameter at the end of the file path {@see FileUtils.FILE_PATH_CHARSET_PARAMETER}

Parameters:

path -

Returns:

getFileExtension

public static String getFileExtension(String path)

Extract file extension form given path.

Parameters:

path -

Returns:

loadAsProperties

public static Properties loadAsProperties(org.springframework.core.io.Resource resource)

Load properties from file. Supports XML and key-value format.

Parameters:

resource -

Returns:

getBaseName

public static String getBaseName(String fileName)

Remove file extension from file name.

Parameters:

fileName -

Returns: