Package org.hibernate.boot.archive.scan.spi

Interface Scanner

All Known Implementing Classes:
DisabledScanner
public interface Scanner
Defines the contract for Hibernate to be able to scan for classes, packages and resources inside a persistence unit.

Constructors are expected in one of 2 forms:

If a ArchiveDescriptorFactory is specified in the configuration, but the Scanner to be used does not accept a ArchiveDescriptorFactory an exception will be thrown.

  • Method Summary

    Modifier and Type
    Method
    Description
    ScanResult
    scan(ScanEnvironment environment, ScanOptions options, ScanParameters params)
    Perform the scanning against the described environment using the defined options, and return the scan results.
    default void
    setArchiveDescriptorFactory(ArchiveDescriptorFactory archiveDescriptorFactory)
    Deprecated, for removal: This API element is subject to removal in a future version.
    (since 7.0) Not used; no replacement.

  • Method Details

    • scan

      ScanResult scan(ScanEnvironment environment, ScanOptions options, ScanParameters params)
      Perform the scanning against the described environment using the defined options, and return the scan results.
      Parameters:
      environment - The scan environment.
      options - The options to control the scanning.
      params - The parameters for scanning

    • setArchiveDescriptorFactory

      @Deprecated(since="7.0", forRemoval=true) default void setArchiveDescriptorFactory(ArchiveDescriptorFactory archiveDescriptorFactory)
      Deprecated, for removal: This API element is subject to removal in a future version.
      (since 7.0) Not used; no replacement.