Package com.luciad.create

Class Creator.Builder

java.lang.Object

com.luciad.create.Creator.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

Creator

public static final class Creator.Builder
extends Object
implements AutoCloseable

Builder for the Creator class.

Constructor Summary

Constructors

Constructor	Description
Builder(Creator.Builder other)

Method Summary

Modifier and Type	Method	Description
Creator	build()	Returns a new creator, based on the properties set on this builder.
void	close()
Creator.Builder	featureCreator(IFeatureCreator featureCreator)	Sets the creator that will create a feature instance.
protected void	finalize()
Creator.Builder	layer(Layer layer)	Sets the layer to which new features will be added.
Creator.Builder	map(Map map)	Sets the map on which features are created.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 Creator.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 Creator build()
              throws IllegalStateException

Returns a new creator, based on the properties set on this builder.

Returns:

a new creator.

Throws:

IllegalStateException - if not all mandatory parameters are set

map

@NotNull
public Creator.Builder map(@NotNull
 Map map)
                    throws NullPointerException

Sets the map on which features are created.

This parameter is mandatory. If it is not set, Creator.Builder#build will throw an exception.

Parameters:

map - the Map on which to add features

Returns:

this builder

Throws:

NullPointerException - when the map is null.

layer

@NotNull
public Creator.Builder layer(@NotNull
 Layer layer)
                      throws NullPointerException,
IllegalArgumentException

Sets the layer to which new features will be added.

Calling this method is mandatory. If it is not set, Creator.Builder#build will throw an exception.

This method will thrown an exception when it contains a model without IFeatureModelUpdater.

Parameters:

layer - the layer to which new features need to be added.

Returns:

this builder

Throws:

NullPointerException - when the layer is null.

IllegalArgumentException - when the layer is not a FeatureLayer.

featureCreator

@NotNull
public Creator.Builder featureCreator(@NotNull
 IFeatureCreator featureCreator)
                               throws NullPointerException

Sets the creator that will create a feature instance.

Parameters:

featureCreator - the creator that will create a feature instance

Returns:

this builder

Throws:

NullPointerException - when the feature creator is null.