Packages

case class TableRow(paths: List[FieldName], format: Option[Format], description: List[Description], nested: Option[Table], sources: Set[String]) extends Product with Serializable

A TableRow represents each row in a Table which is an intermediate light-weight structure produced from ConfigDocs. Table is more easier to be converted to formats such as Json, markdown or any custom format fo your choice.

paths

: Each config key is basically a list of paths representing its hierarchy. Example: "aws.ec2.instance.type" where list of paths is List("aws", "ec2", "instance", "type")

format

: The format of value of key (paths). Example: it can be a Primitive type (String, Int etc), or it can be complex structures as such as List or Map.

description

: Description (zio-config in-built or user-provided) of the key (paths).

nested

: A TableRow can be pointed to a nested table that has the details of all the child paths that are under paths. Hence TableRow is a recursive structure.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TableRow
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TableRow(paths: List[FieldName], format: Option[Format], description: List[Description], nested: Option[Table], sources: Set[String])

    paths

    : Each config key is basically a list of paths representing its hierarchy. Example: "aws.ec2.instance.type" where list of paths is List("aws", "ec2", "instance", "type")

    format

    : The format of value of key (paths). Example: it can be a Primitive type (String, Int etc), or it can be complex structures as such as List or Map.

    description

    : Description (zio-config in-built or user-provided) of the key (paths).

    nested

    : A TableRow can be pointed to a nested table that has the details of all the child paths that are under paths. Hence TableRow is a recursive structure.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asTable: Table
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  7. val description: List[Description]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. val format: Option[Format]
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val nested: Option[Table]
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. val paths: List[FieldName]
  18. val sources: Set[String]
  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped