org.assertj.assertions.generator

Interface AssertionsEntryPointGenerator

All Known Implementing Classes:

BaseAssertionGenerator

public interface AssertionsEntryPointGenerator

Method Summary

Modifier and Type	Method and Description
String	generateAssertionsEntryPointClassContentFor(Set<ClassDescription> classDescriptionSet, AssertionsEntryPointType assertionsEntryPointType, String entryPointClassPackage) Returns the assertions entry point class content for the given ClassDescription set.
File	generateAssertionsEntryPointClassFor(Set<ClassDescription> classDescriptionSet, AssertionsEntryPointType assertionsEntryPointType, String entryPointClassPackage) Same as generateAssertionsEntryPointClassContentFor(Set, AssertionsEntryPointType, String) but in addition create the corresponding java class file.

Method Detail

generateAssertionsEntryPointClassContentFor

String generateAssertionsEntryPointClassContentFor(Set<ClassDescription> classDescriptionSet,
                                                   AssertionsEntryPointType assertionsEntryPointType,
                                                   String entryPointClassPackage)

Returns the assertions entry point class content for the given ClassDescription set.

The idea is to generate an equivalent of assertj-core Assertions class to give easy access to all generated assertions. With AssertionsEntryPointType parameter one can generate standard, BDD or Soft assertions entry point class (default is AssertionsEntryPointType.STANDARD).

You can define the package of the generated entry point class, if null the common base package of the given classes, will be used, i.e if some classe are in a.b.c and others in a.b.c.d, then entry point class will be in a.b.c.

Parameters:

classDescriptionSet - the set of ClassDescription we want to generate an entry point for.

assertionsEntryPointType - the valueType of entry point class to generate

entryPointClassPackage - the package of the generated entry point class

Returns:

the assertions entry point class content

generateAssertionsEntryPointClassFor

File generateAssertionsEntryPointClassFor(Set<ClassDescription> classDescriptionSet,
                                          AssertionsEntryPointType assertionsEntryPointType,
                                          String entryPointClassPackage)
                                   throws IOException

Same as generateAssertionsEntryPointClassContentFor(Set, AssertionsEntryPointType, String) but in addition create the corresponding java class file.

Throws:

IOException - if entry point file can't be created.