kotlinx-bimap

a bimap (bidirectional map) implementation for Kotlin

License	The Apache Software License, Version 2.0
Categories	Kotlin Languages
GroupId	com.uchuhimo
ArtifactId	kotlinx-bimap
Last Version	1.2
Release Date	Oct 18, 2018
Type	jar
Description	kotlinx-bimap a bimap (bidirectional map) implementation for Kotlin
Project URL	https://github.com/uchuhimo/kotlinx-bimap
Source Code Management	https://github.com/uchuhimo/kotlinx-bimap

Download kotlinx-bimap

Filename	Size
kotlinx-bimap-1.2.pom
kotlinx-bimap-1.2.jar	18 KB
kotlinx-bimap-1.2-sources.jar	6 KB
kotlinx-bimap-1.2-javadoc.jar	21 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.uchuhimo/kotlinx-bimap/ -->
<dependency>
    <groupId>com.uchuhimo</groupId>
    <artifactId>kotlinx-bimap</artifactId>
    <version>1.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.uchuhimo/kotlinx-bimap/
implementation 'com.uchuhimo:kotlinx-bimap:1.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.uchuhimo/kotlinx-bimap/
implementation ("com.uchuhimo:kotlinx-bimap:1.2")

Apache Buildr

'com.uchuhimo:kotlinx-bimap:jar:1.2'

Apache Ivy

<dependency org="com.uchuhimo" name="kotlinx-bimap" rev="1.2">
  <artifact name="kotlinx-bimap" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.uchuhimo', module='kotlinx-bimap', version='1.2')
)

Scala SBT

libraryDependencies += "com.uchuhimo" % "kotlinx-bimap" % "1.2"

Leiningen

[com.uchuhimo/kotlinx-bimap "1.2"]

Dependencies

runtime (2)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-stdlib	jar	1.2.61
com.google.guava : guava	jar	20.0

Project Modules

There are no modules declared in this project.

kotlinx-bimap

A bimap (bidirectional map) implementation for Kotlin.

Prerequisites

• JDK 1.6 or higher

Interfaces and implementations

This library provides interfaces for read-only/mutable bimap:

Interface	Bases	Implementations
BiMap	Map	emptyBiMap, biMapOf, toBiMap
MutableBiMap	MutableMap, BiMap	mutableBiMapOf, toMutableBiMap

Operations

Create read-only bimap

• Create an empty read-only bimap:

  val newBiMap = emptyBiMap()

• Create a new read-only bimap from pairs:

  val newBiMap = biMapOf(1 to "1", 2 to "2", 3 to "3")

• Create a new read-only bimap from map:

  val newBiMap = mapOf(1 to "1", 2 to "2", 3 to "3").toBiMap()

Create mutable bimap

• Create an empty mutable bimap:

  val newBiMap = mutableBiMapOf()

• Create a new mutable bimap from pairs:

  val newBiMap = mutableBiMapOf(1 to "1", 2 to "2", 3 to "3")

• Create a new mutable bimap from map:

  val newBiMap = mapOf(1 to "1", 2 to "2", 3 to "3").toMutableBiMap()

Query bimap

• Bimap support all operations of map:

  val biMap = biMapOf(1 to "1", 2 to "2", 3 to "3")
  biMap.size // 3
  biMap.isEmpty() // false
  biMap.values // ["1", "2", "3"]
  biMap[1] // "1"
  biMap.containsKey(4) // false

• Get the inverse view of bimap:

  val biMap = biMapOf(1 to "1", 2 to "2", 3 to "3")
  val inverseBiMap = biMap.inverse
  inverseBiMap.values // [1, 2, 3]

Mutate mutable bimap

Mutable bimap support all operations of mutable map:

val mutableBiMap = mutableBiMapOf(1 to "1", 2 to "2", 3 to "3")
mutableBiMap[3] = "4"
mutableBiMap.remove(1)
mutableBiMap.clear()

When using put operation (i.e., mutableBiMap[3] = "4"), the bimap throws IllegalArgumentException if the given value is already bound to a different key in it. The bimap will remain unmodified in this event. To avoid this exception, call forcePut instead:

mutableBiMap.forcePut(4, "2")

The forcePut operation will silently remove any existing entry with the value before proceeding with the put operation.

Interoperability with Guava bimap

• Views a mutable bimap as a Guava bimap:

  val mutableBiMap = mutableBiMapOf(1 to "1", 2 to "2", 3 to "3")
  val guavaBiMap = mutableBiMap.asGuavaBiMap()

• Views a Guava bimap as a mutable bimap:

  val guavaBiMap = HashBiMap.create(mapOf(1 to "1", 2 to "2", 3 to "3"))
  val mutableBiMap = guavaBiMap.asMutableBiMap()

Using in your projects

This library has been published to Maven Central, JCenter and JitPack.

Maven

<dependency>
  <groupId>com.uchuhimo</groupId>
  <artifactId>kotlinx-bimap</artifactId>
  <version>1.2</version>
</dependency>

Gradle

compile 'com.uchuhimo:kotlinx-bimap:1.2'

Gradle Kotlin DSL

compile(group = "com.uchuhimo", name = "kotlinx-bimap", version = "1.2")

Building from source

Build library with Gradle using the following command:

gradlew clean assemble

Test library with Gradle using the following command:

gradlew clean test

Since Gradle has excellent incremental build support, you can usually omit executing the clean task.

Install library in a local Maven repository for consumption in other projects via the following command:

gradlew clean install

License

© uchuhimo, 2017-2018. Licensed under an Apache 2.0 license.

Versions

Version
1.2 Oct 18, 2018