Package org.creekservice.api.json.schema.gradle.plugin

Class JsonSchemaExtension.TypeScanningSpec

java.lang.Object

org.creekservice.api.json.schema.gradle.plugin.JsonSchemaExtension.TypeScanningSpec

Enclosing class:

JsonSchemaExtension

public abstract static class JsonSchemaExtension.TypeScanningSpec
extends Object

Gradle extension for configuring which packages and modules are included when scanning for subtypes.

Constructor Summary

Constructors

Constructor	Description
TypeScanningSpec()

Method Summary

Modifier and Type	Method	Description
abstract org.gradle.api.provider.ListProperty<String>	getModuleWhiteList()	An optional list of module names used to limit type scanning to only the specified modules.
abstract org.gradle.api.provider.ListProperty<String>	getPackageWhiteListed()	An optional list of package name used to limit type scanning to only the specified packages.
void	moduleWhiteList(String... moduleNames)	Set modules to scan.
void	packageWhiteList(String... packageNames)	Set packages to scan.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TypeScanningSpec

public TypeScanningSpec()

Method Details

getModuleWhiteList

public abstract org.gradle.api.provider.ListProperty<String> getModuleWhiteList()

An optional list of module names used to limit type scanning to only the specified modules.

Allowed module names can include the glob wildcard * character.

Default: empty, meaning all modules will be scanned.

NOTE: Setting a non-empty module whitelist also causes the schema generator to be executed from the module-path, rather than the default class-path, i.e. the generator will run under the JPMS. This can run into issues with split packages, i.e. the same package exposed from multiple jars.

Returns:

the module whitelist property

moduleWhiteList

public void moduleWhiteList(String... moduleNames)

Set modules to scan.

See getModuleWhiteList() for more info.

Parameters:

moduleNames - the module names to allow.

getPackageWhiteListed

public abstract org.gradle.api.provider.ListProperty<String> getPackageWhiteListed()

An optional list of package name used to limit type scanning to only the specified packages.

Allowed package names can include the glob wildcard * character.

Default: empty, meaning all packages will be scanned.

Returns:

the property whitelist property

packageWhiteList

public void packageWhiteList(String... packageNames)

Set packages to scan.

See getPackageWhiteListed() for more info.

Parameters:

packageNames - the package names to allow.