Add javadoc

FasterXML · Feb 21, 2024 · eebd098 · eebd098
1 parent 371fda9
commit eebd098
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/src/main/java/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.java b/src/main/java/com/fasterxml/jackson/dataformat/xml/XmlFactoryBuilder.java
@@ -55,7 +55,7 @@ public class XmlFactoryBuilder extends TSFBuilder<XmlFactory, XmlFactoryBuilder>
     protected String _nameForTextElement;
 
     /**
-     * Set a default value in case of empty an empty element (empty XML tag)
+     * Set a default value in case of an empty element (empty XML tag)
      *<p>
      * Value used for pseudo-property used for returning empty XML tag.
      * Defaults to empty String, but may be changed.

diff --git a/src/main/java/com/fasterxml/jackson/dataformat/xml/XmlMapper.java b/src/main/java/com/fasterxml/jackson/dataformat/xml/XmlMapper.java
@@ -104,6 +104,15 @@ public Builder nameForTextElement(String name) {
             return this;
         }
 
+        /**
+         *
+         * Set a default value in case of an empty element (empty XML tag)
+         *<p>
+         * In case of an empty XML tag (like `<no-content/>`) the serialized value
+         * is set to `String value`. If not specified, the default value is empty String.
+         *
+         * @since 2.17
+         */
         public Builder valueForEmptyElement(String value) {
             _mapper.setValueForEmptyElement(value);
             return this;

diff --git a/src/main/java/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.java b/src/main/java/com/fasterxml/jackson/dataformat/xml/deser/FromXmlParser.java
@@ -40,6 +40,10 @@ public class FromXmlParser
      */
     public final static String DEFAULT_UNNAMED_TEXT_PROPERTY = "";
 
+    /**
+     * The default value placeholder for XML empty tag is an empty
+     * String ("").
+     */
     public final static String DEFAULT_EMPTY_ELEMENT_VALUE = "";
 
     /**
@@ -286,6 +290,9 @@ public FromXmlParser(IOContext ctxt, int genericParserFeatures, int xmlFeatures,
         this(ctxt, genericParserFeatures, xmlFeatures, codec, xmlReader, tagProcessor, FromXmlParser.DEFAULT_EMPTY_ELEMENT_VALUE);
     }
 
+    /**
+     * @since 2.17
+     */
     public FromXmlParser(IOContext ctxt, int genericParserFeatures, int xmlFeatures,
              ObjectCodec codec, XMLStreamReader xmlReader, XmlNameProcessor tagProcessor, String valueForEmptyElement)
         throws IOException

diff --git a/src/main/java/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.java b/src/main/java/com/fasterxml/jackson/dataformat/xml/deser/XmlTokenStream.java
@@ -120,7 +120,7 @@ public class XmlTokenStream
      */
     protected String _textValue;
 
-    protected String _valueForEmptyElement;
+    protected final String _valueForEmptyElement;
 
     /**
      * Marker flag set if caller wants to "push back" current token so
@@ -558,7 +558,6 @@ private final int _next() throws XMLStreamException
 
     /**
      * @return Collected text, if any, EXCEPT that if {@code FromXmlParser.Feature.EMPTY_ELEMENT_AS_NULL}
-     *    OR {@code FromXmlParser.Feature.EMPTY_ELEMENT_AS_EMPTY_ARRAY}
      *    AND empty element, returns {@code null}
      */
     private final String _collectUntilTag() throws XMLStreamException