diff --git a/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistration.java b/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistration.java index d60eddb4d2..166e0f3e64 100644 --- a/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistration.java +++ b/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistration.java @@ -7,8 +7,9 @@ package org.hibernate.boot.registry.selector; /** - * Describes the registration of a named strategy implementation. A strategy + selector name should resolve - * to a single implementation. + * Describes the registration of a named strategy implementation. + *

+ * A strategy + selector name should resolve to a single implementation. * * @param The type of the strategy described by this implementation registration. * @@ -16,7 +17,7 @@ package org.hibernate.boot.registry.selector; */ public interface StrategyRegistration { /** - * The strategy role. Best practice says this should be an interface. + * The strategy role. Best practice says this should be an interface. * * @return The strategy contract/role. */ diff --git a/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistrationProvider.java b/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistrationProvider.java index c6d985b9b0..8d8e2fd611 100644 --- a/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistrationProvider.java +++ b/hibernate-core/src/main/java/org/hibernate/boot/registry/selector/StrategyRegistrationProvider.java @@ -7,16 +7,18 @@ package org.hibernate.boot.registry.selector; /** - * Responsible for providing the registrations of strategy selector(s). Can be registered directly with the - * {@link org.hibernate.boot.registry.BootstrapServiceRegistry} or located via discovery. + * Responsible for providing the registrations of one or more strategy selectors. + *

+ * Can be registered directly with the {@link org.hibernate.boot.registry.BootstrapServiceRegistry} + * or located via discovery. * * @author Steve Ebersole */ public interface StrategyRegistrationProvider { /** - * Get all StrategyRegistrations announced by this provider. + * Get all {@link StrategyRegistration}s announced by this provider. * - * @return All StrategyRegistrations + * @return All {@link StrategyRegistration}s */ Iterable getStrategyRegistrations(); } diff --git a/hibernate-core/src/main/java/org/hibernate/cache/spi/support/DomainDataStorageAccess.java b/hibernate-core/src/main/java/org/hibernate/cache/spi/support/DomainDataStorageAccess.java index c740394a0d..06674aaf56 100644 --- a/hibernate-core/src/main/java/org/hibernate/cache/spi/support/DomainDataStorageAccess.java +++ b/hibernate-core/src/main/java/org/hibernate/cache/spi/support/DomainDataStorageAccess.java @@ -9,7 +9,7 @@ package org.hibernate.cache.spi.support; import org.hibernate.engine.spi.SharedSessionContractImplementor; /** - * Specialization of {@link StorageAccess} for domain data regions + * Specialization of {@link StorageAccess} for domain data regions. * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/cache/spi/support/StorageAccess.java b/hibernate-core/src/main/java/org/hibernate/cache/spi/support/StorageAccess.java index f5c5ba1dfd..36c97cacbc 100644 --- a/hibernate-core/src/main/java/org/hibernate/cache/spi/support/StorageAccess.java +++ b/hibernate-core/src/main/java/org/hibernate/cache/spi/support/StorageAccess.java @@ -9,11 +9,11 @@ package org.hibernate.cache.spi.support; import org.hibernate.engine.spi.SharedSessionContractImplementor; /** - * A general read/write abstraction over the specific "cache" - * object from the caching provider. + * A general read/write abstraction over the specific "cache" object from the caching provider. * * @apiNote Similar to {@link org.hibernate.cache.spi.access.CachedDomainDataAccess}, - * some methods represent "transactional" (access to Session) and some are non-"transactional" + * some methods handle "transactional" access (access in the scope of a session), + * and some are non-"transactional" (for cache management outside a session). * * @author Steve Ebersole */ diff --git a/hibernate-core/src/main/java/org/hibernate/cache/spi/support/package-info.java b/hibernate-core/src/main/java/org/hibernate/cache/spi/support/package-info.java index 1828d6429a..c17c1330a9 100644 --- a/hibernate-core/src/main/java/org/hibernate/cache/spi/support/package-info.java +++ b/hibernate-core/src/main/java/org/hibernate/cache/spi/support/package-info.java @@ -6,31 +6,25 @@ */ /** - * Package intended for simplifying the worked needed to implement a caching provider. - * Centers around the concept of {@link org.hibernate.cache.spi.support.StorageAccess} - * and {@link org.hibernate.cache.spi.support.DomainDataStorageAccess} to implement - * most of the "grunt work" associated with the implementation. + * This package provides a framework intended to reduce the work needed to implement + * a caching provider. It takes care of most of the "grunt work" associated with the + * implementation, leaving the integrator to implement the interfaces + * {@link org.hibernate.cache.spi.support.StorageAccess} and + * {@link org.hibernate.cache.spi.support.DomainDataStorageAccess}. *

- * A typical integration would just implement: + * A typical integration would provide: *

    - *
  1. a custom {@code StorageAccess}/{@code DomainDataStorageAccess}, along with - *
  2. a custom {@link org.hibernate.cache.spi.support.RegionFactoryTemplate}, in - * particular: - * + *
  3. a custom {@code StorageAccess} or {@code DomainDataStorageAccess}, along with + *
  4. a custom {@link org.hibernate.cache.spi.support.RegionFactoryTemplate}. *
*

- * Voila! Functioning cache provider. - *

- * The preferred approach to "provide an integration" is through a custom + * The preferred way to register these implementations to Hibernate is via a custom * {@link org.hibernate.boot.registry.selector.StrategyRegistrationProvider}. *

- * Both {@code hibernate-testing} ({@code org.hibernate.testing.cache.CachingRegionFactory}) - * and {@code hibernate-jcache} ({@code org.hibernate.cache.jcache.internal.JCacheRegionFactory}) - * provide examples of using this support package to implement a caching - * provider. + * Examples of using this support package to implement a caching provider include: + *

*/ package org.hibernate.cache.spi.support;