fix: correct namespace usage in doc example

jonas-grgt · Mar 9, 2024 · 86f642a · 86f642a
1 parent c93f1c4
commit 86f642a
Show file tree

Hide file tree

Showing 18 changed files with 105 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -61,22 +61,22 @@ public class Location {
 ```java
 String document = """
     <?xml version="1.0" encoding="UTF-8"?>
-    <w:WeatherData xmlns:xjx="https://github.com/jonas-grgt/xjx">
-      <w:Location>
-          <w:Country City="New York">USA</w:Country>
-      </w:Location>
-      <w:CurrentConditions>
-        <w:Temperature>
-          <w:Value>75</Value>
-            <w:Unit><![CDATA[°F]]></w:Unit>
-        </w:Temperature>
-        <w:Humidity>
-          <w:Value>60</w:Value>
-          <w:Unit>%</w:Unit>
-        </w:Humidity>
-        <w:WeatherCondition>Sunny</w:WeatherCondition>
-      </w:CurrentConditions>
-    </w:WeatherData>""";
+    <xjx:WeatherData xmlns:xjx="https://github.com/jonas-grgt/xjx">
+      <xjx:Location>
+          <xjx:Country City="New York">USA</xjx:Country>
+      </xjx:Location>
+      <xjx:CurrentConditions>
+        <xjx:Temperature>
+          <xjx:Value>75</Value>
+            <xjx:Unit><![CDATA[°F]]></xjx:Unit>
+        </xjx:Temperature>
+        <xjx:Humidity>
+          <xjx:Value>60</xjx:Value>
+          <xjx:Unit>%</xjx:Unit>
+        </xjx:Humidity>
+        <xjx:WeatherCondition>Sunny</xjx:WeatherCondition>
+      </xjx:CurrentConditions>
+    </xjx:WeatherData>""";
 
 
 var xjx = new XjxSerdes();

diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/Attributes.java b/xjx-sax/src/main/java/io/jonasg/xjx/Attributes.java
@@ -1,6 +1,5 @@
 package io.jonasg.xjx;
 
-import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.StringJoiner;

diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/Token.java b/xjx-sax/src/main/java/io/jonasg/xjx/Token.java
@@ -1,5 +1,11 @@
 package io.jonasg.xjx;
 
+/**
+ * Represents a single token in an XML document.
+ * @param type the type of the token
+ * @param value the value of the token or null if not relevant for that token type
+ * @param <T> the type of the value
+ */
 public record Token<T>(Type type, T value) {
 
     public Token(Type type) {

diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/Tokenizer.java b/xjx-sax/src/main/java/io/jonasg/xjx/Tokenizer.java
@@ -1,14 +1,17 @@
 package io.jonasg.xjx;
 
-import io.jonasg.xjx.scanners.Scanner;
-import io.jonasg.xjx.scanners.WhiteSpaceScanner;
-
 import java.io.Reader;
 import java.util.Spliterator;
 import java.util.function.Consumer;
 import java.util.stream.Stream;
 import java.util.stream.StreamSupport;
 
+import io.jonasg.xjx.scanners.Scanner;
+import io.jonasg.xjx.scanners.WhiteSpaceScanner;
+
+/**
+ * Tokenize an XML document into a stream of {@link Token}.
+ */
 public class Tokenizer {
 
     public Stream<Token<?>> tokenize(Reader reader) {

diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/sax/SaxHandler.java b/xjx-sax/src/main/java/io/jonasg/xjx/sax/SaxHandler.java
@@ -2,13 +2,34 @@
 
 import java.util.List;
 
+/**
+ * A handler for SAX parsing.
+ */
 public interface SaxHandler {
 
+	/**
+	 * Called when the document starts.
+	 */
     void startDocument();
 
+	/**
+	 * Called when a start tag is encountered.
+	 * @param namespace the namespace of the tag or null when no namespace is present
+	 * @param name the name of the tag
+	 * @param attributes the attributes of the tag
+	 */
     void startTag(String namespace, String name, List<Attribute> attributes);
 
+	/**
+	 * Called when a end tag is encountered.
+	 * @param namespace the namespace of the tag or null when no namespace is present
+	 * @param name the name of the tag
+	 */
     void endTag(String namespace, String name);
 
+	/**
+	 * Called when character data is encountered.
+	 * @param data the character data
+	 */
     void characters(String data);
 }
diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/sax/SaxParser.java b/xjx-sax/src/main/java/io/jonasg/xjx/sax/SaxParser.java
@@ -1,13 +1,13 @@
 package io.jonasg.xjx.sax;
 
+import java.io.Reader;
+import java.util.List;
+
 import io.jonasg.xjx.EndTag;
 import io.jonasg.xjx.StartTag;
 import io.jonasg.xjx.Token;
 import io.jonasg.xjx.Tokenizer;
 
-import java.io.Reader;
-import java.util.List;
-
 public class SaxParser {
 
     private final Tokenizer tokenizer;

diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/scanners/CommentBodyScanner.java b/xjx-sax/src/main/java/io/jonasg/xjx/scanners/CommentBodyScanner.java
@@ -1,11 +1,10 @@
 package io.jonasg.xjx.scanners;
 
+import static io.jonasg.xjx.Token.Type.CLOSE_COMMENT;
 import io.jonasg.xjx.PositionedReader;
 import io.jonasg.xjx.Token;
 import io.jonasg.xjx.TokenEmitter;
 
-import static io.jonasg.xjx.Token.Type.CLOSE_COMMENT;
-
 class CommentBodyScanner implements Scanner {
     @Override
     public Scanner scan(PositionedReader reader, TokenEmitter tokenEmitter) {

diff --git a/xjx-sax/src/main/java/io/jonasg/xjx/scanners/EndTagScanner.java b/xjx-sax/src/main/java/io/jonasg/xjx/scanners/EndTagScanner.java
@@ -1,12 +1,12 @@
 package io.jonasg.xjx.scanners;
 
+import java.util.Objects;
+
 import io.jonasg.xjx.EndTag;
 import io.jonasg.xjx.PositionedReader;
 import io.jonasg.xjx.Token;
 import io.jonasg.xjx.TokenEmitter;
 
-import java.util.Objects;
-
 class EndTagScanner implements Scanner {
 
     @Override

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/BufferedPositionedReaderTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/BufferedPositionedReaderTest.java
@@ -1,11 +1,11 @@
 package io.jonasg.xjx;
 
+import java.io.StringReader;
+
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
-import java.io.StringReader;
-
 class BufferedPositionedReaderTest {
 
     @Nested

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/TokenizerIntegrationTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/TokenizerIntegrationTest.java
@@ -1,16 +1,16 @@
 package io.jonasg.xjx;
 
-import org.assertj.core.api.Condition;
-import org.junit.jupiter.api.Test;
-
-import java.io.BufferedReader;
-import java.io.StringReader;
-
 import static io.jonasg.xjx.Token.Type.CHARACTER_DATA;
 import static io.jonasg.xjx.Token.Type.START_TAG;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.data.Index.atIndex;
 
+import java.io.BufferedReader;
+import java.io.StringReader;
+
+import org.assertj.core.api.Condition;
+import org.junit.jupiter.api.Test;
+
 class TokenizerIntegrationTest {
 
     @Test

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/sax/SaxParserTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/sax/SaxParserTest.java
@@ -1,15 +1,15 @@
 package io.jonasg.xjx.sax;
 
-import org.assertj.core.api.Assertions;
-import org.junit.jupiter.api.Nested;
-import org.junit.jupiter.api.Test;
-
 import java.io.BufferedReader;
 import java.io.StringReader;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+
 class SaxParserTest {
 
     @Nested

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/scanners/CDATAScannerTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/scanners/CDATAScannerTest.java
@@ -1,14 +1,15 @@
 package io.jonasg.xjx.scanners;
 
-import io.jonasg.xjx.BufferedPositionedReader;
-import io.jonasg.xjx.Token;
-import org.assertj.core.api.Assertions;
-import org.junit.jupiter.api.Test;
-
 import java.io.StringReader;
 import java.util.ArrayList;
 import java.util.List;
 
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import io.jonasg.xjx.BufferedPositionedReader;
+import io.jonasg.xjx.Token;
+
 class CDATAScannerTest {
 
     @Test

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/scanners/CharacterScannerTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/scanners/CharacterScannerTest.java
@@ -1,12 +1,13 @@
 package io.jonasg.xjx.scanners;
 
-import io.jonasg.xjx.BufferedPositionedReader;
-import io.jonasg.xjx.Token;
+import java.io.StringReader;
+import java.util.ArrayList;
+
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 
-import java.io.StringReader;
-import java.util.ArrayList;
+import io.jonasg.xjx.BufferedPositionedReader;
+import io.jonasg.xjx.Token;
 
 class CharacterScannerTest {
 

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/scanners/CommentBodyScannerTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/scanners/CommentBodyScannerTest.java
@@ -1,14 +1,15 @@
 package io.jonasg.xjx.scanners;
 
-import io.jonasg.xjx.BufferedPositionedReader;
-import io.jonasg.xjx.Token;
+import java.io.StringReader;
+import java.util.ArrayList;
+import java.util.List;
+
 import org.assertj.core.api.Assertions;
 import org.assertj.core.api.ThrowableAssert;
 import org.junit.jupiter.api.Test;
 
-import java.io.StringReader;
-import java.util.ArrayList;
-import java.util.List;
+import io.jonasg.xjx.BufferedPositionedReader;
+import io.jonasg.xjx.Token;
 
 class CommentBodyScannerTest {
     @Test

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/scanners/DocumentTypeDeclarationScannerTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/scanners/DocumentTypeDeclarationScannerTest.java
@@ -1,13 +1,14 @@
 package io.jonasg.xjx.scanners;
 
-import io.jonasg.xjx.BufferedPositionedReader;
-import io.jonasg.xjx.Token;
+import java.io.StringReader;
+import java.util.ArrayList;
+
 import org.assertj.core.api.Assertions;
 import org.assertj.core.api.ThrowableAssert;
 import org.junit.jupiter.api.Test;
 
-import java.io.StringReader;
-import java.util.ArrayList;
+import io.jonasg.xjx.BufferedPositionedReader;
+import io.jonasg.xjx.Token;
 
 class DocumentTypeDeclarationScannerTest {
 

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/scanners/EndTagScannerTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/scanners/EndTagScannerTest.java
@@ -1,16 +1,17 @@
 package io.jonasg.xjx.scanners;
 
-import io.jonasg.xjx.BufferedPositionedReader;
-import io.jonasg.xjx.EndTag;
-import io.jonasg.xjx.Token;
-import org.assertj.core.api.Assertions;
-import org.assertj.core.api.ThrowableAssert;
-import org.junit.jupiter.api.Test;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
 import java.io.StringReader;
 import java.util.ArrayList;
 
-import static org.assertj.core.api.Assertions.*;
+import org.assertj.core.api.ThrowableAssert;
+import org.junit.jupiter.api.Test;
+
+import io.jonasg.xjx.BufferedPositionedReader;
+import io.jonasg.xjx.EndTag;
+import io.jonasg.xjx.Token;
 
 class EndTagScannerTest {
 

diff --git a/xjx-sax/src/test/java/io/jonasg/xjx/scanners/StartTagScannerTest.java b/xjx-sax/src/test/java/io/jonasg/xjx/scanners/StartTagScannerTest.java
@@ -1,16 +1,17 @@
 package io.jonasg.xjx.scanners;
 
-import io.jonasg.xjx.Attributes;
-import io.jonasg.xjx.BufferedPositionedReader;
-import io.jonasg.xjx.StartTag;
-import io.jonasg.xjx.Token;
+import java.io.StringReader;
+import java.util.ArrayList;
+import java.util.List;
+
 import org.assertj.core.api.Assertions;
 import org.assertj.core.api.ThrowableAssert;
 import org.junit.jupiter.api.Test;
 
-import java.io.StringReader;
-import java.util.ArrayList;
-import java.util.List;
+import io.jonasg.xjx.Attributes;
+import io.jonasg.xjx.BufferedPositionedReader;
+import io.jonasg.xjx.StartTag;
+import io.jonasg.xjx.Token;
 
 class StartTagScannerTest {
 

diff --git a/xjx-serdes/src/test/java/io/jonasg/xjx/serdes/deserialize/SetDeserializationTest.java b/xjx-serdes/src/test/java/io/jonasg/xjx/serdes/deserialize/SetDeserializationTest.java
@@ -2,7 +2,6 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-import java.util.List;
 import java.util.Objects;
 import java.util.Set;
 
@@ -12,8 +11,6 @@
 
 import io.jonasg.xjx.serdes.Tag;
 import io.jonasg.xjx.serdes.XjxSerdes;
-import io.jonasg.xjx.serdes.deserialize.ListDeserializationTest.Gpx;
-import io.jonasg.xjx.serdes.deserialize.ListDeserializationTest.Wpt;
 
 public class SetDeserializationTest {