value.ObjectProperties.kt Maven / Gradle / Ivy

Go to download
package io.toolisticon.kotlin.avro.value

import io.toolisticon.kotlin.avro.AvroKotlin
import io.toolisticon.kotlin.avro.value.property.LogicalTypeNameProperty
import org.apache.avro.JsonProperties

/**
 * Represents properties present on [org.apache.avro.JsonProperties].
 *
 * To fulfill the restrictions of the avro json mapping,
 * value types are limited to:
 *
 *   * Map
 *   * Collection
 *   * boolean
 *   * Int
 *   * Long
 *   * Float
 *   * Double
 *   * ByteArray
 *   * String
 */
@JvmInline
value class ObjectProperties(override val value: Map = emptyMap()) : Map by value, ValueType> {
  companion object {
    private val ignoredProperties = setOf(LogicalTypeNameProperty.PROPERTY_KEY)
    val EMPTY = ObjectProperties()

    fun of(other: ObjectProperties) = ObjectProperties(other.value)

    /**
     * Creates new instance from schema objectProps.
     *
     * @param jsonProperties schema, field or protocol containing objectProps
     * @return properties derived from jsonProperties
     */
    fun ofNullable(jsonProperties: JsonProperties?) = jsonProperties?.let {
      ObjectProperties(value = jsonProperties.objectProps.toMap())
    } ?: EMPTY
  }

  /**
   * Creates new instance from properties.
   *
   * @param pairs key/value pairs with properties
   * @return properties created from pairs
   */
  constructor(vararg pairs: Pair) : this(value = mapOf(*pairs))

  /**
   * Type-safe access to  value for given key.
   *
   * @param key the property key
   * @param  the expected value
   * @throws IllegalArgumentException if key does not exist
   * @return typed value of property
   */
  @Throws(IllegalArgumentException::class)
  @Suppress("UNCHECKED_CAST")
  inline fun  getValue(key: String): V {
    require(contains(key)) { "unknown key: $key" }

    // This cannot be null anymore, the key exists and the value must not be null.
    val value = get(key)!!

    // if it is a map, return ObjectProperties, else cast
    return if (V::class == ObjectProperties::class) {
      ObjectProperties(value as Map) as V
    } else {
      value as V
    }
  }

  @Throws(IllegalArgumentException::class)
  inline fun  getValueOrNull(key: String): V? {
    return if (contains(key)) {
      getValue(key)
    } else {
      null
    }
  }

  /**
   * Gets the value of given key as [ObjectProperties].
   *
   * @param key the property key
   * @return objectProperties of given key
   */
  fun getMap(key: String): ObjectProperties = getValue(key)

  /**
   * Creates a copy of this properties instance with all ignored property keys removed.
   */
  fun filterIgnoredKeys(): ObjectProperties = ObjectProperties(value = value.filterNot { ignoredProperties.contains(it.key) })

  override fun toString() = value.toString()
}