Add comments and move DeltaBasedResource and corresponding factory

vitruv-tools · Aug 8, 2023 · 93eba6e · 93eba6e
1 parent 6f33866
commit 93eba6e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/...changederivation/DeltaBasedResource.xtend → ...tion/persistence/DeltaBasedResource.xtend b/...changederivation/DeltaBasedResource.xtend → ...tion/persistence/DeltaBasedResource.xtend
@@ -16,6 +16,12 @@ import tools.vitruv.change.composite.description.VitruviusChangeResolver
 
 import static edu.kit.ipd.sdq.commons.util.org.eclipse.emf.ecore.resource.ResourceSetUtil.withGlobalFactories
 
+/**
+ * This class provides functionality to save and load a resource in a model delta representation.
+ * It uses the {@link DefaultStateBasedChangeResolutionStrategy} to save a state-based resource as a sequence of
+ * {@link EChange}s. The saved delta sequence can be loaded again, and the resulting changes can be
+ * applied to create the state-based resource again.
+**/
 class DeltaBasedResource extends ResourceImpl {
 
 	new(URI uri) {

diff --git a/...erivation/DeltaBasedResourceFactory.xtend → ...rsistence/DeltaBasedResourceFactory.xtend b/...erivation/DeltaBasedResourceFactory.xtend → ...rsistence/DeltaBasedResourceFactory.xtend
@@ -3,6 +3,9 @@ package tools.vitruv.change.changederivation
 import org.eclipse.emf.common.util.URI
 import org.eclipse.emf.ecore.resource.Resource
 
+/**
+ * Factory to provide {@link DeltaBasedResource}s.
+ */
 class DeltaBasedResourceFactory implements Resource.Factory {
 	override Resource createResource(URI uri) {
 		return new DeltaBasedResource(uri)