Skip to content

Commit b0c4e72

Browse files
committed
Javadoc additions
1 parent b7187a7 commit b0c4e72

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

src/main/java/tools/jackson/dataformat/xml/ser/XmlGeneratorInitializer.java

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,34 @@ public void initialize(SerializationConfig config, JsonGenerator g) throws Jacks
3131
}
3232
}
3333

34+
/**
35+
* Convenience method that constructs {@link DTD} out of arguments
36+
* and calls {@link #addDTD(DTD)}.
37+
*
38+
* @param rootName (required) Root name for DTD
39+
* @param systemId (optional) System Id for DTD
40+
* @param publicId (optional) Public Id for DTD
41+
* @param internalSubset (optional) Internal subset for DTD (not including
42+
* surrounding brackets
43+
*
44+
* @return This initializer for call chaining
45+
*/
3446
public XmlGeneratorInitializer addDTD(String rootName,
3547
String systemId, String publicId,
3648
String internalSubset) {
3749
return addDTD(new DTD(rootName, systemId, publicId, internalSubset));
3850
}
3951

52+
/**
53+
* Method for adding Document Type Declaration (DTD) directive; to write
54+
* in order added with respective to other directives (but always after
55+
* XML Declaration which most come before any other output; and before
56+
* Document Root element)
57+
*
58+
* @param dtd DTD to write
59+
*
60+
* @return This initializer for call chaining
61+
*/
4062
public XmlGeneratorInitializer addDTD(DTD dtd) {
4163
_dtd = dtd;
4264
return this;

0 commit comments

Comments
 (0)