TerminalSeparatorType

enum TerminalSeparatorType


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 PagingSource and RemoteMediator reaches the end of pagination.

SOURCE_COMPLETE

Show terminal separators (header and footer) as soon as PagingSource reaches the end of pagination, regardless of RemoteMediator's state.

Public fields

final @NonNull String
final int

Enum Values

FULLY_COMPLETE

@NonNull
@NonNull 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

@NonNull
@NonNull 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 fields

name

@NonNull
public final @NonNull String name

ordinal

@NonNull
public final int ordinal