io.jenkins.plugins.datatables.api

Class TableModel.ColumnDefinitionBuilder

java.lang.Object

io.jenkins.plugins.datatables.api.TableModel.ColumnDefinitionBuilder

Enclosing class:

TableModel

public static class TableModel.ColumnDefinitionBuilder
extends Object

A JQuery DataTables column definition builder. Provides simple columns that extract a given entity property as column value or complex columns that provide different properties to sort and display a column.

Constructor Summary

Constructors

Constructor and Description
ColumnDefinitionBuilder()

Method Summary

Modifier and Type	Method and Description
TableModel.ColumnDefinitionBuilder	add(String dataPropertyName) Adds a new simple column that maps the specified property of the row entity to the column value.
TableModel.ColumnDefinitionBuilder	add(String dataPropertyName, String columnDataType) Adds a new complex column that maps the specified property of the row entity to the display and sort attributes of the column.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnDefinitionBuilder

public ColumnDefinitionBuilder()

Method Detail

add

public TableModel.ColumnDefinitionBuilder add(String dataPropertyName)

Adds a new simple column that maps the specified property of the row entity to the column value.

Parameters:

dataPropertyName - the property to extract from the entity, it will be shown as column value

Returns:

this

add

public TableModel.ColumnDefinitionBuilder add(String dataPropertyName,
                                              String columnDataType)

Adds a new complex column that maps the specified property of the row entity to the display and sort attributes of the column. The property dataPropertyName must be of type TableModel.DetailedColumnDefinition.

Parameters:

dataPropertyName - the property to extract from the entity, it will be shown as column value

columnDataType - JQuery DataTables data type of the column

Returns:

this

See Also:

TableModel.DetailedColumnDefinition

toString

public String toString()

Overrides:

toString in class Object