refactor: rename metadata context accessors to use "read" prefix to indicate (documented) immutability

Author: Pfeil

src/main/java/edu/kit/datamanager/ro_crate/Crate.java

@@ -57,19 +57,19 @@ public interface Crate {
    * @param key the key to be searched
    * @return the value of the key, null if not found
    */
-  String getMetadataContextValueOf(String key);
+  String readMetadataContextValueOf(String key);
 
   /**
    * Get an immutable collection of the keys in the metadata context.
    * @return the keys in the metadata context
    */
-  Set<String> getMetadataContextKeys();
+  Set<String> readMetadataContextKeys();
 
   /**
    * Get an immutable map of the context.
    * @return an immutable map containing the context key-value pairs
    */
-  Map<String, String> getMetadataContextPairs();
+  Map<String, String> readMetadataContextPairs();
 
   RootDataEntity getRootDataEntity();
 

src/main/java/edu/kit/datamanager/ro_crate/RoCrate.java

@@ -62,18 +62,18 @@ public void setMetadataContext(CrateMetadataContext metadataContext) {
         this.metadataContext = metadataContext;
     }
 
-    public String getMetadataContextValueOf(String key) {
-        return this.metadataContext.getValueOf(key);
+    public String readMetadataContextValueOf(String key) {
+        return this.metadataContext.readValueOf(key);
     }
 
     @Override
-    public Set<String> getMetadataContextKeys() {
-        return this.metadataContext.getImmutableKeys();
+    public Set<String> readMetadataContextKeys() {
+        return this.metadataContext.readKeys();
     }
 
     @Override
-    public Map<String, String> getMetadataContextPairs() {
-        return this.metadataContext.getImmutablePairs();
+    public Map<String, String> readMetadataContextPairs() {
+        return this.metadataContext.readPairs();
     }
 
     public ContextualEntity getJsonDescriptor() {

src/main/java/edu/kit/datamanager/ro_crate/context/CrateMetadataContext.java

@@ -30,19 +30,19 @@ public interface CrateMetadataContext {
    * @param key the key to be searched
    * @return the value of the key, null if not found
    */
-  String getValueOf(String key);
+  String readValueOf(String key);
 
   /**
    * Get an immutable collection of the keys in the metadata context.
    * @return the keys in the metadata context
    */
-  Set<String> getImmutableKeys();
+  Set<String> readKeys();
 
   /**
   * Get an immutable map of the context.
   * @return an immutable map containing the context key-value pairs
   */
-  Map<String, String> getImmutablePairs();
+  Map<String, String> readPairs();
 
   void deleteValuePairFromContext(String key);
 

src/main/java/edu/kit/datamanager/ro_crate/context/RoCrateMetadataContext.java

@@ -201,21 +201,21 @@ public void addToContext(String key, String value) {
   }
 
   @Override
-  public String getValueOf(String key) {
+  public String readValueOf(String key) {
     return Optional.ofNullable(this.contextMap.get(key))
             .orElseGet(() -> this.other.get(key));
   }
 
   @Override
-  public Set<String> getImmutableKeys() {
+  public Set<String> readKeys() {
     List<String> merged = new ArrayList<>();
     merged.addAll(this.contextMap.keySet());
     merged.addAll(this.other.keySet());
     return Set.copyOf(merged);
   }
 
   @Override
-  public Map<String, String> getImmutablePairs() {
+  public Map<String, String> readPairs() {
     Map<String, String> merged = new HashMap<>();
     merged.putAll(this.contextMap);
     merged.putAll(this.other);

src/test/java/edu/kit/datamanager/ro_crate/context/ContextTest.java

@@ -233,28 +233,28 @@ void testSetDeleteGetPair() {
     String key = "key";
     String value = "value";
     context.addToContext(key, value);
-    assertEquals(value, context.getValueOf(key));
+    assertEquals(value, context.readValueOf(key));
     context.deleteValuePairFromContext(key);
-    assertNull(context.getValueOf(key));
+    assertNull(context.readValueOf(key));
   }
 
   @Test
   void testReadDeleteGetPair() throws IOException {
     setupComplexContext();
     String key = "custom";
     String value = "_:";
-    assertEquals(value, context.getValueOf(key));
+    assertEquals(value, context.readValueOf(key));
     context.deleteValuePairFromContext(key);
-    assertNull(context.getValueOf(key));
+    assertNull(context.readValueOf(key));
     context.addToContext(key, value);
-    assertEquals(value, context.getValueOf(key));
+    assertEquals(value, context.readValueOf(key));
   }
 
   @Test
   void testReadKeys() throws IOException {
     setupComplexContext();
     var expected = Set.of("custom", "owl", "datacite", "xsd", "rdfs");
-    var given = context.getImmutableKeys();
+    var given = context.readKeys();
     for (String key : expected) {
       assertTrue(given.contains(key), "Key " + key + " not found in the context");
     }
@@ -264,7 +264,7 @@ void testReadKeys() throws IOException {
   void testReadPairs() throws IOException {
     setupComplexContext();
     var expected = Set.of("custom", "owl", "datacite", "xsd", "rdfs");
-    var given = context.getImmutablePairs();
+    var given = context.readPairs();
     var keys = given.keySet();
     var values = given.values();
     for (String key : expected) {

src/test/java/edu/kit/datamanager/ro_crate/crate/TestRemoveAddContext.java

@@ -43,9 +43,9 @@ void testReadDeleteGetContextPair() {
     RoCrate crate = new RoCrateReader(new FolderReader()).readCrate(crateManifestPath);
     String key = "custom";
     String value = "_:";
-    assertEquals(value, crate.getMetadataContextValueOf(key));
+    assertEquals(value, crate.readMetadataContextValueOf(key));
     crate.deleteValuePairFromContext(key);
-    assertNull(crate.getMetadataContextValueOf(key));
+    assertNull(crate.readMetadataContextValueOf(key));
   }
 
   @Test
@@ -54,7 +54,7 @@ void testReadContextKeys() {
     crateManifestPath = TestRemoveAddContext.class.getResource(crateManifestPath).getPath();
     RoCrate crate = new RoCrateReader(new FolderReader()).readCrate(crateManifestPath);
     var expected = Set.of("custom", "owl", "datacite", "xsd", "rdfs");
-    var given = crate.getMetadataContextKeys();
+    var given = crate.readMetadataContextKeys();
     for (String key : expected) {
         assertTrue(given.contains(key), "Key " + key + " not found in the context");
     }
@@ -66,7 +66,7 @@ void testReadContextPairs() {
     crateManifestPath = TestRemoveAddContext.class.getResource(crateManifestPath).getPath();
     RoCrate crate = new RoCrateReader(new FolderReader()).readCrate(crateManifestPath);
     var expected = Set.of("custom", "owl", "datacite", "xsd", "rdfs");
-    var given = crate.getMetadataContextPairs();
+    var given = crate.readMetadataContextPairs();
     var keys = given.keySet();
     var values = given.values();
     for (String key : expected) {