Added Javadoc

Author: JohannesRabauer

spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/dual/storage/invoice/PersistenceInvoiceConfiguration.java

@@ -20,7 +20,7 @@
 public class PersistenceInvoiceConfiguration extends EclipseStoreClientConfiguration
 {
 	@Override
-	public EmbeddedStorageFoundation<?> getEmbeddedStorageFoundation()
+	public EmbeddedStorageFoundation<?> createEmbeddedStorageFoundation()
 	{
 		return Foundation(Storage.Configuration(Storage.FileProvider(Path.of("storage-invoice"))));
 	}

spring-data-eclipse-store-demo/src/main/java/software/xdev/spring/data/eclipse/store/demo/dual/storage/person/PersistencePersonConfiguration.java

@@ -20,7 +20,7 @@
 public class PersistencePersonConfiguration extends EclipseStoreClientConfiguration
 {
 	@Override
-	public EmbeddedStorageFoundation<?> getEmbeddedStorageFoundation()
+	public EmbeddedStorageFoundation<?> createEmbeddedStorageFoundation()
 	{
 		return Foundation(Storage.Configuration(Storage.FileProvider(Path.of("storage-person"))));
 	}

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/EclipseStoreStorage.java

@@ -78,7 +78,7 @@ private synchronized void ensureEntitiesInRoot()
 			LOG.info("Starting storage...");
 			this.root = new Root();
 			final EmbeddedStorageFoundation<?> embeddedStorageFoundation =
-				this.foundationProvider.getEmbeddedStorageFoundation();
+				this.foundationProvider.createEmbeddedStorageFoundation();
 			embeddedStorageFoundation.registerTypeHandler(BinaryHandlerImmutableCollectionsSet12.New());
 			embeddedStorageFoundation.registerTypeHandler(BinaryHandlerImmutableCollectionsList12.New());
 			this.storageManager = embeddedStorageFoundation.start(this.root);

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/config/DefaultEclipseStoreClientConfiguration.java

@@ -18,6 +18,11 @@
 import org.springframework.context.annotation.Configuration;
 
 
+/**
+ * Provides the Default implementation of an {@link EclipseStoreClientConfiguration}. The class can't be final because
+ * of the {@link Configuration}-Annotation. It's mostly used to check if the user wants the default implementation or if
+ * he created a different {@link EclipseStoreClientConfiguration}.
+ */
 @Configuration(proxyBeanMethods = false)
 public class DefaultEclipseStoreClientConfiguration extends EclipseStoreClientConfiguration
 {

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/config/EclipseStoreClientConfiguration.java

@@ -20,15 +20,31 @@
 import org.eclipse.store.integrations.spring.boot.types.configuration.EclipseStoreProperties;
 import org.eclipse.store.storage.embedded.types.EmbeddedStorageFoundation;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.context.annotation.Configuration;
 
 import software.xdev.spring.data.eclipse.store.repository.EclipseStoreStorage;
 
 
+/**
+ * Defines the configuration of a single EclipseStore-Storage.
+ * <p>
+ * Configuration is possible through default EclipseStore-Behavior.<br/> See <a
+ * href="https://docs.eclipsestore.io/manual/misc/integrations/spring-boot.html">EclipseStore documentation</a>
+ * </p>
+ * <p>
+ * It's also possible to inherit this configuration and override {@link #createEmbeddedStorageFoundation()}
+ * </p>
+ * <p>
+ * Also creates a singleton reference to a {@link EclipseStoreStorage}. This is to only create one EclipseStore-Storage
+ * for one configuration.
+ * </p>
+ */
 @Configuration(proxyBeanMethods = false)
 public abstract class EclipseStoreClientConfiguration implements EclipseStoreStorageFoundationProvider
 {
 	@Autowired
+	@Qualifier("eclipseStoreProperties")
 	private EclipseStoreProperties defaultEclipseStoreProperties;
 
 	@Autowired
@@ -46,8 +62,12 @@ public EclipseStoreProvider getStoreProvider()
 		return this.defaultEclipseStoreProvider;
 	}
 
+	/**
+	 * Creates a {@link EmbeddedStorageFoundation} out of the two other provided functions {@link #getStoreProvider()}
+	 * and {@link #getStoreConfiguration()}.
+	 */
 	@Override
-	public EmbeddedStorageFoundation<?> getEmbeddedStorageFoundation()
+	public EmbeddedStorageFoundation<?> createEmbeddedStorageFoundation()
 	{
 		return this.getStoreProvider().createStorageFoundation(this.getStoreConfiguration());
 	}

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/config/EclipseStoreRepositoryConfigurationExtension.java

@@ -70,6 +70,12 @@ public String getRepositoryFactoryBeanClassName()
 		return EclipseStoreRepositoryFactoryBean.class.getName();
 	}
 
+	/**
+	 * This method puts the {@link EclipseStoreRepositoryFactoryBean#configuration} in the created
+	 * {@link EclipseStoreRepositoryFactoryBean}. This is important to link
+	 * {@link EnableEclipseStoreRepositories#clientConfiguration()} with the actual
+	 * {@link software.xdev.spring.data.eclipse.store.repository.EclipseStoreStorage}.
+	 */
 	@Override
 	public void postProcess(final BeanDefinitionBuilder builder, final AnnotationRepositoryConfigurationSource config)
 	{

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/config/EclipseStoreStorageFoundationProvider.java

@@ -18,7 +18,11 @@
 import org.eclipse.store.storage.embedded.types.EmbeddedStorageFoundation;
 
 
+/**
+ * Wraps access to a {@link EmbeddedStorageFoundation} into a single interface to have looser coupling towards
+ * EclipseStore.
+ */
 public interface EclipseStoreStorageFoundationProvider
 {
-	EmbeddedStorageFoundation<?> getEmbeddedStorageFoundation();
+	EmbeddedStorageFoundation<?> createEmbeddedStorageFoundation();
 }

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/config/EnableEclipseStoreRepositories.java

@@ -83,10 +83,18 @@
 
 	String CLIENT_CONFIGURATION_ANNOTATION_VALUE = "clientConfiguration";
 
+	/**
+	 * @return the name of a {@link EclipseStoreClientConfiguration} to use.
+	 * {@link DefaultEclipseStoreClientConfiguration} is used if not defined.
+	 */
 	String clientConfiguration() default "defaultEclipseStoreClientConfiguration";
 
 	String CLIENT_CONFIGURATION_CLASS_ANNOTATION_VALUE = "clientConfigurationClass";
 
+	/**
+	 * @return the class of a {@link EclipseStoreClientConfiguration} to use.
+	 * {@link DefaultEclipseStoreClientConfiguration} is used if not defined.
+	 */
 	Class<? extends EclipseStoreClientConfiguration> clientConfigurationClass() default DefaultEclipseStoreClientConfiguration.class;
 
 	/**