Top Description Methods
org.hibernate.boot.archive.scan.spi

public Interface ScanEnvironment

Known Direct Implementers
org.hibernate.jpa.boot.internal.StandardJpaScanEnvironmentImpl
Imports
java.net.URL, java.util.List

Describes the environment in which the scan will occur.

Note that much of this comes from the PU in JPA sense. This is intended as an abstraction over the PU in JPA cases, as well as a delegate allowing usage in non-JPA cases. With the planned move to unify the cfg.xml and persistence.xml schemas (like we are doing with hbm.xml and orm.xml) this becomes less needed (at least parts of it).

After unification, I think the biggest difference is that we will not need to pass ScanEnvironment into the MetadataSources/MetadataBuilder while for the time being we will need to.

Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public List<String>

Returns:

The explicitly listed classes
getExplicitlyListedClassNames
()

Returns any classes which are explicitly listed as part of the "persistence unit".

public List<String>

Returns:

The explicitly listed mapping files.
getExplicitlyListedMappingFiles
()

Returns the mapping files which are explicitly listed as part of the "persistence unit".

public List<URL>

Returns:

The non-root URLs
getNonRootUrls
()

Returns any non-root URLs for scanning.

public URL

Returns:

The root URL
getRootUrl
()

Returns the root URL for scanning.

Method Detail

getExplicitlyListedClassNamesback to summary
public List<String> getExplicitlyListedClassNames()

Returns any classes which are explicitly listed as part of the "persistence unit".

Returns:List<String>

The explicitly listed classes

getExplicitlyListedMappingFilesback to summary
public List<String> getExplicitlyListedMappingFiles()

Returns the mapping files which are explicitly listed as part of the "persistence unit".

Returns:List<String>

The explicitly listed mapping files.

getNonRootUrlsback to summary
public List<URL> getNonRootUrls()

Returns any non-root URLs for scanning. Can be null/empty to indicate that no non-root URL scanning should be done.

Returns:List<URL>

The non-root URLs

See Also
ScanOptions#canDetectUnlistedClassesInNonRoot()
getRootUrlback to summary
public URL getRootUrl()

Returns the root URL for scanning. Can be null, indicating that no root URL scanning should be done (aka, if maybe a root URL is not known).

Returns:URL

The root URL

See Also
ScanOptions#canDetectUnlistedClassesInRoot()