Package com.luciad.layers.grids.lonlat

Class LonLatGridLayer.Builder

java.lang.Object

com.luciad.layers.grids.lonlat.LonLatGridLayer.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

LonLatGridLayer

public static final class LonLatGridLayer.Builder
extends Object
implements AutoCloseable

Builder for creating a LonLatGridLayer.

Configuration on how to display the LonLat grid is done using a LonLatGrid which can be created using a LonLatGrid.Builder.

Since:

2023.1

Constructor Summary

Constructors

Constructor	Description
Builder(LonLatGridLayer.Builder other)

Method Summary

Modifier and Type	Method	Description
LonLatGridLayer	build()	Returns the LonLat layer.
void	close()
protected void	finalize()
LonLatGridLayer.Builder	grid(LonLatGrid grid)	Sets the LonLat grid settings.
LonLatGridLayer.Builder	labeled(boolean labeled)	Sets whether the layer should display labels initially.
LonLatGridLayer.Builder	title(String title)	Sets the title to use for the layer.
LonLatGridLayer.Builder	visible(boolean visible)	Sets whether the layer should be visible initially.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 LonLatGridLayer.Builder other)

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

build

@NotNull
public LonLatGridLayer build()
                      throws IllegalStateException

Returns the LonLat layer.

Returns:

a layer, based on the properties set on this builder.

Throws:

IllegalStateException - If not all mandatory parameters are set.

title

@NotNull
public LonLatGridLayer.Builder title(@NotNull
 String title)

Sets the title to use for the layer.

If not set, the title defaults to 'LonLat'.

Parameters:

title - the title for the layer.

Returns:

this builder.

visible

@NotNull
public LonLatGridLayer.Builder visible(boolean visible)

Sets whether the layer should be visible initially.

Default is true.

Parameters:

visible - the visibility.

Returns:

this builder.

labeled

@NotNull
public LonLatGridLayer.Builder labeled(boolean labeled)

Sets whether the layer should display labels initially.

Default is true.

Parameters:

labeled - whether the layer should display labels initially.

Returns:

this builder.

grid

@NotNull
public LonLatGridLayer.Builder grid(@NotNull
 LonLatGrid grid)

Sets the LonLat grid settings.

Parameters:

grid - the LonLat grid settings.

Returns:

this builder.