Object/Class

profig

Profig

Related Docs: class Profig | package profig

Permalink

object Profig extends Profig

Profig 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.

Linear Supertypes
Profig, ProfigPath, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Profig
  2. Profig
  3. ProfigPath
  4. AnyRef
  5. 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(parent: Option[Profig]): Profig

    Permalink
  5. 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
    ProfigPath
  6. def apply(path: String*): ProfigPath

    Permalink

    Look up a deeper path below the current path.

    Look up a deeper path below the current path.

    returns

    ProfigPath

    Definition Classes
    ProfigPath
  7. 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
    ProfigPath
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def child(): Profig

    Permalink
    Definition Classes
    Profig
  10. def clone(): AnyRef

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

    Permalink

    Combines a Json instance at this path.

    Combines a Json instance at this path.

    Definition Classes
    ProfigPath
  12. def combine(properties: Properties, defaults: Boolean): Unit

    Permalink

    Combines a properties object at this path.

    Combines a properties object at this path.

    Definition Classes
    ProfigPath
  13. 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
    ProfigPath
  14. 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
    ProfigPath
  15. 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
    ProfigPath
  16. 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
    ProfigPath
  17. 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
    ProfigPath
  18. 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
    ProfigPath
  19. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink

    True if this path exists in the config

    True if this path exists in the config

    Definition Classes
    ProfigPath
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. 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
    ProfigPath
  24. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  26. 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.Profig.initMacro(Nil)))

    args

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

    Definition Classes
    Profig
  27. def instance: Profig

    Permalink
    Definition Classes
    ProfigProfigPath
  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  29. def json: Json

    Permalink
    Definition Classes
    Profig
  30. def lastModified: Long

    Permalink
    Definition Classes
    Profig
  31. def loadEnvironmentVariables(asDefault: Boolean = true): Unit

    Permalink
    Definition Classes
    Profig
  32. def loadProperties(asDefault: Boolean = true): Unit

    Permalink
    Definition Classes
    Profig
  33. def merge(properties: Properties): Unit

    Permalink

    Merges a Properties object to this path.

    Merges a Properties object to this path.

    Definition Classes
    ProfigPath
  34. def merge(json: Json): Unit

    Permalink

    Merges a Json object to this path.

    Merges a Json object to this path.

    Definition Classes
    ProfigPath
  35. 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
    ProfigPath
  36. 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
    ProfigPath
  37. def modify(f: (Json) ⇒ Json): Unit

    Permalink
    Attributes
    protected[profig]
    Definition Classes
    Profig
  38. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  41. val parent: Option[Profig]

    Permalink
    Definition Classes
    Profig
  42. def path: List[String]

    Permalink
    Definition Classes
    ProfigProfigPath
  43. def remove(): Unit

    Permalink
    Definition Classes
    ProfigPath
  44. def remove(field: String): Unit

    Permalink

    Removes a field from this path.

    Removes a field from this path.

    field

    the field below this path to remove

    Definition Classes
    ProfigPath
  45. 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
    ProfigPath
  46. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

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

Inherited from Profig

Inherited from ProfigPath

Inherited from AnyRef

Inherited from Any

Ungrouped