Package org.assertj.core.api

Class AbstractFileAssert<SELF extends AbstractFileAssert<SELF>>

java.lang.Object
org.assertj.core.api.AbstractAssert<SELF,File>
org.assertj.core.api.AbstractFileAssert<SELF>
Type Parameters:
SELF - 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<SELF,File>, Descriptable<SELF>, ExtensionPoints<SELF,File>
Direct Known Subclasses:
FileAssert
public abstract class AbstractFileAssert<SELF extends AbstractFileAssert<SELF>> extends AbstractAssert<SELF,File>
Base class for all implementations of assertions for Files.

  • Field Details

  • Constructor Details

    • AbstractFileAssert

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

  • Method Details

    • exists

      public SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF hasContentEqualTo(File expected)
      Deprecated.
      use hasSameContentAs(File) 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 charset
 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 SELF 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 charset
 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 SELF 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 Charset 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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 SELF 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:

    • hasParent

      public SELF 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 SELF 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:

    • hasName

      public SELF 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:

    • hasNoParent

      public SELF 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.