Class RowedFormatter.Builder<T>

java.lang.Object

eu.cloudnetservice.utils.base.column.RowedFormatter.Builder<T>

Type Parameters:

T - the type of elements that will be handled by the new formatter.

Enclosing class:

RowedFormatter<T>

public static final class RowedFormatter.Builder<T>
extends Object

A builder that can be used to construct a new row based formatter.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private List<Function<T,Object>>	columns
private ColumnFormatter	defaultFormatter

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
@NonNull RowedFormatter<T>	build()	Builds a new row based formatter from this builder.
@NonNull RowedFormatter.Builder<T>	column(@NonNull Function<T,Object> converter)	Sets the extractor function for the next column.
@NonNull RowedFormatter.Builder<T>	columns(@NonNull List<Function<T,Object>> columns)	Sets the extractor functions for all columns.
@NonNull RowedFormatter.Builder<T>	defaultFormatter(@NonNull ColumnFormatter defaultFormatter)	Sets the default formatter for the columns.

Methods inherited from class Object

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

Field Details

defaultFormatter

private ColumnFormatter defaultFormatter

columns

private List<Function<T,Object>> columns

Constructor Details

Builder

public Builder()

Method Details

defaultFormatter

@Contract(value="_ -> this",
          pure=true)
@NonNull
public @NonNull RowedFormatter.Builder<T> defaultFormatter(@NonNull
 @NonNull ColumnFormatter defaultFormatter)

Sets the default formatter for the columns.

Parameters:

defaultFormatter - the default formatter to use.

Returns:

the same builder instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given column formatter is null.

columns

@Contract(value="_ -> this",
          pure=true)
@NonNull
public @NonNull RowedFormatter.Builder<T> columns(@NonNull
 @NonNull List<Function<T,Object>> columns)

Sets the extractor functions for all columns. This method copies the list into this builder, meaning that changes made to the given list are not reflected into this builder.

Parameters:

columns - the extractor functions for all columns, in order.

Returns:

the same builder instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given column extractor function list is null.

column

@Contract(value="_ -> this",
          pure=true)
@NonNull
public @NonNull RowedFormatter.Builder<T> column(@NonNull
 @NonNull Function<T,Object> converter)

Sets the extractor function for the next column.

Parameters:

converter - the converter for the next column.

Returns:

the same builder instance as used to call the method, for chaining.

Throws:

NullPointerException - if the given column extractor function is null.

build

@NonNull
public @NonNull RowedFormatter<T> build()

Builds a new row based formatter from this builder. Further changes to this builder do not reflect into the returned formatter.

Returns:

a new rowed formatter based on this builder.

Throws:

NullPointerException - if the given default formatter is null.

IllegalArgumentException - if there are no column extractor function are given.