Package xyz.jpenilla.squaremap.api

Class SimpleLayerProvider.Builder

java.lang.Object

xyz.jpenilla.squaremap.api.SimpleLayerProvider.Builder

Enclosing class:

SimpleLayerProvider

public static final class SimpleLayerProvider.Builder
extends Object

Builder for SimpleLayerProvider

Method Summary

Modifier and Type	Method	Description
@NonNull SimpleLayerProvider	build()	Build a SimpleLayerProvider instance from the current state of this builder
@NonNull SimpleLayerProvider.Builder	defaultHidden(boolean defaultHidden)	Set whether this layer is hidden by default
@NonNull SimpleLayerProvider.Builder	layerPriority(int layerPriority)	Set the priority for this layer
@NonNull SimpleLayerProvider.Builder	showControls(boolean showControls)	Set whether to show controls for this layer
@NonNull SimpleLayerProvider.Builder	zIndex(int zIndex)	Set the z-index for this layer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

defaultHidden

public @NonNull SimpleLayerProvider.Builder defaultHidden(boolean defaultHidden)

Set whether this layer is hidden by default

Default: false

Parameters:

defaultHidden - whether to be default hidden

Returns:

this builder

See Also:

• LayerProvider.defaultHidden()

showControls

public @NonNull SimpleLayerProvider.Builder showControls(boolean showControls)

Set whether to show controls for this layer

Default: true

Parameters:

showControls - whether to show controls

Returns:

this builder

See Also:

• LayerProvider.showControls()

layerPriority

public @NonNull SimpleLayerProvider.Builder layerPriority(int layerPriority)

Set the priority for this layer

Default: 99

Parameters:

layerPriority - layer priority

Returns:

this builder

See Also:

• LayerProvider.layerPriority()

zIndex

public @NonNull SimpleLayerProvider.Builder zIndex(int zIndex)

Set the z-index for this layer

Default: 99

Parameters:

zIndex - new z-index

Returns:

this builder

See Also:

• LayerProvider.zIndex()

build

public @NonNull SimpleLayerProvider build()

Build a SimpleLayerProvider instance from the current state of this builder

Returns:

the built instance