Module org.refcodes.tabular

Package org.refcodes.tabular

Class FormattedHeader<T>

java.lang.Object

java.util.AbstractCollection<FormattedColumn<? extends T>>

java.util.AbstractList<FormattedColumn<? extends T>>

java.util.ArrayList<FormattedColumn<? extends T>>

org.refcodes.tabular.AbstractHeader<T,FormattedColumn<? extends T>>

org.refcodes.tabular.FormattedHeader<T>

Type Parameters:

T - The type managed by the FormattedHeader.

All Implemented Interfaces:

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

public class FormattedHeader<T>
extends AbstractHeader<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 AbstractHeader.keySet() method must provide a predictable order as ensured by the LinkedHashSet class as of the ordered nature of the FormattedHeader.

See Also:

• Serialized Form

Nested Class Summary

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

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

Field Summary

Fields inherited from class org.refcodes.tabular.AbstractHeader

_keys

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
FormattedHeader()	Instantiates a new formatted header impl.
FormattedHeader(FormattedColumn<? extends T>... aHeader)	Instantiates a new formatted header impl.

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.
FormattedHeader<T>	withResetEscapeCode(String aEscapeCode)	Sets the ANSI reset Escape-Code for this FormattedHeader instance as of the Builder-Pattern.

Methods inherited from class org.refcodes.tabular.AbstractHeader

add, add, containsKey, delete, fromStorageString, fromStorageString, fromStorageStringRecord, fromStorageStringRow, fromStorageStrings, fromStorageStrings, fromStorageStringsRecord, fromStorageStringsRow, get, indexOf, keySet, toPrintable, toPrintable, toPrintableRecord, toPrintableRow, toRecord, toRecordIgnoreType, toRow, toRowIgnoreType, toStorageString, toStorageString, toStorageStringRecord, toStorageStringRow, toStorageStrings, toStorageStrings, toStorageStringsRecord, toStorageStringsRow, toString, values

Methods inherited from class java.util.ArrayList

addAll, addAll, addFirst, addLast, clear, clone, contains, ensureCapacity, equals, forEach, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeIf, removeLast, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractCollection

containsAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

toRecord

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.refcodes.struct.Keys

getOr, use

Methods inherited from interface java.util.List

addAll, addAll, addFirst, addLast, clear, contains, containsAll, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, sort, spliterator, subList, toArray, toArray

Constructor Details

FormattedHeader

public FormattedHeader()

Instantiates a new formatted header impl.

FormattedHeader

public FormattedHeader(FormattedColumn<? extends T>... aHeader)

Instantiates a new formatted header impl.

Parameters:

aHeader - the header

Method Details

getResetEscapeCode

public 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

public 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

public 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.