Package it.tidalwave.util.test

Class FileComparisonUtils

java.lang.Object

it.tidalwave.util.test.FileComparisonUtils

public class FileComparisonUtils
extends Object

A utility class to compare two text files and assert that they have the same contents.

Author:

Fabrizio Giudici

Field Summary

Fields

Modifier and Type	Field	Description
static final String	P_TABULAR_LIMIT
static final String	P_TABULAR_OUTPUT

Constructor Summary

Constructors

Constructor	Description
FileComparisonUtils()

Method Summary

Modifier and Type	Method	Description
static void	assertSameContents(File expectedFile, File actualFile)	Asserts that two files have the same contents.
static void	assertSameContents(Path expectedPath, Path actualPath)	Asserts that two files have the same contents.
static void	assertSameContents(List<String> expected, List<String> actual)	Asserts that two collections of strings have the same contents.
static boolean	checkSameContents(Path expectedPath, Path actualPath)	Checks whether two files have the same contents.
static String	commonPrefix(String s1, String s2)	Given a string that represents a path whose segments are separated by the standard separator of the platform, returns the common prefix - which means the common directory parents.
static List<String>	fileToStrings(Path file)	Reads a file into a list of strings.
static List<String>	resourceToStrings(InputStream is)	Reads an input stream into a list of strings.
static List<String>	resourceToStrings(String path)	Reads a classpath resource (not a regular file) into a list of strings.
static List<String>	stringToStrings(String string)	Converts a string which contains newlines into a list of strings.

Methods inherited from class java.lang.Object

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

Field Details

P_TABULAR_OUTPUT

public static final String P_TABULAR_OUTPUT

P_TABULAR_LIMIT

public static final String P_TABULAR_LIMIT

Constructor Details

FileComparisonUtils

public FileComparisonUtils()

Method Details

assertSameContents

public static void assertSameContents(@Nonnull
 File expectedFile,
 @Nonnull
 File actualFile)
                               throws IOException

Asserts that two files have the same contents.

Parameters:

expectedFile - the file with the expected contents

actualFile - the file with the contents to probe

Throws:

IOException - in case of error

assertSameContents

public static void assertSameContents(@Nonnull
 Path expectedPath,
 @Nonnull
 Path actualPath)
                               throws IOException

Asserts that two files have the same contents.

Parameters:

expectedPath - the file with the expected contents

actualPath - the file with the contents to probe

Throws:

IOException - in case of error

assertSameContents

public static void assertSameContents(@Nonnull
 List<String> expected,
 @Nonnull
 List<String> actual)

Asserts that two collections of strings have the same contents.

Parameters:

expected - the expected values

actual - the actual values

checkSameContents

public static boolean checkSameContents(@Nonnull
 Path expectedPath,
 @Nonnull
 Path actualPath)
                                 throws IOException

Checks whether two files have the same contents.

Parameters:

expectedPath - the file with the expected contents

actualPath - the file with the contents to probe

Returns:

whether the two files have the same contents

Throws:

IOException - in case of error

Since:

1.2-ALPHA-15

stringToStrings

@Nonnull
public static List<String> stringToStrings(@Nonnull
 String string)
                                    throws IOException

Converts a string which contains newlines into a list of strings.

Parameters:

string - the source

Returns:

the strings

Throws:

IOException - in case of error

fileToStrings

@Nonnull
public static List<String> fileToStrings(@Nonnull
 Path file)
                                  throws IOException

Reads a file into a list of strings.

Parameters:

file - the file

Returns:

the strings

Throws:

IOException - in case of error

resourceToStrings

@Nonnull
public static List<String> resourceToStrings(@Nonnull
 String path)
                                      throws IOException

Reads a classpath resource (not a regular file) into a list of strings.

Parameters:

path - the path of the classpath resource

Returns:

the strings

Throws:

IOException - in case of error

resourceToStrings

@Nonnull
public static List<String> resourceToStrings(@Nonnull
 InputStream is)
                                      throws IOException

Reads an input stream into a list of strings. The stream is closed at the end.

Parameters:

is - the input stream

Returns:

the strings

Throws:

IOException - in case of error

commonPrefix

@Nonnull
public static String commonPrefix(@Nonnull
 String s1,
 @Nonnull
 String s2)

Given a string that represents a path whose segments are separated by the standard separator of the platform, returns the common prefix - which means the common directory parents.

Parameters:

s1 - the former string

s2 - the latter string

Returns:

the common prefix