Object

profig

Config

Related Doc: package profig

Permalink

object Config extends ConfigPath

Config provides access to environment variables, properties, and other configuration all merged together into one powerful system. Uses JSON internally to provide merging and integration. Paths are dot-separated.

See also

profig.ConfigApplication for convenience initialization

Linear Supertypes
ConfigPath, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Config
  2. ConfigPath
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(): Json

    Permalink

    Returns a Json representation of this path.

    Returns a Json representation of this path. Works similar to get(), except will return an empty Json object if there is nothing at this level.

    returns

    Json

    Definition Classes
    ConfigPath
  5. def apply(path1: String, path2: String*): ConfigPath

    Permalink

    Look up a deeper path below the current path.

    Look up a deeper path below the current path.

    returns

    ConfigPath

    Definition Classes
    ConfigPath
  6. macro def as[T]: T

    Permalink

    Loads this path out as the defined type T.

    Loads this path out as the defined type T.

    T

    the type to represent the current path

    returns

    T

    Definition Classes
    ConfigPath
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def combine(json: Json, defaults: Boolean): Unit

    Permalink

    Combines a Json instance at this path.

    Combines a Json instance at this path.

    Definition Classes
    ConfigPath
  10. def combine(properties: Properties, defaults: Boolean): Unit

    Permalink

    Combines a properties object at this path.

    Combines a properties object at this path.

    Definition Classes
    ConfigPath
  11. def combine(args: Seq[String], defaults: Boolean): Unit

    Permalink

    Combines a sequence of args at this path.

    Combines a sequence of args at this path.

    Definition Classes
    ConfigPath
  12. def combine(string: String, defaults: Boolean): Unit

    Permalink

    Combines a string of content auto-detected to JSON.

    Combines a string of content auto-detected to JSON.

    Definition Classes
    ConfigPath
  13. def defaults(properties: Properties): Unit

    Permalink

    Loads defaults from this Properties object at this path.

    Loads defaults from this Properties object at this path.

    Definition Classes
    ConfigPath
  14. def defaults(json: Json): Unit

    Permalink

    Loads defaults from this Json object at this path.

    Loads defaults from this Json object at this path.

    Definition Classes
    ConfigPath
  15. def defaults(string: String): Unit

    Permalink

    Loads defaults for a string of content auto-detected to JSON.

    Loads defaults for a string of content auto-detected to JSON.

    Definition Classes
    ConfigPath
  16. def defaults(args: Seq[String]): Unit

    Permalink

    Loads defaults for a sequence of args.

    Loads defaults for a sequence of args. This is primarily useful for loading command-line arguments.

    Definition Classes
    ConfigPath
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def exists(): Boolean

    Permalink

    True if this path exists in the Config

    True if this path exists in the Config

    Definition Classes
    ConfigPath
  20. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def get(): Option[Json]

    Permalink

    Returns a Json representation of this path if there is anything defined at this level.

    Returns a Json representation of this path if there is anything defined at this level.

    returns

    Option[Json]

    Definition Classes
    ConfigPath
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. macro def init(args: Seq[String] = Seq.empty): Unit

    Permalink

    Initializes Profig.

    Initializes Profig. This must be invoked prior to using. Multiple invocations are allowed, but initialization only occurs the first time. Additional calls will still merge args submitted by this method.

    args

    the command-line arguments to merge into the configuration, if any

  25. macro def initMacro(args: Seq[String]): Unit

    Permalink

    Specialized version of init when being used to load configuration for use with a Macro at compile-time.

    Specialized version of init when being used to load configuration for use with a Macro at compile-time. This is a work-around for parser limitations in Scala.js when running on the JVM.

    Warning: this should only be used when being invoked from another Macro like the following: context.eval(reify(profig.Config.initMacro(Nil)))

    args

    the command-line arguments to merge into the configuration, if any

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def merge(properties: Properties): Unit

    Permalink

    Merges a Properties object to this path.

    Merges a Properties object to this path.

    Definition Classes
    ConfigPath
  28. def merge(json: Json): Unit

    Permalink

    Merges a Json object to this path.

    Merges a Json object to this path.

    Definition Classes
    ConfigPath
  29. def merge(string: String): Unit

    Permalink

    Merges a string of content auto-detected to JSON.

    Merges a string of content auto-detected to JSON.

    Definition Classes
    ConfigPath
  30. def merge(args: Seq[String]): Unit

    Permalink

    Merges a sequence of args.

    Merges a sequence of args. This is primarily useful for merging command-line arguments.

    Definition Classes
    ConfigPath
    See also

    profig.ConfigApplication for a managed mechanism for this

  31. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  32. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  34. val path: List[String]

    Permalink

    the path defined within the configuration

    the path defined within the configuration

    Definition Classes
    ConfigPath
  35. macro def store[T](value: T): Unit

    Permalink

    Stores the supplied value into this path.

    Stores the supplied value into this path.

    T

    the type of value

    value

    the value to store

    Definition Classes
    ConfigPath
  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ConfigPath

Inherited from AnyRef

Inherited from Any

Ungrouped