Class

zio.config.ConfigDocsModule.Table

TableRow

Related Doc: package Table

Permalink

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
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])

    Permalink

    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

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

    Permalink
    Definition Classes
    Any
  5. def asTable: Table

    Permalink
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. val description: List[Description]

    Permalink

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

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. val format: Option[Format]

    Permalink

    : The format of value of key (paths).

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

  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. val nested: Option[Table]

    Permalink

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

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

  15. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  17. val paths: List[FieldName]

    Permalink

    : Each config key is basically a list of paths representing its hierarchy.

    : 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")

  18. val sources: Set[String]

    Permalink
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped