Minor documentation and variable naming changes

umbreak · umbreak · commit e953c7cd7e1c · 2020-09-15T14:00:37.000+02:00
diff --git a/core/src/main/java/com/github/jsonldjava/core/JsonLdProcessor.java b/core/src/main/java/com/github/jsonldjava/core/JsonLdProcessor.java
@@ -342,6 +342,12 @@ public static Map<String, Object> frame(Object input, Object frame, JsonLdOption
         return rval;
     }
 
+    /**
+     * Builds the context to be returned in framing and compaction algorithms.
+     * In cases where the context is empty or from an unexpected type, it returns null.
+     * When JsonLdOptions compactArrays is set to true and the context contains a List with a single element,
+     * the element is returned instead of the list
+     */
     private static Object returnedContext(Object context, JsonLdOptions opts) {
         if (context != null &&
                 ((context instanceof Map && !((Map<String, Object>) context).isEmpty())
diff --git a/core/src/test/java/com/github/jsonldjava/core/ContextFramingTest.java b/core/src/test/java/com/github/jsonldjava/core/ContextFramingTest.java
@@ -17,14 +17,14 @@ public class ContextFramingTest {
     @Test
     public void testFraming() throws Exception {
 
-        final Map<String, Object> contextAbbrevs = new HashMap<String, Object>();
+        final Map<String, Object> contextAbbrevs = new HashMap<>();
         contextAbbrevs.put("so", "http://schema.org/");
 
-        final Map<String, Object> json = new HashMap<String, Object>();
+        final Map<String, Object> json = new HashMap<>();
         json.put("@context", contextAbbrevs);
         json.put("@id", "http://example.org/my_work");
 
-        final List<Object> types = new LinkedList<Object>();
+        final List<Object> types = new LinkedList<>();
         types.add("so:CreativeWork");
 
         json.put("@type", types);
@@ -36,20 +36,20 @@ public void testFraming() throws Exception {
         options.setCompactArrays(true);
         options.setOmitGraph(true);
 
-        // System.out.println("Before compact");
+        // System.out.println("Before framing");
         // System.out.println(JsonUtils.toPrettyString(json));
 
         final String frameStr = "{\"@id\": \"http://schema.org/myid\", \"@context\": \"http://schema.org/\"}";
         final Object frame = JsonUtils.fromString(frameStr);
 
-        final Map<String, Object> compacted = JsonLdProcessor.frame(json, frame, options);
+        final Map<String, Object> framed = JsonLdProcessor.frame(json, frame, options);
 
-        // System.out.println("\n\nAfter compact:");
-        // System.out.println(JsonUtils.toPrettyString(compacted));
+        // System.out.println("\n\nAfter framing:");
+        // System.out.println(JsonUtils.toPrettyString(framed));
 
-        assertTrue("Framing removed the context", compacted.containsKey("@context"));
+        assertTrue("Framing removed the context", framed.containsKey("@context"));
         assertFalse("Framing of context should be a string, not a list",
-                compacted.get("@context") instanceof List);
+                framed.get("@context") instanceof List);
     }
 
     @Test
@@ -63,15 +63,15 @@ public void testFramingRemoteContext() throws Exception {
         final JsonLdOptions options = new JsonLdOptions();
         options.setOmitGraph(true);
 
-        final Map<String, Object> compacted = JsonLdProcessor.frame(json, frame, options);
+        final Map<String, Object> framed = JsonLdProcessor.frame(json, frame, options);
 
-        // System.out.println("\n\nAfter compact:");
-        // System.out.println(JsonUtils.toPrettyString(compacted));
+        // System.out.println("\n\nAfter framing:");
+        // System.out.println(JsonUtils.toPrettyString(framed));
 
-        assertEquals("Wrong framing context", "http://schema.org/", compacted.get("@context"));
-        assertEquals("Wrong framing id", "schema:myid", compacted.get("id"));
-        assertEquals("Wrong framing type", "Person", compacted.get("type"));
-        assertEquals("Wrong number of Json entries",3, compacted.size());
+        assertEquals("Wrong framing context", "http://schema.org/", framed.get("@context"));
+        assertEquals("Wrong framing id", "schema:myid", framed.get("id"));
+        assertEquals("Wrong framing type", "Person", framed.get("type"));
+        assertEquals("Wrong number of Json entries",3, framed.size());
     }
 
 }
