TerminalSeparatorType
public enum TerminalSeparatorType extends Enum
Mode for configuring when terminal separators (header and footer) would be displayed by the insertSeparators, insertHeaderItem or insertFooterItem operators on PagingData.
Summary
Enum Values |
|
|---|---|
FULLY_COMPLETE |
Show terminal separators (header and footer) when both |
SOURCE_COMPLETE |
Show terminal separators (header and footer) as soon as |
Public methods |
|
|---|---|
final @NonNull EnumEntries<@NonNull TerminalSeparatorType> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
final @NonNull TerminalSeparatorType |
Returns the enum constant of this type with the specified name. |
final @NonNull TerminalSeparatorType[] |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Enum Values
FULLY_COMPLETE
TerminalSeparatorType TerminalSeparatorType.FULLY_COMPLETE
Show terminal separators (header and footer) when both PagingSource and RemoteMediator reaches the end of pagination.
End of paginations occurs when CombinedLoadStates has set LoadState.endOfPaginationReached to true for both CombinedLoadStates.source and CombinedLoadStates.mediator in the PREPEND direction for the header and in the APPEND direction for the footer.
In cases where RemoteMediator isn't used, only CombinedLoadStates.source will be considered.
SOURCE_COMPLETE
TerminalSeparatorType TerminalSeparatorType.SOURCE_COMPLETE
Show terminal separators (header and footer) as soon as PagingSource reaches the end of pagination, regardless of RemoteMediator's state.
End of paginations occurs when CombinedLoadStates has set LoadState.endOfPaginationReached to true for CombinedLoadStates.source in the PREPEND direction for the header and in the APPEND direction for the footer.
Public methods
getEntries
public final @NonNull EnumEntries<@NonNull TerminalSeparatorType> getEntries()
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.
valueOf
public final @NonNull TerminalSeparatorType valueOf(@NonNull String value)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |