api

Type Members

1. trait ResolutionStrategy extends AnyRef

   

   Interface used to define a ResolutionStrategy.

   Interface used to define a ResolutionStrategy.

   Naming conventions can be different going from scala to hocon config. ResolutionStrategy defines the api that is used for the translation of scala field names to hocon config keys

   Example:

   1. case class AddB() extends ResolutionStrategy {
           override def resolve(s: String): String = s+"B"
       }

      This example shows how to define a simple AddB resolution strategy. The resolution strategy simply adds 'B' to the end fo the field name.

   Note

   More example are available under com.github.kiran002.kissconfig.config.impl.ResolutionStrategies

   ,

   This is only an example for how to define a resolution strategy, this should never be used in your application.

2. trait TypeHelper extends AnyRef

   

   Interface used to define a TypeHelper.

   Interface used to define a TypeHelper.

   Given a type (T), the TypeHelper is expected to be able

   1. Extract configuration value from the config object 2. Parse the value to the target type

   Example:

   1. class StringTypeHelper extends TypeHelper {
          private val stringExtractor: Input => Any  = x => x.config.getString(x.configKey.get)
           override def canHandle(objType: universe.Type): Boolean =
                         objType.typeSymbol==universe.typeOf[String].typeSymbol
          override def get(objType: universe.Type): Input => Any = stringExtractor
       }

   Note

   More example are available under com.github.kiran002.kissconfig.config.impl