Module org.refcodes.tabular

Package org.refcodes.tabular

Interface FormattedHeader<T>

Type Parameters:

T - The type managed by the FormattedHeader.

All Superinterfaces:

org.refcodes.mixin.Clearable, Collection<FormattedColumn<? extends T>>, ColumnRow<T,FormattedColumn<? extends T>>, HeaderRow<T,FormattedColumn<? extends T>>, Iterable<FormattedColumn<? extends T>>, org.refcodes.struct.Keys<String,FormattedColumn<? extends T>>, org.refcodes.struct.Keys.MutableKeys<String,FormattedColumn<? extends T>>, List<FormattedColumn<? extends T>>

All Known Implementing Classes:

FormattedHeaderImpl

public interface FormattedHeader<T>
extends HeaderRow<T,FormattedColumn<? extends T>>

A list of Column instances, for example describing the elements of a CSV file (visually speaking the of the CSV file's header line), is represented by the FormattedHeader. The FormattedHeader preserves an order for a list of Column instances. A FormattedHeader provides the semantics for related Row instances.

The Keys.keySet() method must provide a predictable order as ensured by the LinkedHashSet class as of the ordered nature of the FormattedHeader.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.struct.Keys

org.refcodes.struct.Keys.MutableKeys<K extends Object,V extends Object>, org.refcodes.struct.Keys.MutableValues<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
String	getResetEscapeCode()	Gets the ANSI reset Escape-Code for this FormattedHeader instance.
void	setResetEscapeCode(String aEscapeCode)	Gets the ANSI reset Escape-Code for this FormattedHeader instance.
default FormattedHeader<T>	withResetEscapeCode(String aEscapeCode)	Sets the ANSI reset Escape-Code for this FormattedHeader instance as of the Builder-Pattern.

Methods inherited from interface org.refcodes.mixin.Clearable

clear

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.refcodes.tabular.ColumnRow

containsValue, withColumns

Methods inherited from interface org.refcodes.tabular.HeaderRow

fromStorageString, fromStorageString, fromStorageStringRecord, fromStorageStringRow, fromStorageStrings, fromStorageStrings, fromStorageStringsRecord, fromStorageStringsRow, indexOf, toPrintable, toPrintable, toPrintableRecord, toPrintableRow, toRecord, toRecordIgnoreType, toRow, toRowIgnoreType, toStorageString, toStorageString, toStorageStringRecord, toStorageStringRow, toStorageStrings, toStorageStrings, toStorageStringsRecord, toStorageStringsRow

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.refcodes.struct.Keys

containsKey, get, getOr, keySet, use, values

Methods inherited from interface org.refcodes.struct.Keys.MutableKeys

delete

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Details

getResetEscapeCode

String getResetEscapeCode()

Gets the ANSI reset Escape-Code for this FormattedHeader instance. In case an ANSI Escape-Codes is set, then this ANSI Reset-Code is prepended to the according text being printed.

Returns:

The String to be used for resetting ANSI escaping.

setResetEscapeCode

void setResetEscapeCode(String aEscapeCode)

Gets the ANSI reset Escape-Code for this FormattedHeader instance. In case an ANSI Escape-Codes is set, then this ANSI Reset-Code is prepended to the according text being printed.

Parameters:

aEscapeCode - The String to be used for resetting ANSI escaping.

withResetEscapeCode

default FormattedHeader<T> withResetEscapeCode(String aEscapeCode)

Sets the ANSI reset Escape-Code for this FormattedHeader instance as of the Builder-Pattern. In case an ANSI Escape-Codes is set, then this ANSI Reset-Code is prepended to the according text being printed.

Parameters:

aEscapeCode - The String to be used for resetting ANSI escaping.

Returns:

This FormattedHeader instance to continue configuration.