Package org.assertj.core.internal

Class Files

java.lang.Object

org.assertj.core.internal.Files

public class Files
extends Object

Reusable assertions for Files.

Author:

David DIDIER, Yvonne Wang, Alex Ruiz, Olivier Demeijer, Valeriy Vyrva

Field Summary

Fields

Modifier and Type	Field	Description
private static Predicate<File>	ANY
(package private) BinaryDiff	binaryDiff
(package private) Diff	diff
(package private) Failures	failures
private static Files	INSTANCE
(package private) NioFilesWrapper	nioFilesWrapper
private static String	UNABLE_TO_COMPARE_FILE_CONTENTS

Constructor Summary

Constructors

Constructor	Description
Files()

Method Summary

Modifier and Type	Method	Description
void	assertCanRead(AssertionInfo info, File actual)	Asserts that the given file can be read by the application.
void	assertCanWrite(AssertionInfo info, File actual)	Asserts that the given file can be modified by the application.
void	assertDoesNotExist(AssertionInfo info, File actual)	Asserts that the given file does not exist.
void	assertExists(AssertionInfo info, File actual)	Asserts that the given file exists, regardless it's a file or directory.
void	assertHasBinaryContent(AssertionInfo info, File actual, byte[] expected)	Asserts that the given file has the given binary content.
void	assertHasContent(AssertionInfo info, File actual, String expected, Charset charset)	Asserts that the given file has the given text content.
void	assertHasDigest(AssertionInfo info, File actual, String algorithm, byte[] expected)
void	assertHasDigest(AssertionInfo info, File actual, String algorithm, String expected)
void	assertHasDigest(AssertionInfo info, File actual, MessageDigest digest, byte[] expected)
void	assertHasDigest(AssertionInfo info, File actual, MessageDigest digest, String expected)
void	assertHasExtension(AssertionInfo info, File actual, String expected)	Asserts that the given File has the given extension.
void	assertHasName(AssertionInfo info, File actual, String expected)	Asserts that the given File has the given name.
void	assertHasNoParent(AssertionInfo info, File actual)	Asserts that the given File does not have a parent.
void	assertHasParent(AssertionInfo info, File actual, File expected)	Asserts that the given File has the given parent.
void	assertIsAbsolute(AssertionInfo info, File actual)	Asserts that the given file is an absolute path.
void	assertIsDirectory(AssertionInfo info, File actual)	Asserts that the given file is an existing directory.
void	assertIsDirectoryContaining(AssertionInfo info, File actual, String syntaxAndPattern)
void	assertIsDirectoryContaining(AssertionInfo info, File actual, Predicate<File> filter)
private void	assertIsDirectoryContaining(AssertionInfo info, File actual, Predicate<File> filter, String filterPresentation)
void	assertIsDirectoryNotContaining(AssertionInfo info, File actual, String syntaxAndPattern)
void	assertIsDirectoryNotContaining(AssertionInfo info, File actual, Predicate<File> filter)
private void	assertIsDirectoryNotContaining(AssertionInfo info, File actual, Predicate<File> filter, String filterPresentation)
void	assertIsEmptyDirectory(AssertionInfo info, File actual)
void	assertIsFile(AssertionInfo info, File actual)	Asserts that the given file is an existing file.
void	assertIsNotEmptyDirectory(AssertionInfo info, File actual)
void	assertIsRelative(AssertionInfo info, File actual)	Asserts that the given file is a relative path.
private static void	assertNotNull(AssertionInfo info, File actual)
void	assertSameContentAs(AssertionInfo info, File actual, Charset actualCharset, File expected, Charset expectedCharset)	Asserts that the given files have same content.
private List<File>	directoryContent(AssertionInfo info, File actual)
private List<String>	directoryContentDescription(AssertionInfo info, File actual)
private List<File>	filterDirectory(AssertionInfo info, File actual, Predicate<File> filter)
private String	getFileExtension(File file)
static Files	instance()	Returns the singleton instance of this class.
private boolean	isAbsolutePath(AssertionInfo info, File actual)
private Predicate<File>	pathMatcher(AssertionInfo info, File actual, String syntaxAndPattern)
static List<String>	toFileNames(List<File> files)
private void	verifyIsFile(File expected)

Methods inherited from class java.lang.Object

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

Field Detail

UNABLE_TO_COMPARE_FILE_CONTENTS

private static final String UNABLE_TO_COMPARE_FILE_CONTENTS

See Also:

Constant Field Values

INSTANCE

private static final Files INSTANCE

ANY

private static final Predicate<File> ANY

diff

Diff diff

binaryDiff

BinaryDiff binaryDiff

failures

Failures failures

nioFilesWrapper

NioFilesWrapper nioFilesWrapper

Constructor Detail

Files

Files()

Method Detail

instance

public static Files instance()

Returns the singleton instance of this class.

Returns:

the singleton instance of this class.

assertSameContentAs

public void assertSameContentAs(AssertionInfo info,
                                File actual,
                                Charset actualCharset,
                                File expected,
                                Charset expectedCharset)

Asserts that the given files have same content. Adapted from FileAssert (from JUnit-addons.)

Parameters:

info - contains information about the assertion.

actual - the "actual" file.

actualCharset - Charset of the "actual" file.

expected - the "expected" file.

expectedCharset - Charset of the "actual" file.

Throws:

NullPointerException - if expected is null.

IllegalArgumentException - if expected is not an existing file.

AssertionError - if actual is null.

AssertionError - if actual is not an existing file.

UncheckedIOException - if an I/O error occurs.

AssertionError - if the given files do not have same content.

assertHasBinaryContent

public void assertHasBinaryContent(AssertionInfo info,
                                   File actual,
                                   byte[] expected)

Asserts that the given file has the given binary content.

Parameters:

info - contains information about the assertion.

actual - the "actual" file.

expected - the "expected" binary content.

Throws:

NullPointerException - if expected is null.

AssertionError - if actual is null.

AssertionError - if actual is not an existing file.

UncheckedIOException - if an I/O error occurs.

AssertionError - if the file does not have the binary content.

assertHasContent

public void assertHasContent(AssertionInfo info,
                             File actual,
                             String expected,
                             Charset charset)

Asserts that the given file has the given text content.

Parameters:

info - contains information about the assertion.

actual - the "actual" file.

expected - the "expected" text content.

charset - the charset to use to read the file.

Throws:

NullPointerException - if expected is null.

AssertionError - if actual is null.

AssertionError - if actual is not an existing file.

UncheckedIOException - if an I/O error occurs.

AssertionError - if the file does not have the text content.

assertIsFile

public void assertIsFile(AssertionInfo info,
                         File actual)

Asserts that the given file is an existing file.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file is not an existing file.

assertIsDirectory

public void assertIsDirectory(AssertionInfo info,
                              File actual)

Asserts that the given file is an existing directory.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file is not an existing directory.

assertIsAbsolute

public void assertIsAbsolute(AssertionInfo info,
                             File actual)

Asserts that the given file is an absolute path.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file is not an absolute path.

assertIsRelative

public void assertIsRelative(AssertionInfo info,
                             File actual)

Asserts that the given file is a relative path.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file is not a relative path.

assertExists

public void assertExists(AssertionInfo info,
                         File actual)

Asserts that the given file exists, regardless it's a file or directory.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file does not exist.

assertDoesNotExist

public void assertDoesNotExist(AssertionInfo info,
                               File actual)

Asserts that the given file does not exist.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file exists.

assertCanWrite

public void assertCanWrite(AssertionInfo info,
                           File actual)

Asserts that the given file can be modified by the application.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file can not be modified.

assertCanRead

public void assertCanRead(AssertionInfo info,
                          File actual)

Asserts that the given file can be read by the application.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the given file is null.

AssertionError - if the given file can not be modified.

assertHasParent

public void assertHasParent(AssertionInfo info,
                            File actual,
                            File expected)

Asserts that the given File has the given parent.

Parameters:

info - contains information about the assertion.

actual - the given file.

expected - the expected parent File.

Throws:

NullPointerException - if the expected parent File is null.

UncheckedIOException - if an I/O error occurs.

AssertionError - if the given File is null.

AssertionError - if the given File does not have a parent.

AssertionError - if the given File parent is not equal to the expected one.

assertHasExtension

public void assertHasExtension(AssertionInfo info,
                               File actual,
                               String expected)

Asserts that the given File has the given extension.

Parameters:

info - contains information about the assertion.

actual - the given file.

expected - the expected extension, it does not contains the '.'

Throws:

NullPointerException - if the expected extension is null.

AssertionError - if the actual File is null.

AssertionError - if the actual File is not a file (ie a directory).

AssertionError - if the actual File does not have the expected extension.

assertHasName

public void assertHasName(AssertionInfo info,
                          File actual,
                          String expected)

Asserts that the given File has the given name.

Parameters:

info - contains information about the assertion.

actual - the given file.

expected - the expected file name.

Throws:

NullPointerException - if the expected name is null.

AssertionError - if the actual File is null.

AssertionError - if the actual File does not have the expected name.

assertHasNoParent

public void assertHasNoParent(AssertionInfo info,
                              File actual)

Asserts that the given File does not have a parent.

Parameters:

info - contains information about the assertion.

actual - the given file.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File has a parent.

assertHasDigest

public void assertHasDigest(AssertionInfo info,
                            File actual,
                            MessageDigest digest,
                            byte[] expected)

assertHasDigest

public void assertHasDigest(AssertionInfo info,
                            File actual,
                            MessageDigest digest,
                            String expected)

assertHasDigest

public void assertHasDigest(AssertionInfo info,
                            File actual,
                            String algorithm,
                            byte[] expected)

assertHasDigest

public void assertHasDigest(AssertionInfo info,
                            File actual,
                            String algorithm,
                            String expected)

assertIsEmptyDirectory

public void assertIsEmptyDirectory(AssertionInfo info,
                                   File actual)

assertIsNotEmptyDirectory

public void assertIsNotEmptyDirectory(AssertionInfo info,
                                      File actual)

assertIsDirectoryContaining

public void assertIsDirectoryContaining(AssertionInfo info,
                                        File actual,
                                        Predicate<File> filter)

assertIsDirectoryContaining

public void assertIsDirectoryContaining(AssertionInfo info,
                                        File actual,
                                        String syntaxAndPattern)

assertIsDirectoryNotContaining

public void assertIsDirectoryNotContaining(AssertionInfo info,
                                           File actual,
                                           Predicate<File> filter)

assertIsDirectoryNotContaining

public void assertIsDirectoryNotContaining(AssertionInfo info,
                                           File actual,
                                           String syntaxAndPattern)

toFileNames

public static List<String> toFileNames(List<File> files)

filterDirectory

private List<File> filterDirectory(AssertionInfo info,
                                   File actual,
                                   Predicate<File> filter)

directoryContent

private List<File> directoryContent(AssertionInfo info,
                                    File actual)

assertIsDirectoryContaining

private void assertIsDirectoryContaining(AssertionInfo info,
                                         File actual,
                                         Predicate<File> filter,
                                         String filterPresentation)

assertIsDirectoryNotContaining

private void assertIsDirectoryNotContaining(AssertionInfo info,
                                            File actual,
                                            Predicate<File> filter,
                                            String filterPresentation)

directoryContentDescription

private List<String> directoryContentDescription(AssertionInfo info,
                                                 File actual)

pathMatcher

private Predicate<File> pathMatcher(AssertionInfo info,
                                    File actual,
                                    String syntaxAndPattern)

assertNotNull

private static void assertNotNull(AssertionInfo info,
                                  File actual)

getFileExtension

private String getFileExtension(File file)

verifyIsFile

private void verifyIsFile(File expected)

isAbsolutePath

private boolean isAbsolutePath(AssertionInfo info,
                               File actual)