Kotlin XML Builder
This library can be used to build xml documents from Kotlin code. It is based on the HTML builder described in the Kotlin docs
It is designed to be lightweight and fast. There isn't any validation except to escape text to not violate xml standards.
License
Apache 2.0
Usage
To use in Gradle, simply add the jcenter repository and then add the following dependency.
repositories {
jcenter()
}
dependencies {
compile 'org.redundent:kotlin-xml-builder:[VERSION]'
}
Example
val people = xml("people") {
xmlns = "http://example.com/people"
"person" {
attribute("id", 1)
"firstName" {
-"John"
}
"lastName" {
-"Doe"
}
"phone" {
-"555-555-5555"
}
}
}
val asString = people.toString()
produces
<people xmlns="http://example.com/people">
<person id="1">
<firstName>John</firstName>
<lastName>Doe</lastName>
<phone>555-555-5555</phone>
</person>
</people>
class Person(val id: Long, val firstName: String, val lastName: String, val phone: String)
val listOfPeople = listOf(
Person(1, "John", "Doe", "555-555-5555"),
Person(2, "Jane", "Doe", "555-555-6666")
)
val people = xml("people") {
xmlns = "http://example.com/people"
for (person in listOfPeople) {
"person" {
attribute("id", person.id)
"firstName" {
-person.firstName
}
"lastName" {
-person.lastName
}
"phone" {
-person.phone
}
}
}
}
val asString = people.toString()
produces
<people xmlns="http://example.com/people">
<person id="1">
<firstName>John</firstName>
<lastName>Doe</lastName>
<phone>555-555-5555</phone>
</person>
<person id="2">
<firstName>Jane</firstName>
<lastName>Doe</lastName>
<phone>555-555-6666</phone>
</person>
</people>
Release Notes
Version 1.4.5
- Fixed incorrect handling of CDATA elements.
prettyFormat
should not alter the CDATA content. - Fixed nested CData elements
Big thanks to @TWiStErRob for finding and fixing both of these!
Version 1.4.4
- Switched to Kotlin's
Charsets
instead of usingjava.nio.charset.StandardCharsets
.StandardCharsets
is not available in some versions of Android.
Thanks to @little-fish for submitting and fixing this!
Version 1.4.3
BREAKING CHANGES
- Moved
prettyFormat
to a parameter oftoString()
.prettyFormat
in the constructor or util method is no longer available. Fixes issue #7
Version 1.4.2
- Fixes issue #6
Version 1.4.1
- Upgrading Gradle to 4.9
- Upgrading Kotlin to 1.2.60
- Fix issue #4
- Tweak generation code to be more concise
- Add flag to code generation to allow for member functions instead of extension functions
Version 1.4
BREAKING CHANGES
org.redundent.kotlin.xml.Node.name
has been renamed toorg.redundent.kotlin.xml.Node.nodeName
to avoid clashes with attributes calledname
.
- Adding DSL generator project to generate kotlin-xml-builder DSL from a schema file. See kotlin-xml-dsl-generator for details
Version 1.3
- Added ability to parse an xml document into a builder object using the new
parse
method. - Upgrading Gradle and Kotlin versions.
Version 1.2
- Added a
sitemap
method to allow for easy generation of sitemaps (which is what this project was created for in the first place). - Added
String.invoke
for elements allowing you to specify elements by just their name (see docs above) - Added some searching methods to search child nodes.
filter
,first
,firstOrNull
, andexists
. - Added some mutation methods to allow you to add/remove/replace nodes in an element.
Version 1.1
- Added convenience method for elements with just a name and value.
element("name", "value")
- Removed
ns
method. Please usenamespace(...)
instead. - Upgraded Gradle version