AssertJ Core 3.26.0 · org.assertj.core.configuration.Configuration

Modifier and Type	Field and Description
private List<DateFormat>	additionalDateFormats
public static final boolean	ALLOW_COMPARING_PRIVATE_FIELDS
public static final boolean	ALLOW_EXTRACTING_PRIVATE_FIELDS
public static final boolean	BARE_NAME_PROPERTY_EXTRACTION_ENABLED
private boolean	bareNamePropertyExtraction
private boolean	comparingPrivateFields
public static final Configuration	DEFAULT_CONFIGURATION
private Consumer<Description>	descriptionConsumer
private boolean	extractingPrivateFields
public static final boolean	LENIENT_DATE_PARSING
private boolean	lenientDateParsing
public static final int	MAX_ELEMENTS_FOR_PRINTING
public static final int	MAX_INDICES_FOR_PRINTING
public static final int	MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION
public static final int	MAX_STACKTRACE_ELEMENTS_DISPLAYED
private int	maxElementsForPrinting
private int	maxLengthForSingleLineDescription
private int	maxStackTraceElementsDisplayed
public static final PreferredAssumptionException	PREFERRED_ASSUMPTION_EXCEPTION
private PreferredAssumptionException	preferredAssumptionException
public static final boolean	PRINT_ASSERTIONS_DESCRIPTION_ENABLED
private boolean	printAssertionsDescription
public static final boolean	REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE
private boolean	removeAssertJRelatedElementsFromStackTrace

Access	Constructor and Description
public	Configuration()

Method Summary

Modifier and Type	Method and Description
public void	addAdditionalDateFormats(DateFormat... the date formats AssertJ will use in date assertions in addition the default ones. additionalDateFormats) Add the given date formats AssertJ will use in date assertions.
public List<DateFormat>	Returns: the date formats AssertJ will use in date assertions in addition the default ones. additionalDateFormats() AssertJ uses defaults date formats in date assertions, this property let's you register additional ones (default there are no additional date formats).
public void	apply() Applies this configuration to AssertJ.
public void	applyAndDisplay() Applies this configuration to AssertJ and prints it.
public boolean	Returns: whether the extractor considers bare-named property methods like `String name()`. bareNamePropertyExtractionEnabled() Returns whether the extractor considers bare-named property methods like `String name()`.
public boolean	Returns: whether private fields comparison is enabled. comparingPrivateFieldsEnabled() Returns whether private fields comparison is enabled.
public String	describe()
private String	describe(DateFormat dateFormat)
private String	describeAdditionalDateFormats()
public Consumer<Description>	descriptionConsumer()
public boolean	Returns: whether private fields comparison is enabled. extractingPrivateFieldsEnabled() Returns whether private fields comparison is enabled.
pack-priv boolean	hasCustomRepresentation()
public boolean	Returns: whether AssertJ will use lenient parsing mode for default date formats. lenientDateParsingEnabled() Returns whether AssertJ will use lenient parsing mode for default date formats.
public int	Returns: the maximum length for an iterable/array to be displayed on one line. maxElementsForPrinting() Returns how many elements at most from one iterable/array/map will be displayed in error messages.
public int	Returns: the maximum length for an iterable/array to be displayed on one line. maxLengthForSingleLineDescription() Returns the maximum length for an iterable/array to be displayed on one line.
public int	Returns: the maximum number of lines for a stacktrace to be displayed on one throw. maxStackTraceElementsDisplayed() Returns the maximum number of lines for a stacktrace to be displayed on one throw.
public PreferredAssumptionException	Returns: the assumption exception to throw. preferredAssumptionException() Returns which exception is thrown if an assumption is not met.
public boolean	printAssertionsDescription()
public boolean	Returns: whether AssertJ related elements are removed from assertion errors stack trace. removeAssertJRelatedElementsFromStackTraceEnabled() Returns whether AssertJ related elements are removed from assertion errors stack trace.
public Representation	Returns: the default `Representation` that is used within AssertJ. representation()
public void	setAdditionalDateFormats(List<DateFormat> the date formats AssertJ will use in date assertions in addition the default ones. additionalDateFormats) Returns the additional date formats AssertJ will use in date assertions.
public void	setBareNamePropertyExtraction(boolean whether the extractor considers bare-named property methods. bareNamePropertyExtraction) Sets whether the extractor considers bare-named property methods like `String name()`.
public void	setComparingPrivateFields(boolean whether private fields comparison is enabled. comparingPrivateFields) Sets whether private fields comparison is enabled.
public void	setDefaults() Set all configuration settings to their default values again.
public void	setDescriptionConsumer(Consumer<Description> descriptionConsumer)
public void	setExtractingPrivateFields(boolean whether private fields comparison is enabled. extractingPrivateFields) Sets whether private fields comparison is enabled.
public void	setLenientDateParsing(boolean whether AssertJ will use lenient parsing mode for default date formats. lenientDateParsing) Returns whether AssertJ will use lenient parsing mode for default date formats.
public void	setMaxElementsForPrinting(int the maximum length for an iterable/array to be displayed on one line. maxElementsForPrinting) Sets the threshold for how many elements at most from one iterable/array/map will be displaye in error messages.
public void	setMaxLengthForSingleLineDescription(int the maximum length for an iterable/array to be displayed on one line. maxLengthForSingleLineDescription) Sets the maximum length for an iterable/array to be displayed on one line.
public void	setMaxStackTraceElementsDisplayed(int the maximum number of lines for a stacktrace to be displayed on one throw. maxStackTraceElementsDisplayed) Returns the maximum number of lines for a stacktrace to be displayed on one throw.
public void	setPreferredAssumptionException(PreferredAssumptionException the preferred exception to use with `Assumptions`. preferredAssumptionException) Sets which exception is thrown if an assumption is not met.
public void	setPrintAssertionsDescriptionEnabled(boolean printAssertionsDescription)
public void	setRemoveAssertJRelatedElementsFromStackTrace(boolean whether AssertJ related elements are removed from assertion errors stack trace. removeAssertJRelatedElementsFromStackTrace) Returns whether AssertJ related elements are removed from assertion errors stack trace.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

additionalDateFormats	back to summary
private List<DateFormat> additionalDateFormats

ALLOW_COMPARING_PRIVATE_FIELDS	back to summary
public static final boolean ALLOW_COMPARING_PRIVATE_FIELDS

ALLOW_EXTRACTING_PRIVATE_FIELDS	back to summary
public static final boolean ALLOW_EXTRACTING_PRIVATE_FIELDS

BARE_NAME_PROPERTY_EXTRACTION_ENABLED	back to summary
public static final boolean BARE_NAME_PROPERTY_EXTRACTION_ENABLED

bareNamePropertyExtraction	back to summary
private boolean bareNamePropertyExtraction

comparingPrivateFields	back to summary
private boolean comparingPrivateFields

DEFAULT_CONFIGURATION	back to summary
public static final Configuration DEFAULT_CONFIGURATION

descriptionConsumer	back to summary
private Consumer<Description> descriptionConsumer

extractingPrivateFields	back to summary
private boolean extractingPrivateFields

LENIENT_DATE_PARSING	back to summary
public static final boolean LENIENT_DATE_PARSING

lenientDateParsing	back to summary
private boolean lenientDateParsing

MAX_ELEMENTS_FOR_PRINTING	back to summary
public static final int MAX_ELEMENTS_FOR_PRINTING

MAX_INDICES_FOR_PRINTING	back to summary
public static final int MAX_INDICES_FOR_PRINTING

MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION	back to summary
public static final int MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION

MAX_STACKTRACE_ELEMENTS_DISPLAYED	back to summary
public static final int MAX_STACKTRACE_ELEMENTS_DISPLAYED

maxElementsForPrinting	back to summary
private int maxElementsForPrinting

maxLengthForSingleLineDescription	back to summary
private int maxLengthForSingleLineDescription

maxStackTraceElementsDisplayed	back to summary
private int maxStackTraceElementsDisplayed

PREFERRED_ASSUMPTION_EXCEPTION	back to summary
public static final PreferredAssumptionException PREFERRED_ASSUMPTION_EXCEPTION

preferredAssumptionException	back to summary
private PreferredAssumptionException preferredAssumptionException

PRINT_ASSERTIONS_DESCRIPTION_ENABLED	back to summary
public static final boolean PRINT_ASSERTIONS_DESCRIPTION_ENABLED

printAssertionsDescription	back to summary
private boolean printAssertionsDescription

REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE	back to summary
public static final boolean REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE

removeAssertJRelatedElementsFromStackTrace	back to summary
private boolean removeAssertJRelatedElementsFromStackTrace

Configuration	back to summary
public Configuration()

Method Detail

addAdditionalDateFormats back to summary

addAdditionalDateFormats	back to summary
public void addAdditionalDateFormats(DateFormat... additionalDateFormats) Add the given date formats AssertJ will use in date assertions. See `Assertions#registerCustomDateFormat(java.text.DateFormat)` for a detailed description. Note that this change will only be effective once `apply()` or `applyAndDisplay()` is called. Parameters additionalDateFormats:DateFormat[] the date formats AssertJ will use in date assertions in addition the default ones.

public void addAdditionalDateFormats(DateFormat... additionalDateFormats)

Add the given date formats AssertJ will use in date assertions.

See Assertions#registerCustomDateFormat(java.text.DateFormat) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

additionalDateFormats:DateFormat[]: the date formats AssertJ will use in date assertions in addition the default ones.

additionalDateFormats back to summary

additionalDateFormats	back to summary
public List<DateFormat> additionalDateFormats() AssertJ uses defaults date formats in date assertions, this property let's you register additional ones (default there are no additional date formats). See `Assertions#registerCustomDateFormat(java.text.DateFormat)` for a detailed description. Returns:List<DateFormat> the date formats AssertJ will use in date assertions in addition the default ones.

public List<DateFormat> additionalDateFormats()

AssertJ uses defaults date formats in date assertions, this property let's you register additional ones (default there are no additional date formats).

See Assertions#registerCustomDateFormat(java.text.DateFormat) for a detailed description.

Returns:List<DateFormat>: the date formats AssertJ will use in date assertions in addition the default ones.

apply	back to summary
public void apply() Applies this configuration to AssertJ.

applyAndDisplay	back to summary
public void applyAndDisplay() Applies this configuration to AssertJ and prints it.

bareNamePropertyExtractionEnabled back to summary

bareNamePropertyExtractionEnabled	back to summary
public boolean bareNamePropertyExtractionEnabled() Returns whether the extractor considers bare-named property methods like `String name()`. Default is true. See `Assertions#setExtractBareNamePropertyMethods(boolean)` for a detailed description. Returns:boolean whether the extractor considers bare-named property methods like `String name()`.

public boolean bareNamePropertyExtractionEnabled()

Returns whether the extractor considers bare-named property methods like String name(). Default is true.

See Assertions#setExtractBareNamePropertyMethods(boolean) for a detailed description.

Returns:boolean: whether the extractor considers bare-named property methods like String name().

comparingPrivateFieldsEnabled back to summary

comparingPrivateFieldsEnabled	back to summary
public boolean comparingPrivateFieldsEnabled() Returns whether private fields comparison is enabled. Default is true. See `Assertions#setAllowComparingPrivateFields(boolean)` for a detailed description. Returns:boolean whether private fields comparison is enabled.

public boolean comparingPrivateFieldsEnabled()

Returns whether private fields comparison is enabled. Default is true.

See Assertions#setAllowComparingPrivateFields(boolean) for a detailed description.

Returns:boolean: whether private fields comparison is enabled.

describe	back to summary
public String describe()

describe	back to summary
private String describe(DateFormat dateFormat)

describeAdditionalDateFormats	back to summary
private String describeAdditionalDateFormats()

descriptionConsumer	back to summary
public Consumer<Description> descriptionConsumer()

extractingPrivateFieldsEnabled back to summary

extractingPrivateFieldsEnabled	back to summary
public boolean extractingPrivateFieldsEnabled() Returns whether private fields comparison is enabled. Default is true. See `Assertions#setAllowExtractingPrivateFields(boolean)` for a detailed description. Returns:boolean whether private fields comparison is enabled.

public boolean extractingPrivateFieldsEnabled()

Returns whether private fields comparison is enabled. Default is true.

See Assertions#setAllowExtractingPrivateFields(boolean) for a detailed description.

Returns:boolean: whether private fields comparison is enabled.

hasCustomRepresentation	back to summary
pack-priv boolean hasCustomRepresentation()

lenientDateParsingEnabled back to summary

lenientDateParsingEnabled	back to summary
public boolean lenientDateParsingEnabled() Returns whether AssertJ will use lenient parsing mode for default date formats. Default is false. See `Assertions#setLenientDateParsing(boolean)` for a detailed description. Returns:boolean whether AssertJ will use lenient parsing mode for default date formats.

public boolean lenientDateParsingEnabled()

Returns whether AssertJ will use lenient parsing mode for default date formats. Default is false.

See Assertions#setLenientDateParsing(boolean) for a detailed description.

Returns:boolean: whether AssertJ will use lenient parsing mode for default date formats.

maxElementsForPrinting back to summary

maxElementsForPrinting	back to summary
public int maxElementsForPrinting() Returns how many elements at most from one iterable/array/map will be displayed in error messages. Default is 1000. See `Assertions#setMaxElementsForPrinting(int)` for a detailed description. Returns:int the maximum length for an iterable/array to be displayed on one line.

public int maxElementsForPrinting()

Returns how many elements at most from one iterable/array/map will be displayed in error messages.

Default is 1000.

See Assertions#setMaxElementsForPrinting(int) for a detailed description.

Returns:int: the maximum length for an iterable/array to be displayed on one line.

maxLengthForSingleLineDescription back to summary

maxLengthForSingleLineDescription	back to summary
public int maxLengthForSingleLineDescription() Returns the maximum length for an iterable/array to be displayed on one line. Default is 80. See `Assertions#setMaxLengthForSingleLineDescription(int)` for a detailed description. Returns:int the maximum length for an iterable/array to be displayed on one line.

public int maxLengthForSingleLineDescription()

Returns the maximum length for an iterable/array to be displayed on one line. Default is 80.

See Assertions#setMaxLengthForSingleLineDescription(int) for a detailed description.

Returns:int: the maximum length for an iterable/array to be displayed on one line.

maxStackTraceElementsDisplayed back to summary

maxStackTraceElementsDisplayed	back to summary
public int maxStackTraceElementsDisplayed() Returns the maximum number of lines for a stacktrace to be displayed on one throw. Default is 3. See `(int)` for a detailed description. Returns:int the maximum number of lines for a stacktrace to be displayed on one throw.

public int maxStackTraceElementsDisplayed()

Returns the maximum number of lines for a stacktrace to be displayed on one throw. Default is 3.

See (int) for a detailed description.

Returns:int: the maximum number of lines for a stacktrace to be displayed on one throw.

preferredAssumptionException back to summary

preferredAssumptionException	back to summary
public PreferredAssumptionException preferredAssumptionException() Returns which exception is thrown if an assumption is not met. See `Assumptions#setPreferredAssumptionException(PreferredAssumptionException)` for a detailed description. Returns:PreferredAssumptionException the assumption exception to throw. Since 3.21.0

public PreferredAssumptionException preferredAssumptionException()

Returns which exception is thrown if an assumption is not met.

See Assumptions#setPreferredAssumptionException(PreferredAssumptionException) for a detailed description.

Returns:PreferredAssumptionException: the assumption exception to throw.
Since: 3.21.0

printAssertionsDescription	back to summary
public boolean printAssertionsDescription()

removeAssertJRelatedElementsFromStackTraceEnabled back to summary

removeAssertJRelatedElementsFromStackTraceEnabled	back to summary
public boolean removeAssertJRelatedElementsFromStackTraceEnabled() Returns whether AssertJ related elements are removed from assertion errors stack trace. Default is true. See `Assertions#setRemoveAssertJRelatedElementsFromStackTrace(boolean)` for a detailed description. Returns:boolean whether AssertJ related elements are removed from assertion errors stack trace.

public boolean removeAssertJRelatedElementsFromStackTraceEnabled()

Returns whether AssertJ related elements are removed from assertion errors stack trace. Default is true.

See Assertions#setRemoveAssertJRelatedElementsFromStackTrace(boolean) for a detailed description.

Returns:boolean: whether AssertJ related elements are removed from assertion errors stack trace.

representation	back to summary
public Representation representation() Returns:Representation the default `Representation` that is used within AssertJ.

setAdditionalDateFormats back to summary

setAdditionalDateFormats	back to summary
public void setAdditionalDateFormats(List<DateFormat> additionalDateFormats) Returns the additional date formats AssertJ will use in date assertions. See `Assertions#registerCustomDateFormat(java.text.DateFormat)` for a detailed description. Note that this change will only be effective once `apply()` or `applyAndDisplay()` is called. Parameters additionalDateFormats:List<DateFormat> the date formats AssertJ will use in date assertions in addition the default ones.

public void setAdditionalDateFormats(List<DateFormat> additionalDateFormats)

Returns the additional date formats AssertJ will use in date assertions.

See Assertions#registerCustomDateFormat(java.text.DateFormat) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

additionalDateFormats:List<DateFormat>: the date formats AssertJ will use in date assertions in addition the default ones.

setBareNamePropertyExtraction back to summary

setBareNamePropertyExtraction	back to summary
public void setBareNamePropertyExtraction(boolean bareNamePropertyExtraction) Sets whether the extractor considers bare-named property methods like `String name()`. See `Assertions#setExtractBareNamePropertyMethods(boolean)` for a detailed description. Note that this change will only be effective once `apply()` or `applyAndDisplay()` is called. Parameters bareNamePropertyExtraction:boolean whether the extractor considers bare-named property methods.

public void setBareNamePropertyExtraction(boolean bareNamePropertyExtraction)

Sets whether the extractor considers bare-named property methods like String name().

See Assertions#setExtractBareNamePropertyMethods(boolean) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

bareNamePropertyExtraction:boolean: whether the extractor considers bare-named property methods.

setComparingPrivateFields back to summary

public void setComparingPrivateFields(boolean comparingPrivateFields)

Sets whether private fields comparison is enabled.

See Assertions#setAllowComparingPrivateFields(boolean) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

comparingPrivateFields:boolean: whether private fields comparison is enabled.

setDefaults	back to summary
public void setDefaults() Set all configuration settings to their default values again.

setDescriptionConsumer	back to summary
public void setDescriptionConsumer(Consumer<Description> descriptionConsumer)

setExtractingPrivateFields back to summary

public void setExtractingPrivateFields(boolean extractingPrivateFields)

Sets whether private fields comparison is enabled.

See Assertions#setAllowExtractingPrivateFields(boolean) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

extractingPrivateFields:boolean: whether private fields comparison is enabled.

setLenientDateParsing back to summary

public void setLenientDateParsing(boolean lenientDateParsing)

Returns whether AssertJ will use lenient parsing mode for default date formats.

See Assertions#setLenientDateParsing(boolean) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

lenientDateParsing:boolean: whether AssertJ will use lenient parsing mode for default date formats.

setMaxElementsForPrinting back to summary

public void setMaxElementsForPrinting(int maxElementsForPrinting)

Sets the threshold for how many elements at most from one iterable/array/map will be displaye in error messages.

See Assertions#setMaxElementsForPrinting(int) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

maxElementsForPrinting:int: the maximum length for an iterable/array to be displayed on one line.

setMaxLengthForSingleLineDescription back to summary

public void setMaxLengthForSingleLineDescription(int maxLengthForSingleLineDescription)

Sets the maximum length for an iterable/array to be displayed on one line.

See Assertions#setMaxLengthForSingleLineDescription(int) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

maxLengthForSingleLineDescription:int: the maximum length for an iterable/array to be displayed on one line.

setMaxStackTraceElementsDisplayed back to summary

public void setMaxStackTraceElementsDisplayed(int maxStackTraceElementsDisplayed)

Returns the maximum number of lines for a stacktrace to be displayed on one throw.

See (int) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

maxStackTraceElementsDisplayed:int: the maximum number of lines for a stacktrace to be displayed on one throw.

setPreferredAssumptionException back to summary

public void setPreferredAssumptionException(PreferredAssumptionException preferredAssumptionException)

Sets which exception is thrown if an assumption is not met.

See Assumptions#setPreferredAssumptionException(PreferredAssumptionException) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

preferredAssumptionException:PreferredAssumptionException: the preferred exception to use with Assumptions.

Since

3.21.0

setPrintAssertionsDescriptionEnabled	back to summary
public void setPrintAssertionsDescriptionEnabled(boolean printAssertionsDescription)

setRemoveAssertJRelatedElementsFromStackTrace back to summary

public void setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace)

Returns whether AssertJ related elements are removed from assertion errors stack trace.

See Assertions#setRemoveAssertJRelatedElementsFromStackTrace(boolean) for a detailed description.

Note that this change will only be effective once apply() or applyAndDisplay() is called.

Parameters

removeAssertJRelatedElementsFromStackTrace:boolean: whether AssertJ related elements are removed from assertion errors stack trace.

public Class Configuration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail