Packages

  • package root
    Definition Classes
    root
  • package t2

    Defines types to create, access, and print tables.

    Defines types to create, access, and print tables.

    Getting Started

    Below is an example of how to use TableBuilder and TableWriter. Using these utilities, it builds a Table and writes the content to stdout.

    // Build table with first row as table header
val table = t2.TableBuilder()
  .add("#", "Effective Date", "Currency Code", "Exchange Rate")
  .add("1", "2021-01-04", "USD", "0.690236")
  .add("2", "2021-01-05", "USD", "0.690627")
  .add("3", "2021-01-06", "USD", "0.689332")
  .build()

// Create table writer with supplied configuration
val writer = t2.TableWriter(
  "ansiColorEnabled" -> "true",
  "tableBorderColor" -> "cyan",
  "tableHeaderColor" -> "black,yellowBackground",
  "bodyRuleColor"    -> "yellow",
  "rowHeaderEnabled" -> "true",
  "rowHeaderColor"   -> "bold,cyan",
  "columnRightAlign" -> "0,3" // Right align first and last columns
)

// Write table to stdout
writer.write(System.out, table)

    The generated output would look something like the following if printed to a color-enabled terminal.

    ===================================================
  #  Effective Date  Currency Code  Exchange Rate  
---------------------------------------------------
  1  2021-01-04      USD                 0.690236
  2  2021-01-05      USD                 0.690627
  3  2021-01-06      USD                 0.689332
===================================================

    The table writer can be configured for changing such things as cell padding, character used for table borders, and more.

    Definition Classes
    root
  • Table
  • TableBuilder
  • TableWriter

trait TableBuilder extends AnyRef

Defines table builder.

Usage

Below is an example of how to create and use the default TableBuilder.

// Build table with first row as table header
val table = t2.TableBuilder()
  .add("#", "Effective Date", "Currency Code", "Exchange Rate")
  .add("1", "2021-01-04", "USD", "0.690236")
  .add("2", "2021-01-05", "USD", "0.690627")
  .add("3", "2021-01-06", "USD", "0.689332")
  .build()
See also

TableBuilder.forRows, TableBuilder.forColumns

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

Abstract Value Members

  1. abstract def add(values: Seq[String]): TableBuilder.this.type

    Adds values.

    Adds values.

    A new row is added if isRowOriented; otherwise, a new column is added.

    values

    oriented values

    returns

    this builder

    Note

    After first set of values are added, additional sets must contain same number of values.

  2. abstract def addAll(values: Seq[Seq[String]]): TableBuilder.this.type

    Adds sets of values.

    Adds sets of values.

    New rows are added if isRowOriented; otherwise, new columns are added.

    values

    sets of oriented values

    returns

    this builder

  3. abstract def build(): Table

    Builds table using accumulated values.

    Builds table using accumulated values.

    Note

    Builder is reset after building table.

  4. abstract def columnCount: Int

    Gets current column count.

  5. abstract def isRowOriented: Boolean

    Tests for row orientation.

    Tests for row orientation.

    returns

    true if row-oriented; false if column-oriented

  6. abstract def reset(): TableBuilder.this.type

    Resets builder.

    Resets builder.

    All accumulated values are discarded.

    returns

    this builder

  7. abstract def rowCount: Int

    Gets current row count.

Concrete 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. def add(one: String, more: String*): TableBuilder.this.type

    Adds values.

    Adds values.

    A new row is added if isRowOriented; otherwise, a new column is added.

    one

    value

    more

    additional values

    returns

    this builder

    Note

    After first set of values are added, additional sets must contain same number of values.

  5. def addAll(one: Seq[String], more: Seq[String]*): TableBuilder.this.type

    Adds sets of values.

    Adds sets of values.

    New rows are added if isRowOriented; otherwise, new columns are added.

    one

    set of values

    more

    additional sets of values

    returns

    this builder

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped