Package org.refcodes.tabular
Interface FormattedHeader<T>
-
- Type Parameters:
T
- The type managed by theFormattedHeader
.
- All Superinterfaces:
org.refcodes.structure.Clearable
,java.util.Collection<T>
,ColumnRow<T,C>
,HeaderRow<T,FormattedColumn<? extends T>>
,java.lang.Iterable<T>
,org.refcodes.structure.Keys<T,C>
,org.refcodes.structure.Keys.MutableKeys<T,C>
,java.util.List<T>
- All Known Implementing Classes:
FormattedHeaderImpl
public interface FormattedHeader<T> extends HeaderRow<T,FormattedColumn<? extends T>>
A list ofColumn
instances, for example describing the elements of a CSV file (visually speaking the of the CSV file's header line), is represented by theFormattedHeader
. TheFormattedHeader
preserves an order for a list ofColumn
instances. AFormattedHeader
provides the semantics for relatedRow
instances.The
Keys.keySet()
method must provide a predictable order as ensured by theLinkedHashSet
class as of the ordered nature of theFormattedHeader
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.String
getResetEscapeCode()
Gets the ANSI reset Escape-Code for thisFormattedHeader
instance.void
setResetEscapeCode(java.lang.String aEscapeCode)
Gets the ANSI reset Escape-Code for thisFormattedHeader
instance.default FormattedHeader<T>
withResetEscapeCode(java.lang.String aEscapeCode)
Sets the ANSI reset Escape-Code for thisFormattedHeader
instance as of the Builder-Pattern.-
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.util.List
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, of, of, of, of, of, of, of, of, of, of, of, of, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray
-
-
-
-
Method Detail
-
getResetEscapeCode
java.lang.String getResetEscapeCode()
Gets the ANSI reset Escape-Code for thisFormattedHeader
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(java.lang.String aEscapeCode)
Gets the ANSI reset Escape-Code for thisFormattedHeader
instance. In case an ANSI Escape-Codes is set, then this ANSI Reset-Code is prepended to the according text being printed.- Parameters:
aEscapeCode
- TheString
to be used for resetting ANSI escaping.
-
withResetEscapeCode
default FormattedHeader<T> withResetEscapeCode(java.lang.String aEscapeCode)
Sets the ANSI reset Escape-Code for thisFormattedHeader
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
- TheString
to be used for resetting ANSI escaping.- Returns:
- This
FormattedHeader
instance to continue configuration.
-
-