Package org.fest.assertions.api

Class FileAssert

java.lang.Object
org.fest.assertions.api.AbstractAssert<FileAssert,File>
org.fest.assertions.api.FileAssert
All Implemented Interfaces:
Assert<FileAssert,File>, Descriptable<FileAssert>, ExtensionPoints<FileAssert,File>
public class FileAssert extends AbstractAssert<FileAssert,File>
Assertion methods for Files.

To create a new instance of this class, invoke Assertions.assertThat(File).

Author:
David DIDIER, Yvonne Wang, Alex Ruiz, Olivier Michallat, Olivier Demeijer

  • Constructor Details

    • FileAssert

      protected FileAssert(File actual)

  • Method Details

    • exists

      public FileAssert exists()
      Verifies that the actual File exists, regardless it's a file or directory.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File does not exist.

    • doesNotExist

      public FileAssert doesNotExist()
      Verifies that the actual File does not exist.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File exists.

    • isFile

      public FileAssert isFile()
      Verifies that the actual File is an existing file.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File is not an existing file.

    • isDirectory

      public FileAssert isDirectory()
      Verifies that the actual File is an existing directory.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File is not an existing file.

    • isAbsolute

      public FileAssert isAbsolute()
      Verifies that the actual File is an absolute path.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File is not an absolute path.

    • isRelative

      public FileAssert isRelative()
      Verifies that the actual File is a relative path.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File is not a relative path.

    • hasContentEqualTo

      public FileAssert hasContentEqualTo(File expected)
      Verifies that the content of the actual File is equal to the content of the given one.
      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.
      org.fest.util.FilesException - 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 FileAssert hasBinaryContent(byte[] expected)
      Verifies that the binary content of the actual File is exactly equal to the given one.
      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.
      org.fest.util.FilesException - if an I/O error occurs.
      AssertionError - if the content of the actual File is not equal to the given binary content.

    • usingCharset

      public FileAssert 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 FileAssert 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 FileAssert 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.
      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.
      org.fest.util.FilesException - if an I/O error occurs.
      AssertionError - if the content of the actual File is not equal to the given binary content.

    • canWrite

      public FileAssert canWrite()
      Verifies that the actual File can be modified by the application.
      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 FileAssert canRead()
      Verifies that the actual File can be read by the application.
      Returns:
      this assertion object.
      Throws:
      AssertionError - if the actual File is null.
      AssertionError - if the actual File can not be read by the application.