StringTablePrinter (patrimoine de base SIRIUS 4.11 API)

java.lang.Object
- fr.cnes.sirius.patrius.utils.StringTablePrinter

```
public class StringTablePrinter
extends Object
```
This utility class allows to print a table as a formatted String with dynamic columns widths.

Author:

veuillh, bonitt, barthet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class StringTablePrinter.StringAlign
Text alignment enumerate.

Nested Classes
Modifier and Type	Class and Description
`static class`	`StringTablePrinter.StringAlign` Text alignment enumerate.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_BOLD_LINE_SEPARATOR` The default String representing the bold line separator.
`static String`	`DEFAULT_LEFT_VERTICAL_SEPARATOR` The default String representing the vertical separator of the left column.
`static String`	`DEFAULT_RIGHT_VERTICAL_SEPARATOR` The default String representing the vertical separator of the right column.
`static String`	`DEFAULT_STANDARD_LINE_SEPARATOR` The default String representing the standard line separator.
`static String`	`DEFAULT_VERTICAL_SEPARATOR` The default String representing the vertical separator of the middle columns.

Constructor Summary

Constructors
Constructor and Description
`StringTablePrinter(String[] header)` Constructor to initialize the header.
`StringTablePrinter(String title, String[] header)` Constructor to initialize the header and add a centered title to the table.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBoldLineSeparator()` Add a line full of bold separators.
`void`	`addLine(double[] values, String fmt)` Add the values as a line to the table.
`void`	`addLine(String[] line)` Add a line to the table.
`void`	`addLine(String leftColumn, double[] values, String fmt)` Add the values as a line to the table. The first column is described by a String.
`void`	`addStandardLineSeparator()` Add a line full of standard separators.
`void`	`clear()` Clear the title and the table (the header remains).
`String`	`getBoldLineSeparator()` Getter for the String representing the bold line separator.
`int`	`getNbColumns()` Getter for the number of columns in the table.
`String`	`getStandardLineSeparator()` Getter for the String representing the standard line separator.
`StringTablePrinter.StringAlign`	`getStringAlign()` Getter for the text alignment mode.
`String`	`getVerticalLeftSeparator()` Getter for the String representing the vertical separator of the left column.
`String`	`getVerticalRightSeparator()` Getter for the String representing the vertical separator of the right column.
`String`	`getVerticalSeparator()` Getter for the String representing the vertical separator of the middle columns.
`static String`	`printDouble(double value, String fmt)` Print a double as a String in the provided format.
`void`	`setBoldLineSeparator(String boldLineSeparator)` Setter for the String representing the bold line separator.
`void`	`setStandardLineSeparator(String standardLineSeparator)` Setter for the String representing the standard line separator.
`void`	`setStringAlign(StringTablePrinter.StringAlign stringAlign)` Setter for the text alignment mode (`RIGHT` by default).
`void`	`setTitle(String title)` Optionally, add a centered title (will be displayed before the header).
`void`	`setVerticalLeftSeparator(String verticalLeftSeparator)` Setter for the String representing the vertical separator of the left column.
`void`	`setVerticalRightSeparator(String verticalRightSeparator)` Setter for the String representing the vertical separator of the right column.
`void`	`setVerticalSeparator(String verticalSeparator)` Setter for the String representing the vertical separator of the middle columns.
`void`	`switchLastLineBold()` Change the last table line into a line full of bold separators.
`String`	`toString()` Return a string representation of the formatted table.
`String`	`toString(int indentation)` Return a string representation of the formatted table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_BOLD_LINE_SEPARATOR
```
public static final String DEFAULT_BOLD_LINE_SEPARATOR
```
    The default String representing the bold line separator.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STANDARD_LINE_SEPARATOR
```
public static final String DEFAULT_STANDARD_LINE_SEPARATOR
```
    The default String representing the standard line separator.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VERTICAL_SEPARATOR
```
public static final String DEFAULT_VERTICAL_SEPARATOR
```
    The default String representing the vertical separator of the middle columns.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LEFT_VERTICAL_SEPARATOR
```
public static final String DEFAULT_LEFT_VERTICAL_SEPARATOR
```
    The default String representing the vertical separator of the left column.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RIGHT_VERTICAL_SEPARATOR
```
public static final String DEFAULT_RIGHT_VERTICAL_SEPARATOR
```
    The default String representing the vertical separator of the right column.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StringTablePrinter
```
public StringTablePrinter(String[] header)
```
    Constructor to initialize the header.
    Note: the header dimension constrains the table dimension. The values added later must be compatible with this dimension.
    
    Parameters:
    
    header - The header describing each column information
  - StringTablePrinter
```
public StringTablePrinter(String title,
                          String[] header)
```
    Constructor to initialize the header and add a centered title to the table.
    Note: the header dimension constrains the table dimension. The values added later must be compatible with this dimension.
    
    Parameters:
    
    title - Centered table title (null if not initialized)
    
    header - The header describing each column information
    
    Throws:
    
    NullArgumentException - if header is null
    
    IllegalArgumentException - the header doesn't describe at least one column (size can't be 0)
- Method Detail
  - addLine
```
public void addLine(String[] line)
```
    Add a line to the table.
    Note: the given array must have the same size as the header used in the constructor (see getNbColumns() ).
    
    Parameters:
    
    line - The array describing each column value of the new line
    
    Throws:
    
    IllegalArgumentException - if the provided array does not have the same dimension than the header
  - addLine
```
public void addLine(double[] values,
                    String fmt)
```
    Add the values as a line to the table.
    
    Parameters:
    
    values - The array describing each column value of the new line
    
    fmt - The format used to convert the double values into String
    
    Throws:
    
    IllegalArgumentException - if the provided array does not have the same dimension than the header
  - addLine
```
public void addLine(String leftColumn,
                    double[] values,
                    String fmt)
```
    Add the values as a line to the table.
    The first column is described by a String.
    
    Parameters:
    
    leftColumn - The first column of the line represented by a String
    
    values - The other columns of the line represented by double values (must have the same dimension as the header minus one, as the left column is not described by this array)
    
    fmt - The format used to convert the double values into String
    
    Throws:
    
    IllegalArgumentException - if the provided array dimension is not compatible with the header (values.length + 1 =! getNbColumns())
  - setTitle
```
public void setTitle(String title)
```
    Optionally, add a centered title (will be displayed before the header).
    Note: the title's length must be shorter than the total table width minus the left and right columns separator lengths.
    
    Parameters:
    
    title - Centered table (null to disable)
  - addBoldLineSeparator
```
public void addBoldLineSeparator()
```
    Add a line full of bold separators.
  - switchLastLineBold
```
public void switchLastLineBold()
```
    Change the last table line into a line full of bold separators.
    This method can be useful when the table is built with several standard lines separator depending on conditions and we still want to use a bold line at the end of the table.
  - addStandardLineSeparator
```
public void addStandardLineSeparator()
```
    Add a line full of standard separators.
  - clear
```
public void clear()
```
    Clear the title and the table (the header remains).
  - toString
```
public String toString()
```
    Return a string representation of the formatted table.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the formatted table
  - toString
```
public String toString(int indentation)
```
    Return a string representation of the formatted table.
    
    Parameters:
    
    indentation - Indent the array of N spaces
    
    Returns:
    
    a string representation of the formatted table
    
    Throws:
    
    NotPositiveException - if indentation < 0
  - getStringAlign
```
public StringTablePrinter.StringAlign getStringAlign()
```
    Getter for the text alignment mode.
    
    Returns:
    
    the text alignment mode
  - setStringAlign
```
public void setStringAlign(StringTablePrinter.StringAlign stringAlign)
```
    Setter for the text alignment mode (RIGHT by default).
    
    Parameters:
    
    stringAlign - Text alignment mode to set
  - getBoldLineSeparator
```
public String getBoldLineSeparator()
```
    Getter for the String representing the bold line separator.
    
    Returns:
    
    the String representing the bold line separator
  - setBoldLineSeparator
```
public void setBoldLineSeparator(String boldLineSeparator)
```
    Setter for the String representing the bold line separator.
    
    Parameters:
    
    boldLineSeparator - String representing the bold line separator to set
  - getStandardLineSeparator
```
public String getStandardLineSeparator()
```
    Getter for the String representing the standard line separator.
    
    Returns:
    
    the String representing the standard line separator
  - setStandardLineSeparator
```
public void setStandardLineSeparator(String standardLineSeparator)
```
    Setter for the String representing the standard line separator.
    
    Parameters:
    
    standardLineSeparator - String representing the standard line separator to set
  - getVerticalSeparator
```
public String getVerticalSeparator()
```
    Getter for the String representing the vertical separator of the middle columns.
    
    Returns:
    
    the String representing the vertical separator of the middle columns
  - setVerticalSeparator
```
public void setVerticalSeparator(String verticalSeparator)
```
    Setter for the String representing the vertical separator of the middle columns.
    
    Parameters:
    
    verticalSeparator - String representing the vertical separator of the middle columns to set
  - getVerticalLeftSeparator
```
public String getVerticalLeftSeparator()
```
    Getter for the String representing the vertical separator of the left column.
    
    Returns:
    
    the String representing the vertical separator of the left column
  - setVerticalLeftSeparator
```
public void setVerticalLeftSeparator(String verticalLeftSeparator)
```
    Setter for the String representing the vertical separator of the left column.
    
    Parameters:
    
    verticalLeftSeparator - String representing the vertical separator of the left column to set
  - getVerticalRightSeparator
```
public String getVerticalRightSeparator()
```
    Getter for the String representing the vertical separator of the right column.
    
    Returns:
    
    the String representing the vertical separator of the right column
  - setVerticalRightSeparator
```
public void setVerticalRightSeparator(String verticalRightSeparator)
```
    Setter for the String representing the vertical separator of the right column.
    
    Parameters:
    
    verticalRightSeparator - String representing the vertical separator of the right column to set
  - getNbColumns
```
public int getNbColumns()
```
    Getter for the number of columns in the table.
    
    Returns:
    
    the number of columns in the table
  - printDouble
```
public static String printDouble(double value,
                                 String fmt)
```
    Print a double as a String in the provided format.
    
    Parameters:
    
    value - Value to print
    
    fmt - The format used to convert the double values into String
    
    Returns:
    
    the printed value

Class StringTablePrinter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_BOLD_LINE_SEPARATOR

DEFAULT_STANDARD_LINE_SEPARATOR

DEFAULT_VERTICAL_SEPARATOR

DEFAULT_LEFT_VERTICAL_SEPARATOR

DEFAULT_RIGHT_VERTICAL_SEPARATOR

Constructor Detail

StringTablePrinter

StringTablePrinter

Method Detail

addLine

addLine

addLine

setTitle

addBoldLineSeparator

switchLastLineBold

addStandardLineSeparator

clear

toString

toString

getStringAlign

setStringAlign

getBoldLineSeparator

setBoldLineSeparator

getStandardLineSeparator

setStandardLineSeparator

getVerticalSeparator

setVerticalSeparator

getVerticalLeftSeparator

setVerticalLeftSeparator

getVerticalRightSeparator

setVerticalRightSeparator

getNbColumns

printDouble