org.assertj.core.api

Class AbstractFileAssert<S extends AbstractFileAssert<S>>

java.lang.Object

org.assertj.core.api.AbstractAssert<S,File>

org.assertj.core.api.AbstractFileAssert<S>

Type Parameters:

S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

All Implemented Interfaces:

Assert<S,File>, Descriptable<S>, ExtensionPoints<S,File>

Direct Known Subclasses:

FileAssert

public abstract class AbstractFileAssert<S extends AbstractFileAssert<S>>
extends AbstractAssert<S,File>

Base class for all implementations of assertions for Files.

Author:

David DIDIER, Yvonne Wang, Alex Ruiz, Olivier Michallat, Olivier Demeijer, Mikhail Mazursky, Jean-Christophe Gay

Field Summary

Fields inherited from class org.assertj.core.api.AbstractAssert

actual, info, myself

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileAssert(File actual, Class<?> selfType)

Method Summary

Methods

Modifier and Type	Method and Description
S	canRead() Verifies that the actual File can be read by the application.
S	canWrite() Verifies that the actual File can be modified by the application.
S	doesNotExist() Verifies that the actual File does not exist.
S	exists() Verifies that the actual File exists, regardless it's a file or directory.
S	hasBinaryContent(byte[] expected) Verifies that the binary content of the actual File is exactly equal to the given one.
S	hasContent(String expected) Verifies that the text content of the actual File is exactly equal to the given one. The charset to use when reading the file should be provided with usingCharset(Charset) or usingCharset(String) prior to calling this method; if not, the platform's default charset (as returned by Charset.defaultCharset()) will be used.
S	hasContentEqualTo(File expected) Deprecated. use #hasSameContentAs() instead
S	hasExtension(String expected) Verifies that the actual File has given extension.
S	hasName(String expected) Verifies that the actual File has given name.
S	hasNoParent() Verifies that the actual File does not have a parent.
S	hasParent(File expected) Verifies that the actual File has given parent.
S	hasParent(String expected) Same as hasParent(java.io.File) but takes care of converting given String as File for you
S	hasSameContentAs(File expected) Verifies that the content of the actual File is equal to the content of the given one.
S	hasSameContentAs(File expected, Charset expectedCharset) Verifies that the content of the actual File is the same as the expected one, the expected File being read with the given charset while the charset used to read the actual path can be provided with usingCharset(Charset) or usingCharset(String) prior to calling this method; if not, the platform's default charset (as returned by Charset.defaultCharset()) will be used.
S	isAbsolute() Verifies that the actual File is an absolute path.
S	isDirectory() Verifies that the actual File is an existing directory.
S	isFile() Verifies that the actual File is an existing file.
S	isRelative() Verifies that the actual File is a relative path.
S	usingCharset(Charset charset) Specifies the charset to use for text-based assertions on the file's contents.
S	usingCharset(String charsetName) Specifies the name of the charset to use for text-based assertions on the file's contents.

Methods inherited from class org.assertj.core.api.AbstractAssert

as, as, asList, asString, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, failWithMessage, getWritableAssertionInfo, has, hashCode, hasSameClassAs, hasToString, inBinary, inHexadecimal, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, usingComparator, usingDefaultComparator, withFailMessage, withThreadDumpOnError

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFileAssert

protected AbstractFileAssert(File actual,
                  Class<?> selfType)

Method Detail

exists

public S exists()

Verifies that the actual File exists, regardless it's a file or directory.

Example:

 File tmpFile = File.createTempFile("tmp", "txt");
 File tmpDir = Files.createTempDirectory("tmpDir").toFile();
 
 // assertions will pass
 assertThat(tmpFile).exists();
 assertThat(tmpDir).exists();
 
 tmpFile.delete();
 tmpDir.delete();

 // assertions will fail
 assertThat(tmpFile).exists();
 assertThat(tmpDir).exists();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File does not exist.

doesNotExist

public S doesNotExist()

Verifies that the actual File does not exist.

Example:

 File parentDir = Files.createTempDirectory("tmpDir").toFile();
 File tmpDir = new File(parentDir, "subDir");
 File tmpFile = new File(parentDir, "a.txt");
 
 // assertions will pass
 assertThat(tmpDir).doesNotExist();
 assertThat(tmpFile).doesNotExist();
 
 tmpDir.mkdir();
 tmpFile.createNewFile();
 
 // assertions will fail
 assertThat(tmpFile).doesNotExist();
 assertThat(tmpDir).doesNotExist();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File exists.

isFile

public S isFile()

Verifies that the actual File is an existing file.

Example:

 File tmpFile = File.createTempFile("tmp", "txt");
 
 // assertion will pass
 assertThat(tmpFile).isFile();
 
 tmpFile.delete();
 File tmpDir = Files.createTempDirectory("tmpDir").toFile();
 
 // assertions will fail
 assertThat(tmpFile).isFile();
 assertThat(tmpDir).isFile();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

isDirectory

public S isDirectory()

Verifies that the actual File is an existing directory.

Example:

 File tmpDir = Files.createTempDirectory("tmpDir").toFile();
 
 // assertion will pass
 assertThat(tmpDir).isDirectory();
 
 tmpDir.delete();
 File tmpFile = File.createTempFile("tmp", "txt");
 
 // assertions will fail
 assertThat(tmpFile).isDirectory();
 assertThat(tmpDir).isDirectory();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

isAbsolute

public S isAbsolute()

Verifies that the actual File is an absolute path.

Example:

 File absoluteFile = File.createTempFile("tmp", "txt");
 
 // assertions will pass
 assertThat(absoluteFile).isAbsolute();
 
 File relativeFile = new File("./test");
 
 // assertion will fail
 assertThat(relativeFile).isAbsolute();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an absolute path.

isRelative

public S isRelative()

Verifies that the actual File is a relative path.

Example:

 File relativeFile = new File("./test");
 
 // assertion will pass
 assertThat(relativeFile).isRelative();
 
 File absoluteFile = File.createTempFile("tmp", "txt");
 
 // assertion will fail
 assertThat(absoluteFile).isRelative();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File is not a relative path.

hasContentEqualTo

@Deprecated
public S hasContentEqualTo(File expected)

Deprecated. use #hasSameContentAs() instead

Verifies that the content of the actual File is equal to the content of the given one. The charset to use when reading the actual file can be provided with usingCharset(Charset) or usingCharset(String) prior to calling this method; if not, the platform's default charset (as returned by Charset.defaultCharset()) will be used. Examples:

 // use the default charset
 File xFile = Files.write(Paths.get("xfile.txt"), "The Truth Is Out There".getBytes()).toFile();
 File xFileClone = Files.write(Paths.get("xfile-clone.txt"), "The Truth Is Out There".getBytes()).toFile();
 File xFileFrench = Files.write(Paths.get("xfile-french.txt"), "La Vérité Est Ailleurs".getBytes()).toFile();
 // use UTF-8 charsest
 File xFileUTF8 = Files.write(Paths.get("xfile-clone.txt"), Arrays.asList("The Truth Is Out There"), Charset.forName("UTF-8")).toFile();
 
 // The following assertion succeeds (default charset is used):
 assertThat(xFile).hasSameContentAs(xFileClone);
 // The following assertion succeeds (UTF-8 charset is used to read xFile):
 assertThat(xFileUTF8).usingCharset("UTF-8").hasContent(xFileClone);
 
 // The following assertion fails:
 assertThat(xFile).hasSameContentAs(xFileFrench);

Parameters:

expected - the given File to compare the actual File to.

Returns:

this assertion object.

Throws:

NullPointerException - if the given File is null.

IllegalArgumentException - if the given File is not an existing file.

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

RuntimeIOException - if an I/O error occurs.

AssertionError - if the content of the actual File is not equal to the content of the given one.

hasSameContentAs

public S hasSameContentAs(File expected)

Verifies that the content of the actual File is equal to the content of the given one. The charset to use when reading the actual file can be provided with usingCharset(Charset) or usingCharset(String) prior to calling this method; if not, the platform's default charset (as returned by Charset.defaultCharset()) will be used. Examples:

 // use the default charset
 File xFile = Files.write(Paths.get("xfile.txt"), "The Truth Is Out There".getBytes()).toFile();
 File xFileClone = Files.write(Paths.get("xfile-clone.txt"), "The Truth Is Out There".getBytes()).toFile();
 File xFileFrench = Files.write(Paths.get("xfile-french.txt"), "La Vérité Est Ailleurs".getBytes()).toFile();
 // use UTF-8 charsest
 File xFileUTF8 = Files.write(Paths.get("xfile-clone.txt"), Arrays.asList("The Truth Is Out There"), Charset.forName("UTF-8")).toFile();
 
 // The following assertion succeeds (default charset is used):
 assertThat(xFile).hasSameContentAs(xFileClone);
 // The following assertion succeeds (UTF-8 charset is used to read xFile):
 assertThat(xFileUTF8).usingCharset("UTF-8").hasContent(xFileClone);
 
 // The following assertion fails:
 assertThat(xFile).hasSameContentAs(xFileFrench);

Parameters:

expected - the given File to compare the actual File to.

Returns:

this assertion object.

Throws:

NullPointerException - if the given File is null.

IllegalArgumentException - if the given File is not an existing file.

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

RuntimeIOException - if an I/O error occurs.

AssertionError - if the content of the actual File is not equal to the content of the given one.

hasSameContentAs

public S hasSameContentAs(File expected,
                 Charset expectedCharset)

Verifies that the content of the actual File is the same as the expected one, the expected File being read with the given charset while the charset used to read the actual path can be provided with usingCharset(Charset) or usingCharset(String) prior to calling this method; if not, the platform's default charset (as returned by Charset.defaultCharset()) will be used.

Examples:

 File fileUTF8 = Files.write(Paths.get("actual"), Collections.singleton("Gerçek"), StandardCharsets.UTF_8).toFile();
 Charset turkishCharset = Charset.forName("windows-1254");
 File fileTurkischCharset = Files.write(Paths.get("expected"), Collections.singleton("Gerçek"), turkishCharset).toFile();
 
 // The following assertion succeeds:
 assertThat(fileUTF8).usingCharset(StandardCharsets.UTF_8).hasSameContentAs(fileTurkischCharset, turkishCharset);
 
 // The following assertion fails:
 assertThat(fileUTF8).usingCharset(StandardCharsets.UTF_8).hasSameContentAs(fileTurkischCharset, StandardCharsets.UTF_8);

Parameters:

expected - the given File to compare the actual File to.

expectedCharset - the used to read the content of the expected file.

Returns:

this assertion object.

Throws:

NullPointerException - if the given File is null.

IllegalArgumentException - if the given File is not an existing file.

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

RuntimeIOException - if an I/O error occurs.

AssertionError - if the content of the actual File is not equal to the content of the given one.

hasBinaryContent

public S hasBinaryContent(byte[] expected)

Verifies that the binary content of the actual File is exactly equal to the given one.

Example:

 File bin = File.createTempFile("tmp", "bin");
 Files.write(bin.toPath(), new byte[] {1, 1});
 
 // assertion will pass
 assertThat(bin).hasBinaryContent(new byte[] {1, 1});
 
 // assertions will fail
 assertThat(bin).hasBinaryContent(new byte[] { });
 assertThat(bin).hasBinaryContent(new byte[] {0, 0});

Parameters:

expected - the expected binary content to compare the actual File's content to.

Returns:

this assertion object.

Throws:

NullPointerException - if the given content is null.

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

RuntimeIOException - if an I/O error occurs.

AssertionError - if the content of the actual File is not equal to the given binary content.

usingCharset

public S usingCharset(String charsetName)

Specifies the name of the charset to use for text-based assertions on the file's contents.

Parameters:

charsetName - the name of the charset to use.

Returns:

this assertion object.

Throws:

IllegalArgumentException - if the given encoding is not supported on this platform.

usingCharset

public S usingCharset(Charset charset)

Specifies the charset to use for text-based assertions on the file's contents.

Parameters:

charset - the charset to use.

Returns:

this assertion object.

Throws:

NullPointerException - if the given charset is null.

hasContent

public S hasContent(String expected)

Verifies that the text content of the actual File is exactly equal to the given one.
The charset to use when reading the file should be provided with usingCharset(Charset) or usingCharset(String) prior to calling this method; if not, the platform's default charset (as returned by Charset.defaultCharset()) will be used.

Example:

 // use the default charset
 File xFile = Files.write(Paths.get("xfile.txt"), "The Truth Is Out There".getBytes()).toFile();
 
 // The following assertion succeeds (default charset is used):
 assertThat(xFile).hasContent("The Truth Is Out There");
 
 // The following assertion fails:
 assertThat(xFile).hasContent("La Vérité Est Ailleurs");
 
 // using a specific charset 
 Charset turkishCharset = Charset.forName("windows-1254");
 
 File xFileTurkish = Files.write(Paths.get("xfile.turk"), Collections.singleton("Gerçek"), turkishCharset).toFile();
 
 // The following assertion succeeds:
 assertThat(xFileTurkish).usingCharset(turkishCharset).hasContent("Gerçek");
 
 // The following assertion fails :
 assertThat(xFileTurkish).usingCharset(StandardCharsets.UTF_8).hasContent("Gerçek");

Parameters:

expected - the expected text content to compare the actual File's content to.

Returns:

this assertion object.

Throws:

NullPointerException - if the given content is null.

AssertionError - if the actual File is null.

AssertionError - if the actual File is not an existing file.

RuntimeIOException - if an I/O error occurs.

AssertionError - if the content of the actual File is not equal to the given content.

canWrite

public S canWrite()

Verifies that the actual File can be modified by the application.

Example:

 File tmpFile = File.createTempFile("tmp", "txt");
 File tmpDir = Files.createTempDirectory("tmp").toFile();
 
 // assertions will pass
 assertThat(tmpFile).canWrite();
 assertThat(tmpDir).canWrite();
 
 tmpFile.setReadOnly();
 tmpDir.setReadOnly();
 
 // assertions will fail
 assertThat(tmpFile).canWrite();
 assertThat(tmpDir).canWrite();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File can not be modified by the application.

canRead

public S canRead()

Verifies that the actual File can be read by the application.

Example:

 File tmpFile = File.createTempFile("tmp", "txt");
 File tmpDir = Files.createTempDirectory("tmp").toFile();
 
 // assertions will pass
 assertThat(tmpFile).canRead();
 assertThat(tmpDir).canRead();
 
 tmpFile.setReadable(false);
 tmpDir.setReadable(false);
 
 // assertions will fail
 assertThat(tmpFile).canRead();
 assertThat(tmpDir).canRead();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File can not be read by the application.

hasParent

public S hasParent(File expected)

Verifies that the actual File has given parent.

Example:

 File xFile = new File("mulder/xFile");
 
 // assertion will pass
 assertThat(xFile).hasParent(new File("mulder"));

 // assertion will fail
 assertThat(xFile).hasParent(new File("scully"));

Parameters:

expected - the expected parent File.

Returns:

this assertion object.

Throws:

NullPointerException - if the expected parent File is null.

RuntimeIOException - if an I/O error occurs.

AssertionError - if the actual File is null.

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

See Also:

parent definition.

hasParent

public S hasParent(String expected)

Same as hasParent(java.io.File) but takes care of converting given String as File for you

Example:

 File xFile = new File("mulder/xFile");
 
 // assertion will pass
 assertThat(xFile).hasParent("mulder");

 // assertion will fail
 assertThat(xFile).hasParent("scully");

hasExtension

public S hasExtension(String expected)

Verifies that the actual File has given extension.

Example:

 File xFile = new File("xFile.java");
 
 // assertion will pass
 assertThat(xFile).hasExtension("java");
 
 // assertion will fail
 assertThat(xFile).hasExtension("png");

Parameters:

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

Returns:

this assertion object.

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.

See Also:

Filename extension

hasName

public S hasName(String expected)

Verifies that the actual File has given name.

Example:

 File xFile = new File("somewhere/xFile.java");
 File xDirectory = new File("somewhere/xDirectory");
 
 // assertion will pass
 assertThat(xFile).hasName("xFile.java");
 assertThat(xDirectory).hasName("xDirectory");
 
 // assertion will fail
 assertThat(xFile).hasName("xFile");
 assertThat(xDirectory).hasName("somewhere");

Parameters:

expected - the expected File name.

Returns:

this assertion object.

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.

See Also:

name definition.

hasNoParent

public S hasNoParent()

Verifies that the actual File does not have a parent.

Example:

 File xFile = new File("somewhere/xFile.java");
 File xDirectory = new File("xDirectory");
 
 // assertion will pass
 assertThat(xDirectory).hasNoParent();
 
 // assertion will fail
 assertThat(xFile).hasNoParent();

Returns:

this assertion object.

Throws:

AssertionError - if the actual File is null.

AssertionError - if the actual File has a parent.