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

Class JsonSchemaExtension.TypeScanningSpec

  • Enclosing class:
    JsonSchemaExtension
    public abstract static class JsonSchemaExtension.TypeScanningSpec
extends java.lang.Object
    Gradle extension for configuring which packages and modules are included when scanning for subtypes.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract org.gradle.api.provider.ListProperty<java.lang.String> getModuleWhiteList()
      An optional list of module names used to limit type scanning to only the specified modules.
      abstract org.gradle.api.provider.ListProperty<java.lang.String> getPackageWhiteListed()
      An optional list of package name used to limit type scanning to only the specified packages.
      void moduleWhiteList​(java.lang.String... moduleNames)
      Set modules to scan.
      void packageWhiteList​(java.lang.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 Detail

      • TypeScanningSpec

        public TypeScanningSpec()

    • Method Detail

      • getModuleWhiteList

        public abstract org.gradle.api.provider.ListProperty<java.lang.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.

        Returns:
        the module whitelist property

      • moduleWhiteList

        public void moduleWhiteList​(java.lang.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<java.lang.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​(java.lang.String... packageNames)
        Set packages to scan.

        See getPackageWhiteListed() for more info.

        Parameters:
        packageNames - the package names to allow.