TilePreviewData

public final class TilePreviewData

Container class storing callbacks required to render previews for methods annotated with Preview.

See also
singleTimelineEntryTileBuilder

Summary

Public constructors

Public methods
boolean
equals(Object other)
final @NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile>

callback that provides the TileBuilders.Tile to be previewed.
final @NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources>

callback that provides a Resources.
int
@NonNull String

Public constructors

TilePreviewData

Added in 1.3.0
public TilePreviewData(
    @NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> onTileResourceRequest,
    @NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> onTileRequest
)
Parameters
@NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> onTileResourceRequest

callback that provides a Resources. It will be called before rendering the preview of the TileBuilders.Tile. By default, this callback will return a Resources with the version "0".
@NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> onTileRequest

callback that provides the TileBuilders.Tile to be previewed. It will be called before rendering the preview.

Public methods

equals

public boolean equals(Object other)

getOnTileRequest

Added in 1.3.0
public final @NonNull Function1<@NonNull RequestBuilders.TileRequest, @NonNull TileBuilders.Tile> getOnTileRequest()

callback that provides the TileBuilders.Tile to be previewed. It will be called before rendering the preview.

getOnTileResourceRequest

Added in 1.3.0
public final @NonNull Function1<@NonNull RequestBuilders.ResourcesRequest, @NonNull ResourceBuilders.Resources> getOnTileResourceRequest()

callback that provides a Resources. It will be called before rendering the preview of the TileBuilders.Tile. By default, this callback will return a Resources with the version "0".

hashCode

public int hashCode()

toString

public @NonNull String toString()