Package net.pl3x.map.core.markers.layer

Class SimpleLayer

java.lang.Object

net.pl3x.map.core.Keyed

net.pl3x.map.core.markers.layer.Layer

net.pl3x.map.core.markers.layer.SimpleLayer

All Implemented Interfaces:

JsonSerializable

Direct Known Subclasses:

WorldLayer

public class SimpleLayer
extends Layer

Represents a simple layer of markers and other metadata.

Constructor Summary

Constructors

Constructor	Description
SimpleLayer(@NotNull String key, @NotNull Supplier<@NotNull String> labelSupplier)	Create a new simple layer.

Method Summary

Modifier and Type	Method	Description
@NotNull SimpleLayer	addMarker(@NotNull Marker<?> marker)	Add a new marker to this layer.
@NotNull SimpleLayer	clearMarkers()	Remove all registered markers
@NotNull Collection<@NotNull Marker<?>>	getMarkers()	Get the markers to display in this Layer.
boolean	hasMarker(@NotNull String key)	Check whether a marker is registered for a key.
@NotNull Map<@NotNull String,@NotNull Marker<?>>	registeredMarkers()	Get an unmodifiable view of the registered markers.
@Nullable Marker<?>	removeMarker(@NotNull String key)	Remove a marker from this layer, returning either the removed marker, or null if no marker was present for the provided key.

Methods inherited from class net.pl3x.map.core.markers.layer.Layer

equals, getCss, getLabel, getPane, getPriority, getUpdateInterval, getUpdateInterval, getZIndex, hashCode, isDefaultHidden, isLiveUpdate, setCss, setDefaultHidden, setLabel, setLabel, setLiveUpdate, setPane, setPriority, setShowControls, setUpdateInterval, setUpdateInterval, setZIndex, shouldShowControls, toJson, toString

Methods inherited from class net.pl3x.map.core.Keyed

getKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SimpleLayer

public SimpleLayer(@NotNull
 @NotNull String key,
 @NotNull
 @NotNull Supplier<@NotNull String> labelSupplier)

Create a new simple layer.

Parameters:

key - key for layer

Method Details

getMarkers

@NotNull
public @NotNull Collection<@NotNull Marker<?>> getMarkers()

Description copied from class: Layer

Get the markers to display in this Layer.

Specified by:

getMarkers in class Layer

Returns:

markers to display

addMarker

@NotNull
public @NotNull SimpleLayer addMarker(@NotNull
 @NotNull Marker<?> marker)

Add a new marker to this layer.

Parameters:

marker - marker

Returns:

this layer

removeMarker

@Nullable
public @Nullable Marker<?> removeMarker(@NotNull
 @NotNull String key)

Remove a marker from this layer, returning either the removed marker, or null if no marker was present for the provided key.

Parameters:

key - key

Returns:

the existing marker or null

clearMarkers

@NotNull
public @NotNull SimpleLayer clearMarkers()

Remove all registered markers

registeredMarkers

@NotNull
public @NotNull Map<@NotNull String,@NotNull Marker<?>> registeredMarkers()

Get an unmodifiable view of the registered markers.

Returns:

registered markers

hasMarker

public boolean hasMarker(@NotNull
 @NotNull String key)

Check whether a marker is registered for a key.

Parameters:

key - key

Returns:

true if marker is registered