com.netflix.config.scala.ChainedProperty.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of archaius-scala Show documentation
archaius-scala developed by Netflix
The newest version!
/*
 * Copyright 2014 Netflix, Inc.
 *
 * 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.
 */
package com.netflix.config.scala

import com.netflix.config.scala.ChainMakers.{ChainBoxConverter, ChainBox}

/**
 * Base functionality of a [[com.netflix.config.ChainedDynamicProperty]], in Scala terms.
 * @tparam TYPE the Scala type produced by the property.
 */
trait ChainedProperty[TYPE] extends DynamicProperty[TYPE] {

  /*
   * The second generic property is necessary to provide the type for the ChainLink.  Conversions
   * among values are implicit but conversions among classes are not.  So for example a scala.Int 42
   * is implicitly converted to/from a java.lang.Integer 42, but classOf[scala.Int] does not
   * implicitly convert to classOf[java.lang.Integer].
   */
  override protected val box : ChainBox[TYPE, _]

  /**
   * Produce the most-appropriate current value of the chain of properties.  Where the Scala type allows
   * it, it may be null, ie. scala.String is [[scala.AnyRef]] may be null but numbers are [[scala.AnyVal]]
   * and so may not be null.
   * @return the value derived from the chain of properties.
   */
  override def get: TYPE = box.get

  /**
   * Produce the most-appropriate current value of the chain of properties, as an [[scala.Option]].  Null
   * values results are represented as [[scala.None]], regardless of the possibility of the Scala type to
   * be null.
   * @return the value derived from the chain of properties.
   */
  override def apply(): Option[TYPE] = box()

  /**
   * Allow derivation of a new type of ChainedProperty by mapping the type of this one.
   * @param fn the transformation function which produces the new type.
   * @return a new ChainedProperty for the target type.
   */
  override def map[B](fn: (TYPE) => B)(implicit mapType: Manifest[B]): ChainedProperty[B] = new MapChainBy(box, fn, mapType)

  protected[this] class MapChainBy[B, TYPE](unmappedBox: ChainBox[TYPE, _], fn: (TYPE) => B, mapType: Manifest[B])
  extends ChainedProperty[B]
  {
    override protected val box = new ChainBoxConverter[B, TYPE](unmappedBox, fn, mapType)

    override def propertyNames: Iterable[String] = propertyNames
  }

  /**
   * Get the name of the property.
   * @return the property name
   */
  override def propertyName: String = box.propertyName

  /**
   * Get the names of all properties in the chain.
   * @return all property names
   */
  def propertyNames: Iterable[String]

  /**
   * Get the default value of the chain of properties.  Where the Scala type allows it, it may be null,
   * ie. scala.String is [[scala.AnyRef]] may be null but numbers are [[scala.AnyVal]] and so may not
   * be null.
   * @return the default value from the chain of properties.
   */
  override def defaultValue: TYPE = box.defaultValue

  /**
   * Add a callback to be triggered when the value of the property is
   * changed.
   * @param callback a function to call on changes.
   */
  override def addCallback(callback: () => Unit) {
    box.addCallback(callback)
  }

  /**
   * Add a callback to be triggered when the value of the property is
   * changed.
   * @param callback a [[java.lang.Runnable]] to call on changes.
   */
  @deprecated("pass a function instead", "0.6.1")
  def addCallback(callback: Runnable) {
    val run: () => Unit = callback.run
    box.addCallback(run)
  }

  override def toString: String = s"[${propertyName}] = ${get}"
}