org.assertj.generator.gradle.tasks.config

Interface AssertJGeneratorOptions

public interface AssertJGeneratorOptions

Defines useful parameters and options for configuration of the AssertionGenerator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SOURCE_SET_NAME_TAG

Method Summary

Modifier and Type	Method and Description
AssertJGeneratorOptions	defaultFromGlobals(org.gradle.api.Project project)
AssertJGeneratorOptions	entryPoints(groovy.lang.Closure closure) Used to change "entry point" class generation.
org.assertj.generator.gradle.tasks.config.EntryPointGeneratorOptions	getEntryPoints() Contains configuration regarding the "Assertion" entry point class generation.
java.nio.file.Path	getOutputDir(org.gradle.api.tasks.SourceSet sourceSet) The root directory where all generated files will be placed (within sub-folders for packages).
org.assertj.generator.gradle.tasks.config.Templates	getTemplates() Generate generating Soft Assertions entry point class.
java.lang.Boolean	isHierarchical() Flag specifying whether to generate hierarchical assertions.
boolean	isSkip() Skip generating classes, handy way to disable temporarily.
void	setEntryPoints(org.assertj.assertions.generator.AssertionsEntryPointType... values) Helper method for simplifying usage in build scripts
default void	setEntryPoints(java.util.Collection<java.lang.String> values) Exposed for build scripts
void	setHierarchical(boolean hierarchical) Set the hierarchical value, null is not allowed here as by setting the value, it has a value.
void	setOutputDir(java.io.File outputDir) Sets the output directory to a file
void	setOutputDir(java.lang.String outputDir) Sets the output directory to the path passed.
void	setSkip(boolean skip) Set the config param skip true
default AssertJGeneratorOptions	templates(groovy.lang.Closure closure) Method used for improving configuration DSL

Field Detail

SOURCE_SET_NAME_TAG

static final java.lang.String SOURCE_SET_NAME_TAG

See Also:

Constant Field Values

Method Detail

getTemplates

org.assertj.generator.gradle.tasks.config.Templates getTemplates()

Generate generating Soft Assertions entry point class.

Returns:

templates value, never null

templates

default AssertJGeneratorOptions templates(groovy.lang.Closure closure)

Method used for improving configuration DSL

Parameters:

closure - applied via ConfigureUtil.configure(Closure, Object)

Returns:

this

getEntryPoints

org.assertj.generator.gradle.tasks.config.EntryPointGeneratorOptions getEntryPoints()

Contains configuration regarding the "Assertion" entry point class generation. By default, only the "standard" version is generated.
See the assertj generator docs on entry points.

Returns:

entry points configuration

setEntryPoints

void setEntryPoints(org.assertj.assertions.generator.AssertionsEntryPointType... values)

Helper method for simplifying usage in build scripts

Parameters:

values - Values to set

setEntryPoints

default void setEntryPoints(java.util.Collection<java.lang.String> values)

Exposed for build scripts

Parameters:

values - String values passed from a build script

entryPoints

AssertJGeneratorOptions entryPoints(groovy.lang.Closure closure)

Used to change "entry point" class generation.

Parameters:

closure - Applied via ConfigureUtil.configure(Closure, Object)

Returns:

this

getOutputDir

java.nio.file.Path getOutputDir(org.gradle.api.tasks.SourceSet sourceSet)

The root directory where all generated files will be placed (within sub-folders for packages).

Parameters:

sourceSet - Source set configured for

Returns:

File the output directory for sourceSet

setOutputDir

void setOutputDir(java.io.File outputDir)

Sets the output directory to a file

Parameters:

outputDir - File used for an output directory

See Also:

setOutputDir(String)

setOutputDir

void setOutputDir(java.lang.String outputDir)

Sets the output directory to the path passed. When the value is converted, it will replace "${sourceSet.testName}" with SourceSet#getTaskName('test', '').

Parameters:

outputDir - File used for an output directory

isHierarchical

java.lang.Boolean isHierarchical()

Flag specifying whether to generate hierarchical assertions. The default is false.

Returns:

true if generating hierarchical

setHierarchical

void setHierarchical(boolean hierarchical)

Set the hierarchical value, null is not allowed here as by setting the value, it has a value.

Parameters:

hierarchical - true if hierarchical

See Also:

isHierarchical()

isSkip

boolean isSkip()

Skip generating classes, handy way to disable temporarily.

Returns:

true if skipping this set (default: true, set to false before configuration)

setSkip

void setSkip(boolean skip)

Set the config param skip true

Parameters:

skip - true if skipping

See Also:

isSkip()

defaultFromGlobals

AssertJGeneratorOptions defaultFromGlobals(org.gradle.api.Project project)