From af06621e20856ecd5581c6f366210f4d72692658 Mon Sep 17 00:00:00 2001 From: joserobjr Date: Mon, 27 May 2019 02:47:19 -0300 Subject: [PATCH] Release 1.0.0 --- CHANGELOG.md | 12 +++++++++++- README.md | 6 +++--- build.gradle | 2 +- .../kotlin/br/com/gamemods/nbtmanipulator/nbt.kt | 14 +++++++++----- 4 files changed, 24 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1fb6c57..3f94126 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] +Click the link above to see the future. + +## [1.0.0] - 2019-05-27 +[Downloads from maven central.][Download 1.0.0] + +[Kotlin Documentation][KDoc 1.0.0] ### Added - `deepClone` method to all tags - `require` method to `NbtCompound` @@ -36,9 +42,13 @@ Useful for Java users and who couldn't get the sources or javadoc. - API to read and write to/from NBT files/streams using `NbtIO` - API to freely manipulate NBT data loaded in memory -[Unreleased]: https://github.com/GameModsBR/NBT-Manipulator/compare/v0.0.2...HEAD +[Unreleased]: https://github.com/GameModsBR/NBT-Manipulator/compare/v1.0.0...HEAD +[1.0.0]: https://github.com/GameModsBR/NBT-Manipulator/compare/v0.0.2..v1.0.0 [0.0.2]: https://github.com/GameModsBR/NBT-Manipulator/compare/v0.0.1..v0.0.2 [0.0.1]: https://github.com/GameModsBR/NBT-Manipulator/compare/v0.0.0..v0.0.1 +[Download 1.0.0]: http://central.maven.org/maven2/br/com/gamemods/nbt-manipulator/1.0.0/ [Download 0.0.2]: http://central.maven.org/maven2/br/com/gamemods/nbt-manipulator/0.0.2/ [Download 0.0.1]: http://central.maven.org/maven2/br/com/gamemods/nbt-manipulator/0.0.1/ + +[KDoc 1.0.0]: https://github.com/GameModsBR/NBT-Manipulator/blob/0ef42323681f9960cb2c9698d7b8b1d02632691b/kdoc/br.com.gamemods.nbtmanipulator/index.md diff --git a/README.md b/README.md index 924bc8c..b6bb5c4 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ repositories { } dependencies { - compile 'br.com.gamemods:nbt-manipulator:0.0.2' + compile 'br.com.gamemods:nbt-manipulator:1.0.0' } ``` @@ -31,7 +31,7 @@ dependencies { br.com.gamemods nbt-manipulator - 0.0.2 + 1.0.0 ``` @@ -39,7 +39,7 @@ dependencies { ### Ivy ```xml - + ``` ### Direct JAR diff --git a/build.gradle b/build.gradle index dad9ea9..0cd80c1 100644 --- a/build.gradle +++ b/build.gradle @@ -8,7 +8,7 @@ plugins { } group 'br.com.gamemods' -version '0.1.0-SNAPSHOT' +version '1.0.0' sourceSets.main.java.srcDirs = ["src/main/kotlin"] sourceSets.test.java.srcDirs = ["src/main/kotlin"] diff --git a/src/main/kotlin/br/com/gamemods/nbtmanipulator/nbt.kt b/src/main/kotlin/br/com/gamemods/nbtmanipulator/nbt.kt index a6a025f..975313a 100644 --- a/src/main/kotlin/br/com/gamemods/nbtmanipulator/nbt.kt +++ b/src/main/kotlin/br/com/gamemods/nbtmanipulator/nbt.kt @@ -169,12 +169,16 @@ data class NbtString(var value: String): NbtTag() { /** * A tag which contains a [MutableList] structure of [NbtTag]s. All items in the list must have the same class. * Null values in the list are not allowed. - * @param tags The tags that will be in this list initially. May be read-only. * The tags in the list will be linked so any modification will also change this tag contents. * @param T The type of the tag that will be wrapped. [NbtEnd] and [NbtTag] are not valid. */ @Suppress("UNCHECKED_CAST") -class NbtList(tags: Collection): NbtTag(), MutableList by tags.toMutableList() { +class NbtList + /** + * Uses all tags as initial value of this list. Make sure to use the same class in all values. + */ + constructor(tags: Collection): NbtTag(), MutableList +by tags.toMutableList() { /** * Creates a empty list. */ @@ -223,9 +227,6 @@ private const val BYTE_TRUE: Byte = 1 * * It's the main heart of NBT files and usually contains complex structures. * - * @param value A [Map] which contains all key-value mappings. - * The tags in the map will be linked so any modification will also change this tag contents. - * * The returned tags by this class will be linked, so modifications to it will also affects the compound value. * * All get functions which are not prefixed with `Nullable` and `get` will throw a [ClassCastException] @@ -237,6 +238,9 @@ private const val BYTE_TRUE: Byte = 1 * * All get list functions which returns lists of specific types will throw [IllegalStateException] if the list content * does not match the requested type. + * + * @param value A [Map] which contains all key-value mappings. + * The tags in the map will be linked so any modification will also change this tag contents. */ class NbtCompound(value: Map) : NbtTag(), MutableMap by LinkedHashMap(value) { /**