added deletion javadoc

Author: JohannesRabauer

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

@@ -23,4 +23,59 @@
 @NoRepositoryBean
 public interface EclipseStoreCrudRepository<T, ID> extends CrudRepository<T, ID>
 {
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * JPA would throw a {@code JdbcSQLIntegrityConstraintViolationException} but it would be very expensive to search
+	 * the referencedObject in the complete object tree and throw the exception.
+	 * <p>
+	 * That is why this library simply removes the element from the repository, but if it is still referenced by
+	 * another
+	 * object, this <b>reference is still working and pointing to the object</b>. That means that in fact this the
+	 * object to remove could very well stay in the storage if it is referenced.
+	 * </p>
+	 */
+	@Override
+	void deleteById(ID id);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link #deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void delete(T entity);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link #deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteAllById(Iterable<? extends ID> ids);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link #deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteAll(Iterable<? extends T> entities);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link #deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteAll();
 }

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

@@ -23,4 +23,53 @@
 @NoRepositoryBean
 public interface EclipseStoreListCrudRepository<T, ID> extends ListCrudRepository<T, ID>
 {
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link EclipseStoreCrudRepository#deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteById(ID id);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link EclipseStoreCrudRepository#deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void delete(T entity);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link EclipseStoreCrudRepository#deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteAllById(Iterable<? extends ID> ids);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link EclipseStoreCrudRepository#deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteAll(Iterable<? extends T> entities);
+	
+	/**
+	 * @inheritDoc <b>Caution with referenced objects!</b><br/> If you are deleting an object that is referenced by
+	 * another object, the behavior of this function may differ from what you are used to!
+	 * <p>
+	 * For more information see {@link EclipseStoreCrudRepository#deleteById(Object)}
+	 * </p>
+	 */
+	@Override
+	void deleteAll();
 }

spring-data-eclipse-store/src/test/java/software/xdev/spring/data/eclipse/store/integration/isolated/tests/deletion/DeletionTest.java

@@ -25,19 +25,23 @@
 import software.xdev.spring.data.eclipse.store.helper.TestUtil;
 import software.xdev.spring.data.eclipse.store.integration.isolated.IsolatedTestAnnotations;
 
-
-/**
- * These tests should show that all or most of the following keywords are available in this library: <a
- * href="https://docs.spring.io/spring-data/jpa/reference/repositories/query-keywords-reference.html">Repository query
- * keywords</a>
- */
 @IsolatedTestAnnotations
 @ContextConfiguration(classes = {DeletionTestConfiguration.class})
 class DeletionTest
 {
 	@Autowired
 	private DeletionTestConfiguration configuration;
 
+	/**
+	 * JPA would throw a {@code JdbcSQLIntegrityConstraintViolationException} but it would be very expensive to search
+	 * the referencedObject in the complete object tree and throw the exception.
+	 * <p>
+	 * That is why this library simply removes the element from the repository, but if it is still referenced in
+	 * another
+	 * object, this reference is still working and pointing to the object. That means that in fact this the object to
+	 * remove could very well stay in the storage if it is referenced.
+	 * </p>
+	 */
 	@Test
 	void deleteReferencedObject(
 		@Autowired final ReferencedRepository referencedRepository,
@@ -71,9 +75,10 @@ void restoreDeletedReferencedObject(
 	{
 		final ReferencedDaoObject referencedObject = new ReferencedDaoObject("someValue");
 		final ReferencingDaoObject referencingDaoObject = new ReferencingDaoObject(referencedObject);
-		
 		referencingRepository.save(referencingDaoObject);
+		
 		referencedRepository.delete(referencedObject);
+		
 		referencingRepository.save(referencingDaoObject);
 
 		TestUtil.doBeforeAndAfterRestartOfDatastore(