Kml

Kml- a lightweight xml serializer/deserializer via kotlin

What is kml

Kml provide two simple method to serializer/deserializer xml:

/* object -> xml */
fun toXml(obj: Any?, name: String? = null): String
/* xml -> object */
fun <T> fromXml(xml: String, clazz: KClass<*>): T?

Kml has one main class,one tool file,four annotations

.
├── Kml.kt
├── Util.kt
└── annotations
    ├── Attribute.kt
    ├── Element.kt
    ├── Leaf.kt
    └── NoArg.kt

How To Use

Dependency

// kotlin reflect support
dependencies {
    compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
    compile "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
}

// data class noarg allopen plugin
// root build.gradle
buildscript {
		...
    dependencies {
				...
        classpath "org.jetbrains.kotlin:kotlin-noarg:$kotlin_version"
        classpath "org.jetbrains.kotlin:kotlin-allopen:$kotlin_version"
    }
}
// app build.gradle
apply plugin: 'kotlin-noarg'
apply plugin: 'kotlin-allopen'
noArg {
    invokeInitializers = true
    annotation("io.jin.kml.annotations.NoArg")
}

allOpen {
    annotation("io.jin.kml.annotations.NoArg")
}

Install

// Add it in your root build.gradle at the end of repositories:
allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}

//Add the dependency
implementation 'com.github.acidsweet:kml:0.0.2'

Define your data class

@NoArg : help data class to create a no-arg constructer
@Element : mark class or property as xml element
- elementName = name.isNotBlank()?name:class.simpleName or property.name
@Attribute : mark property as xml attribute
- attributeName = name.isNotBlank()?name:property.name
@Leaf : mark property as xml textNode

via kotlin

@NoArg
@Element(name = "book")
data class Book(@Attribute var category: String, @Element var title: Title, @Element var author: String, @Element var year: Int, @Element var price: Double)

via java

public class Title {
    @Attribute
    private String lang;
    @Leaf
    private String text;
}

ToXml

Kml().toXml(bookStore)

FromXml

Kml().fromXml<BookStore>(xml, BookStore::class)

More details in Test.kt

What's Next

More robustness
Coroutine support
Huge file support

License

Kml is licensed under the Apache 2.0 License

Copyright 2018 Kaidan Gustave

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

acidsweet/kml

Kml