io.github.swagger2markup.markup.builder

Class MarkupTableColumn

java.lang.Object

io.github.swagger2markup.markup.builder.MarkupTableColumn

public class MarkupTableColumn
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	header
boolean	headerColumn
java.util.Map<MarkupLanguage,java.lang.String>	markupSpecifiers
java.lang.Integer	widthRatio

Constructor Summary

Constructors

Constructor and Description
MarkupTableColumn() Empty constructor
MarkupTableColumn(java.lang.String header) Header constructor.
MarkupTableColumn(java.lang.String header, boolean headerColumn, java.lang.Integer widthRatio) Header and specifiers constructor.

Method Summary

Modifier and Type	Method and Description
MarkupTableColumn	withHeader(java.lang.String header) Set header name for this column.
MarkupTableColumn	withHeaderColumn(boolean headerColumn) Set column as an header column.
MarkupTableColumn	withMarkupSpecifiers(MarkupLanguage language, java.lang.String specifiers) Overrides all other specifiers for the specified language with this language-dependent specifiers string.
MarkupTableColumn	withWidthRatio(java.lang.Integer widthRatio) Set column width ratio for this column.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

header

public java.lang.String header

headerColumn

public boolean headerColumn

widthRatio

public java.lang.Integer widthRatio

markupSpecifiers

public java.util.Map<MarkupLanguage,java.lang.String> markupSpecifiers

Constructor Detail

MarkupTableColumn

public MarkupTableColumn()

Empty constructor

MarkupTableColumn

public MarkupTableColumn(java.lang.String header)

Header constructor.

Parameters:

header - header name

MarkupTableColumn

public MarkupTableColumn(java.lang.String header,
                         boolean headerColumn,
                         java.lang.Integer widthRatio)

Header and specifiers constructor.

Parameters:

header - header

headerColumn - set column as an header column.

widthRatio - width ratio

Method Detail

withHeader

public MarkupTableColumn withHeader(java.lang.String header)

Set header name for this column.

Parameters:

header - header name

Returns:

this builder

withHeaderColumn

public MarkupTableColumn withHeaderColumn(boolean headerColumn)

Set column as an header column.
Limited support : Markdown does not support header column and will ignore it.

Parameters:

headerColumn - configuration value

Returns:

this builder

withWidthRatio

public MarkupTableColumn withWidthRatio(java.lang.Integer widthRatio)

Set column width ratio for this column.
Limited support : Markdown does not support column width specifiers and will ignore widthRatio.

Parameters:

widthRatio - width ratio integer value [0-100]. Accept relative width specifiers (e.g.: 1, 2, 3, .. with sum of width ratios for all columns != 100).

Returns:

this builder

withMarkupSpecifiers

public MarkupTableColumn withMarkupSpecifiers(MarkupLanguage language,
                                              java.lang.String specifiers)

Overrides all other specifiers for the specified language with this language-dependent specifiers string.
This method should be used as a last resort.

Parameters:

language - apply the specifiers to this language only

specifiers - RAW language-dependent specifiers string for the column

Returns:

this builder