Package org.fest.assertions.api
Class FileAssert
- java.lang.Object
-
- org.fest.assertions.api.AbstractAssert<FileAssert,java.io.File>
-
- org.fest.assertions.api.FileAssert
-
- All Implemented Interfaces:
Assert<FileAssert,java.io.File>
,Descriptable<FileAssert>
,ExtensionPoints<FileAssert,java.io.File>
public class FileAssert extends AbstractAssert<FileAssert,java.io.File>
Assertion methods for
s.File
To create a new instance of this class, invoke
.Assertions.assertThat(File)
- Author:
- David DIDIER, Yvonne Wang, Alex Ruiz, Olivier Michallat, Olivier Demeijer
-
-
Field Summary
-
Fields inherited from class org.fest.assertions.api.AbstractAssert
actual, myself
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FileAssert(java.io.File actual)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FileAssert
canRead()
Verifies that the actualFile
can be read by the application.FileAssert
canWrite()
Verifies that the actualFile
can be modified by the application.FileAssert
doesNotExist()
Verifies that the actualFile
does not exist.FileAssert
exists()
Verifies that the actualFile
exists, regardless it's a file or directory.FileAssert
hasBinaryContent(byte[] expected)
Verifies that the binary content of the actualFile
is exactly equal to the given one.FileAssert
hasContent(java.lang.String expected)
Verifies that the text content of the actualFile
is exactly equal to the given one.
The charset to use when reading the file should be provided withusingCharset(Charset)
orusingCharset(String)
prior to calling this method; if not, the platform's default charset (as returned byCharset.defaultCharset()
) will be used.FileAssert
hasContentEqualTo(java.io.File expected)
Verifies that the content of the actualFile
is equal to the content of the given one.FileAssert
isAbsolute()
Verifies that the actualFile
is an absolute path.FileAssert
isDirectory()
Verifies that the actualFile
is an existing directory.FileAssert
isFile()
Verifies that the actualFile
is an existing file.FileAssert
isRelative()
Verifies that the actualFile
is a relative path.FileAssert
usingCharset(java.lang.String charsetName)
Specifies the name of the charset to use for text-based assertions on the file's contents.FileAssert
usingCharset(java.nio.charset.Charset charset)
Specifies the charset to use for text-based assertions on the file's contents.-
Methods inherited from class org.fest.assertions.api.AbstractAssert
as, as, describedAs, describedAs, descriptionText, doesNotHave, doesNotHaveSameClassAs, equals, getWritableAssertionInfo, has, hashCode, hasSameClassAs, is, isEqualTo, isExactlyInstanceOf, isIn, isIn, isInstanceOf, isInstanceOfAny, isNot, isNotEqualTo, isNotExactlyInstanceOf, isNotIn, isNotIn, isNotInstanceOf, isNotInstanceOfAny, isNotNull, isNotOfAnyClassIn, isNotSameAs, isNull, isOfAnyClassIn, isSameAs, overridingErrorMessage, usingComparator, usingDefaultComparator
-
-
-
-
Method Detail
-
exists
public FileAssert exists()
Verifies that the actualFile
exists, regardless it's a file or directory.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
does not exist.
-
doesNotExist
public FileAssert doesNotExist()
Verifies that the actualFile
does not exist.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
exists.
-
isFile
public FileAssert isFile()
Verifies that the actualFile
is an existing file.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not an existing file.
-
isDirectory
public FileAssert isDirectory()
Verifies that the actualFile
is an existing directory.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not an existing file.
-
isAbsolute
public FileAssert isAbsolute()
Verifies that the actualFile
is an absolute path.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not an absolute path.
-
isRelative
public FileAssert isRelative()
Verifies that the actualFile
is a relative path.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not a relative path.
-
hasContentEqualTo
public FileAssert hasContentEqualTo(java.io.File expected)
Verifies that the content of the actualFile
is equal to the content of the given one.- Parameters:
expected
- the givenFile
to compare the actualFile
to.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the givenFile
isnull
.java.lang.IllegalArgumentException
- if the givenFile
is not an existing file.java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not an existing file.org.fest.util.FilesException
- if an I/O error occurs.java.lang.AssertionError
- if the content of the actualFile
is not equal to the content of the given one.
-
hasBinaryContent
public FileAssert hasBinaryContent(byte[] expected)
Verifies that the binary content of the actualFile
is exactly equal to the given one.- Parameters:
expected
- the expected binary content to compare the actualFile
's content to.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given content isnull
.java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not an existing file.org.fest.util.FilesException
- if an I/O error occurs.java.lang.AssertionError
- if the content of the actualFile
is not equal to the given binary content.
-
usingCharset
public FileAssert usingCharset(java.lang.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:
java.lang.IllegalArgumentException
- if the given encoding is not supported on this platform.
-
usingCharset
public FileAssert usingCharset(java.nio.charset.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:
java.lang.NullPointerException
- if the given charset isnull
.
-
hasContent
public FileAssert hasContent(java.lang.String expected)
Verifies that the text content of the actualFile
is exactly equal to the given one.
The charset to use when reading the file should be provided withusingCharset(Charset)
orusingCharset(String)
prior to calling this method; if not, the platform's default charset (as returned byCharset.defaultCharset()
) will be used.- Parameters:
expected
- the expected text content to compare the actualFile
's content to.- Returns:
this
assertion object.- Throws:
java.lang.NullPointerException
- if the given content isnull
.java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
is not an existing file.org.fest.util.FilesException
- if an I/O error occurs.java.lang.AssertionError
- if the content of the actualFile
is not equal to the given binary content.
-
canWrite
public FileAssert canWrite()
Verifies that the actualFile
can be modified by the application.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
can not be modified by the application.
-
canRead
public FileAssert canRead()
Verifies that the actualFile
can be read by the application.- Returns:
this
assertion object.- Throws:
java.lang.AssertionError
- if the actualFile
isnull
.java.lang.AssertionError
- if the actualFile
can not be read by the application.
-
-