public class Assertions extends Object
For example:
int removed = employees.removeFired();assertThat
(removed).isZero
(); List<Employee> newEmployees = employees.hired(TODAY);assertThat
(newEmployees).hasSize
(6);
Modifier | Constructor and Description |
---|---|
protected |
Assertions()
Creates a new
Assertions . |
Modifier and Type | Method and Description |
---|---|
static <T> Condition<T> |
allOf(Condition<? super T>... conditions)
Creates a new
|
static <T> Condition<T> |
allOf(Iterable<? extends Condition<? super T>> conditions)
Creates a new
|
static <T> Condition<T> |
anyOf(Condition<? super T>... conditions)
Only delegate to
AnyOf.anyOf(Condition...) so that Assertions offers a full feature entry point to all
AssertJ features (but you can use AnyOf if you prefer). |
static <T> Condition<T> |
anyOf(Iterable<? extends Condition<? super T>> conditions)
Creates a new
|
static BigDecimalAssert |
assertThat(BigDecimal actual)
Creates a new instance of
. |
static BooleanAssert |
assertThat(boolean actual)
Creates a new instance of
. |
static BooleanAssert |
assertThat(Boolean actual)
Creates a new instance of
. |
static BooleanArrayAssert |
assertThat(boolean[] actual)
Creates a new instance of
. |
static ByteAssert |
assertThat(byte actual)
Creates a new instance of
. |
static ByteAssert |
assertThat(Byte actual)
Creates a new instance of
. |
static ByteArrayAssert |
assertThat(byte[] actual)
Creates a new instance of
. |
static CharacterAssert |
assertThat(char actual)
Creates a new instance of
. |
static CharArrayAssert |
assertThat(char[] actual)
Creates a new instance of
. |
static CharacterAssert |
assertThat(Character actual)
Creates a new instance of
. |
static CharSequenceAssert |
assertThat(CharSequence actual)
Creates a new instance of
. |
static ClassAssert |
assertThat(Class<?> actual)
Creates a new instance of
|
static DateAssert |
assertThat(Date actual)
Creates a new instance of
. |
static DoubleAssert |
assertThat(double actual)
Creates a new instance of
. |
static DoubleAssert |
assertThat(Double actual)
Creates a new instance of
. |
static DoubleArrayAssert |
assertThat(double[] actual)
Creates a new instance of
. |
static FileAssert |
assertThat(File actual)
Creates a new instance of
. |
static FloatAssert |
assertThat(float actual)
Creates a new instance of
. |
static FloatAssert |
assertThat(Float actual)
Creates a new instance of
. |
static FloatArrayAssert |
assertThat(float[] actual)
Creates a new instance of
. |
static InputStreamAssert |
assertThat(InputStream actual)
Creates a new instance of
. |
static IntegerAssert |
assertThat(int actual)
Creates a new instance of
. |
static IntArrayAssert |
assertThat(int[] actual)
Creates a new instance of
. |
static IntegerAssert |
assertThat(Integer actual)
Creates a new instance of
. |
static <T> IterableAssert<T> |
assertThat(Iterable<T> actual)
Creates a new instance of
. |
static <T> IterableAssert<T> |
assertThat(Iterator<T> actual)
Creates a new instance of
by consuming the given
to build an
Be aware thar the given Iterator can't be use anymore since it has been consumed ! |
static <T> ListAssert<T> |
assertThat(List<T> actual)
Creates a new instance of
. |
static LongAssert |
assertThat(long actual)
Creates a new instance of
. |
static LongAssert |
assertThat(Long actual)
Creates a new instance of
. |
static LongArrayAssert |
assertThat(long[] actual)
Creates a new instance of
. |
static <K,V> MapAssert<K,V> |
assertThat(Map<K,V> actual)
Creates a new instance of
. |
static ShortAssert |
assertThat(short actual)
Creates a new instance of
. |
static ShortAssert |
assertThat(Short actual)
Creates a new instance of
. |
static ShortArrayAssert |
assertThat(short[] actual)
Creates a new instance of
. |
static StringAssert |
assertThat(String actual)
Creates a new instance of
. |
static <T> ObjectAssert<T> |
assertThat(T actual)
Creates a new instance of
. |
static <T extends AssertDelegateTarget> |
assertThat(T assertion)
Returns the given assertion.
|
static <T> ObjectArrayAssert<T> |
assertThat(T[] actual)
Creates a new instance of
. |
static ThrowableAssert |
assertThat(Throwable actual)
Creates a new instance of
. |
static Index |
atIndex(int index)
Only delegate to
Index.atIndex(int) so that Assertions offers a full feature entry point to all AssertJ
features (but you can use Index if you prefer). |
static String |
contentOf(File file)
Loads the text content of a file with the default character set, so that it can be passed to
assertThat(String) . |
static String |
contentOf(File file,
Charset charset)
Loads the text content of a file, so that it can be passed to
assertThat(String) . |
static String |
contentOf(File file,
String charsetName)
Loads the text content of a file, so that it can be passed to
assertThat(String) . |
static <T> DoesNotHave<T> |
doesNotHave(Condition<? super T> condition)
Creates a new
DoesNotHave . |
static MapEntry |
entry(Object key,
Object value)
Only delegate to
MapEntry.entry(Object, Object) so that Assertions offers a full feature entry point to
all
AssertJ features (but you can use MapEntry if you prefer). |
static Properties<Object> |
extractProperty(String propertyName)
Only delegate to
Properties.extractProperty(String) so that Assertions offers a full feature entry point
to
all AssertJ features (but you can use Properties if you prefer). |
static <T> Properties<T> |
extractProperty(String propertyName,
Class<T> propertyType)
Only delegate to
Properties.extractProperty(String) so that Assertions offers a full feature entry point
to
all AssertJ features (but you can use Properties if you prefer). |
static void |
fail(String failureMessage)
Only delegate to
Fail.fail(String) so that Assertions offers a full feature entry point to all Assertj
Assert features (but you can use Fail if you prefer). |
static void |
fail(String failureMessage,
Throwable realCause)
Only delegate to
Fail.fail(String, Throwable) so that Assertions offers a full feature entry point to all
AssertJ features (but you can use Fail if you prefer). |
static void |
failBecauseExceptionWasNotThrown(Class<? extends Throwable> exceptionClass)
Only delegate to
Fail.failBecauseExceptionWasNotThrown(Class) so that Assertions offers a full feature
entry point to all AssertJ features (but you can use Fail if you prefer). |
static <E> Filters<E> |
filter(E[] array)
Only delegate to
Filters.filter(Object[]) so that Assertions offers a full feature entry point to all
AssertJ features (but you can use Filters if you prefer). |
static <E> Filters<E> |
filter(Iterable<E> iterableToFilter)
Only delegate to
Filters.filter(Object[]) so that Assertions offers a full feature entry point to all
AssertJ features (but you can use Filters if you prefer). |
static List<String> |
linesOf(File file)
Loads the text content of a file into a list of strings with the default charset, each string corresponding to a line.
|
static List<String> |
linesOf(File file,
Charset charset)
Loads the text content of a file into a list of strings, each string corresponding to a line.
|
static List<String> |
linesOf(File file,
String charsetName)
Loads the text content of a file into a list of strings, each string corresponding to a line.
|
static <T> Not<T> |
not(Condition<? super T> condition)
Creates a new
Not . |
static Offset<Double> |
offset(Double value)
Assertions entry point for double
Offset . |
static Offset<Float> |
offset(Float value)
Assertions entry point for float
Offset . |
static void |
registerCustomDateFormat(DateFormat userCustomDateFormat)
Add the given date format to the ones used to parse date String in String based Date assertions like
AbstractDateAssert.isEqualTo(String) . |
static void |
registerCustomDateFormat(String userCustomDateFormatPattern)
Add the given date format to the ones used to parse date String in String based Date assertions like
AbstractDateAssert.isEqualTo(String) . |
static void |
setAllowExtractingPrivateFields(boolean allowExtractingPrivateFields)
Globally set whether
and
should be allowed to extract private fields, if not and they try it fails with exception. |
static void |
setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace)
Only delegate to
Fail.setRemoveAssertJRelatedElementsFromStackTrace(boolean) so that Assertions offers a
full feature entry point to all AssertJ Assert features (but you can use Fail if you prefer). |
static Tuple |
tuple(Object... values)
Utility method to build nicely a
Tuple when working with AbstractIterableAssert.extracting(String...) or
AbstractObjectArrayAssert.extracting(String...) |
static void |
useDateFormat(DateFormat userCustomDateFormat)
Deprecated.
: use
registerCustomDateFormat(java.text.DateFormat) instead. |
static void |
useDateFormat(String userCustomDateFormatPattern)
Deprecated.
: use
registerCustomDateFormat(String) instead. |
static void |
useDefaultDateFormats()
Deprecated.
use
useDefaultDateFormatsOnly() instead. |
static void |
useDefaultDateFormatsOnly()
Remove all registered custom date formats => use only the defaults date formats to parse string as date.
|
static void |
useIsoDateFormat()
Deprecated.
use
useDefaultDateFormatsOnly() instead, it includes this format. |
static void |
useIsoDateTimeFormat()
Deprecated.
use
useDefaultDateFormatsOnly() instead, it includes this format. |
static void |
useIsoDateTimeWithMsFormat()
Deprecated.
use
useDefaultDateFormatsOnly() instead, it includes this format. |
static Offset<BigDecimal> |
within(BigDecimal value)
Assertions entry point for BigDecimal
Offset to use with isCloseTo assertions. |
static Offset<Double> |
within(Double value)
Alias for
offset(Double) to use with isCloseTo assertions. |
static Offset<Float> |
within(Float value)
Alias for
offset(Float) to use with isCloseTo assertions. |
protected Assertions()
Assertions
.public static BigDecimalAssert assertThat(BigDecimal actual)
BigDecimalAssert
.actual
- the actual value.public static BooleanAssert assertThat(boolean actual)
BooleanAssert
.actual
- the actual value.public static BooleanAssert assertThat(Boolean actual)
BooleanAssert
.actual
- the actual value.public static BooleanArrayAssert assertThat(boolean[] actual)
BooleanArrayAssert
.actual
- the actual value.public static ByteAssert assertThat(byte actual)
ByteAssert
.actual
- the actual value.public static ByteAssert assertThat(Byte actual)
ByteAssert
.actual
- the actual value.public static ByteArrayAssert assertThat(byte[] actual)
ByteArrayAssert
.actual
- the actual value.public static CharacterAssert assertThat(char actual)
CharacterAssert
.actual
- the actual value.public static CharArrayAssert assertThat(char[] actual)
CharArrayAssert
.actual
- the actual value.public static CharacterAssert assertThat(Character actual)
CharacterAssert
.actual
- the actual value.public static ClassAssert assertThat(Class<?> actual)
ClassAssert
actual
- the actual value.public static <T> IterableAssert<T> assertThat(Iterable<T> actual)
IterableAssert
.actual
- the actual value.public static <T> IterableAssert<T> assertThat(Iterator<T> actual)
IterableAssert
by consuming the given Iterator
to build an Iterable
Be aware thar the given Iterator can't be use anymore since it has been consumed !actual
- the actual value.public static DoubleAssert assertThat(double actual)
DoubleAssert
.actual
- the actual value.public static DoubleAssert assertThat(Double actual)
DoubleAssert
.actual
- the actual value.public static DoubleArrayAssert assertThat(double[] actual)
DoubleArrayAssert
.actual
- the actual value.public static FileAssert assertThat(File actual)
FileAssert
.actual
- the actual value.public static InputStreamAssert assertThat(InputStream actual)
InputStreamAssert
.actual
- the actual value.public static FloatAssert assertThat(float actual)
FloatAssert
.actual
- the actual value.public static FloatAssert assertThat(Float actual)
FloatAssert
.actual
- the actual value.public static FloatArrayAssert assertThat(float[] actual)
FloatArrayAssert
.actual
- the actual value.public static IntegerAssert assertThat(int actual)
IntegerAssert
.actual
- the actual value.public static IntArrayAssert assertThat(int[] actual)
IntArrayAssert
.actual
- the actual value.public static IntegerAssert assertThat(Integer actual)
IntegerAssert
.actual
- the actual value.public static <T> ListAssert<T> assertThat(List<T> actual)
ListAssert
.actual
- the actual value.public static LongAssert assertThat(long actual)
LongAssert
.actual
- the actual value.public static LongAssert assertThat(Long actual)
LongAssert
.actual
- the actual value.public static LongArrayAssert assertThat(long[] actual)
LongArrayAssert
.actual
- the actual value.public static <T> ObjectAssert<T> assertThat(T actual)
ObjectAssert
.actual
- the actual value.public static <T extends AssertDelegateTarget> T assertThat(T assertion)
assertThat
.
Consider for example the following MyButton and MyButtonAssert classes:
public class MyButton extends JButton { private boolean blinking; public boolean isBlinking() { return this.blinking; } public void setBlinking(boolean blink) { this.blinking = blink; } } private static class MyButtonAssert implements AssertDelegateTarget { private MyButton button; MyButtonAssert(MyButton button) { this.button = button; } void isBlinking() { // standard assertion from core Assertions.assertThat assertThat(button.isBlinking()).isTrue(); } void isNotBlinking() { // standard assertion from core Assertions.assertThat assertThat(button.isBlinking()).isFalse(); } }As MyButtonAssert implements AssertDelegateTarget, you can use
assertThat(buttonAssert).isBlinking();
instead of buttonAssert.isBlinking();
to have easier to read assertions.
@Test public void AssertDelegateTarget_example() { MyButton button = new MyButton(); MyButtonAssert buttonAssert = new MyButtonAssert(button); // you can encapsulate MyButtonAssert assertions methods within assertThat assertThat(buttonAssert).isNotBlinking(); // same as : buttonAssert.isNotBlinking(); button.setBlinking(true); assertThat(buttonAssert).isBlinking(); // same as : buttonAssert.isBlinking(); }
T
- the generic type of the user-defined assert.assertion
- the assertion to return.public static <T> ObjectArrayAssert<T> assertThat(T[] actual)
ObjectArrayAssert
.actual
- the actual value.public static <K,V> MapAssert<K,V> assertThat(Map<K,V> actual)
MapAssert
.actual
- the actual value.public static ShortAssert assertThat(short actual)
ShortAssert
.actual
- the actual value.public static ShortAssert assertThat(Short actual)
ShortAssert
.actual
- the actual value.public static ShortArrayAssert assertThat(short[] actual)
ShortArrayAssert
.actual
- the actual value.public static CharSequenceAssert assertThat(CharSequence actual)
CharSequenceAssert
.actual
- the actual value.public static StringAssert assertThat(String actual)
StringAssert
.actual
- the actual value.public static DateAssert assertThat(Date actual)
DateAssert
.actual
- the actual value.public static ThrowableAssert assertThat(Throwable actual)
ThrowableAssert
.actual
- the actual value.public static void setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace)
Fail.setRemoveAssertJRelatedElementsFromStackTrace(boolean)
so that Assertions offers a
full feature entry point to all AssertJ Assert features (but you can use Fail
if you prefer).public static void fail(String failureMessage)
Fail.fail(String)
so that Assertions offers a full feature entry point to all Assertj
Assert features (but you can use Fail if you prefer).public static void fail(String failureMessage, Throwable realCause)
Fail.fail(String, Throwable)
so that Assertions offers a full feature entry point to all
AssertJ features (but you can use Fail if you prefer).public static void failBecauseExceptionWasNotThrown(Class<? extends Throwable> exceptionClass)
Fail.failBecauseExceptionWasNotThrown(Class)
so that Assertions offers a full feature
entry point to all AssertJ features (but you can use Fail if you prefer).public static <T> Properties<T> extractProperty(String propertyName, Class<T> propertyType)
Properties.extractProperty(String)
so that Assertions offers a full feature entry point
to
all AssertJ features (but you can use Properties
if you prefer).
Typical usage is to chain extractProperty
with from
method, see examples below :
// extract simple property values having a java standard type (here String) assertThat(extractProperty("name", String.class).from(fellowshipOfTheRing)).contains(" Boromir", "Gandalf", "Frodo", "Legolas").doesNotContain("Sauron", "Elrond"); // extracting property works also with user's types (here Race) assertThat(extractProperty("race", String.class).from(fellowshipOfTheRing)).contains(HOBBIT, ELF).doesNotContain(ORC); // extract nested property on Race assertThat(extractProperty("race.name", String.class).from(fellowshipOfTheRing)).contains(" Hobbit", "Elf") .doesNotContain("Orc");
public static Properties<Object> extractProperty(String propertyName)
Properties.extractProperty(String)
so that Assertions offers a full feature entry point
to
all AssertJ features (but you can use Properties
if you prefer).
Typical usage is to chain extractProperty
with from
method, see examples below :
// extract simple property values, as no type has been defined the extracted property will be considered as Object // to define the real property type (here String) use extractProperty("name", String.class) instead. assertThat(extractProperty("name").from(fellowshipOfTheRing)).contains("Boromir", "Gandalf", "Frodo", "Legolas") .doesNotContain("Sauron", "Elrond"); // extracting property works also with user's types (here Race), even though it will be considered as Object // to define the real property type (here String) use extractProperty("name", Race.class) instead. assertThat(extractProperty("race").from(fellowshipOfTheRing)).contains(HOBBIT, ELF).doesNotContain(ORC); // extract nested property on Race assertThat(extractProperty("race.name").from(fellowshipOfTheRing)).contains("Hobbit", "Elf").doesNotContain("Orc");
public static Tuple tuple(Object... values)
Tuple
when working with AbstractIterableAssert.extracting(String...)
or
AbstractObjectArrayAssert.extracting(String...)
public static void setAllowExtractingPrivateFields(boolean allowExtractingPrivateFields)
IterableAssert#extracting(String)
and
ObjectArrayAssert#extracting(String)
should be allowed to extract private fields, if not and they try it fails with exception.allowExtractingPrivateFields
- allow private fields extraction. Default true
.public static MapEntry entry(Object key, Object value)
MapEntry.entry(Object, Object)
so that Assertions offers a full feature entry point to
all
AssertJ features (but you can use MapEntry
if you prefer).
Typical usage is to call entry
in MapAssert contains
assertion, see examples below :
assertThat(ringBearers).contains(entry(oneRing, frodo), entry(nenya, galadriel));
public static Index atIndex(int index)
Index.atIndex(int)
so that Assertions offers a full feature entry point to all AssertJ
features (but you can use Index
if you prefer).
Typical usage :
List<Ring> elvesRings = newArrayList(vilya, nenya, narya); assertThat(elvesRings).contains(vilya, atIndex(0)).contains(nenya, atIndex(1)).contains(narya, atIndex(2));
public static Offset<Double> offset(Double value)
Offset
.
Typical usage :
assertThat(8.1).isEqualTo(8.0, offset(0.1));
public static Offset<Float> offset(Float value)
Offset
.
Typical usage :
assertThat(8.2f).isCloseTo(8.0f, offset(0.2f));
public static Offset<Double> within(Double value)
offset(Double)
to use with isCloseTo assertions.
Typical usage :
assertThat(8.1).isCloseTo(8.0, within(0.1));
public static Offset<Float> within(Float value)
offset(Float)
to use with isCloseTo assertions.
Typical usage :
assertThat(8.2f).isCloseTo(8.0f, within(0.2f));
public static Offset<BigDecimal> within(BigDecimal value)
Offset
to use with isCloseTo assertions.
Typical usage :
assertThat(BigDecimal.TEN).isCloseTo(new BigDecimal("10.5"), within(BigDecimal.ONE));
public static <T> Condition<T> allOf(Condition<? super T>... conditions)
AllOf
T
- the type of object the given condition accept.conditions
- the conditions to evaluate.AnyOf
.NullPointerException
- if the given array is null
.NullPointerException
- if any of the elements in the given array is null
.public static <T> Condition<T> allOf(Iterable<? extends Condition<? super T>> conditions)
AllOf
T
- the type of object the given condition accept.conditions
- the conditions to evaluate.AnyOf
.NullPointerException
- if the given iterable is null
.NullPointerException
- if any of the elements in the given iterable is null
.public static <T> Condition<T> anyOf(Condition<? super T>... conditions)
AnyOf.anyOf(Condition...)
so that Assertions offers a full feature entry point to all
AssertJ features (but you can use AnyOf
if you prefer).
Typical usage (jedi
and sith
are Condition
) :
assertThat("Vader").is(anyOf(jedi, sith));
public static <T> Condition<T> anyOf(Iterable<? extends Condition<? super T>> conditions)
AnyOf
T
- the type of object the given condition accept.conditions
- the conditions to evaluate.AnyOf
.NullPointerException
- if the given iterable is null
.NullPointerException
- if any of the elements in the given iterable is null
.public static <T> DoesNotHave<T> doesNotHave(Condition<? super T> condition)
DoesNotHave
.condition
- the condition to inverse.public static <T> Not<T> not(Condition<? super T> condition)
Not
.condition
- the condition to inverse.public static <E> Filters<E> filter(E[] array)
Filters.filter(Object[])
so that Assertions offers a full feature entry point to all
AssertJ features (but you can use Filters
if you prefer).
Note that the given array is not modified, the filters are performed on an Iterable
copy of the array.
Typical usage with Condition
:
assertThat(filter(players).being(potentialMVP).get()).containsOnly(james, rose);and with filter language based on java bean property :
assertThat(filter(players).with("pointsPerGame").greaterThan(20).and("assistsPerGame") .greaterThan(7).get()) .containsOnly(james, rose);
public static <E> Filters<E> filter(Iterable<E> iterableToFilter)
Filters.filter(Object[])
so that Assertions offers a full feature entry point to all
AssertJ features (but you can use Filters
if you prefer).
Note that the given Iterable
is not modified, the filters are performed on a copy.
Typical usage with Condition
:
assertThat(filter(players).being(potentialMVP).get()).containsOnly(james, rose);and with filter language based on java bean property :
assertThat(filter(players).with("pointsPerGame").greaterThan(20).and("assistsPerGame") .greaterThan(7).get()) .containsOnly(james, rose);
public static String contentOf(File file, Charset charset)
assertThat(String)
. Note that this will
load the entire file in memory; for larger files, there might be a more efficient alternative with assertThat(File)
.
file
- the file.charset
- the character set to use.NullPointerException
- if the given charset is null
.FilesException
- if an I/O exception occurs.public static String contentOf(File file, String charsetName)
assertThat(String)
. Note that this will
load the entire file in memory; for larger files, there might be a more efficient alternative with assertThat(File)
.
file
- the file.charsetName
- the name of the character set to use.IllegalArgumentException
- if the given character set is not supported on this platform.FilesException
- if an I/O exception occurs.public static String contentOf(File file)
assertThat(String)
. Note that this will load the entire file in memory; for larger files, there might be a
more efficient alternative with assertThat(File)
.
file
- the file.FilesException
- if an I/O exception occurs.public static List<String> linesOf(File file)
file
- the file.NullPointerException
- if the given charset is null
.FilesException
- if an I/O exception occurs.public static List<String> linesOf(File file, Charset charset)
file
- the file.charset
- the character set to use.NullPointerException
- if the given charset is null
.FilesException
- if an I/O exception occurs.public static List<String> linesOf(File file, String charsetName)
file
- the file.charsetName
- the name of the character set to use.NullPointerException
- if the given charset is null
.FilesException
- if an I/O exception occurs.public static void registerCustomDateFormat(DateFormat userCustomDateFormat)
AbstractDateAssert.isEqualTo(String)
.
User date formats are used before default ones in the order they have been registered (first registered, first used).
AssertJ is gonna use any date formats registered with one of these methods :
AbstractDateAssert.withDateFormat(String)
AbstractDateAssert.withDateFormat(java.text.DateFormat)
registerCustomDateFormat(java.text.DateFormat)
registerCustomDateFormat(String)
useDefaultDateFormatsOnly()
or AbstractDateAssert.withDefaultDateFormatsOnly()
.
Code examples:
Date date = ... // set to 2003 April the 26th assertThat(date).isEqualTo("2003-04-26"); try { // date with a custom format : failure since the default formats don't match. assertThat(date).isEqualTo("2003/04/26"); } catch (AssertionError e) { assertThat(e).hasMessage("Failed to parse 2003/04/26 with any of these date formats: " + "[yyyy-MM-dd'T'HH:mm:ss.SSS, yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd]"); } // registering a custom date format to make the assertion pass registerCustomDateFormat(new SimpleDateFormat("yyyy/MM/dd")); // registerCustomDateFormat("yyyy/MM/dd") would work to. assertThat(date).isEqualTo("2003/04/26"); // the default formats are still available and should work assertThat(date).isEqualTo("2003-04-26");
userCustomDateFormat
- the new Date format used for String based Date assertions.public static void registerCustomDateFormat(String userCustomDateFormatPattern)
AbstractDateAssert.isEqualTo(String)
.
User date formats are used before default ones in the order they have been registered (first registered, first used).
AssertJ is gonna use any date formats registered with one of these methods :
AbstractDateAssert.withDateFormat(String)
AbstractDateAssert.withDateFormat(java.text.DateFormat)
registerCustomDateFormat(java.text.DateFormat)
registerCustomDateFormat(String)
useDefaultDateFormatsOnly()
or AbstractDateAssert.withDefaultDateFormatsOnly()
.
Code examples:
Date date = ... // set to 2003 April the 26th assertThat(date).isEqualTo("2003-04-26"); try { // date with a custom format : failure since the default formats don't match. assertThat(date).isEqualTo("2003/04/26"); } catch (AssertionError e) { assertThat(e).hasMessage("Failed to parse 2003/04/26 with any of these date formats: " + "[yyyy-MM-dd'T'HH:mm:ss.SSS, yyyy-MM-dd'T'HH:mm:ss, yyyy-MM-dd]"); } // registering a custom date format to make the assertion pass registerCustomDateFormat("yyyy/MM/dd"); assertThat(date).isEqualTo("2003/04/26"); // the default formats are still available and should work assertThat(date).isEqualTo("2003-04-26");
userCustomDateFormatPattern
- the new Date format pattern used for String based Date assertions.public static void useDefaultDateFormatsOnly()
yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd
2003-04-26T03:01:02.999
2003-04-26T13:01:02
2003-04-26
@Deprecated public static void useDateFormat(DateFormat userCustomDateFormat)
registerCustomDateFormat(java.text.DateFormat)
instead.@Deprecated public static void useDateFormat(String userCustomDateFormatPattern)
registerCustomDateFormat(String)
instead.@Deprecated public static void useIsoDateFormat()
useDefaultDateFormatsOnly()
instead, it includes this format.@Deprecated public static void useIsoDateTimeFormat()
useDefaultDateFormatsOnly()
instead, it includes this format.@Deprecated public static void useIsoDateTimeWithMsFormat()
useDefaultDateFormatsOnly()
instead, it includes this format.@Deprecated public static void useDefaultDateFormats()
useDefaultDateFormatsOnly()
instead.Copyright © 2013-2014 AssertJ. All Rights Reserved.