Package com.luciad.models.features

Class FeatureModelUpdate.Builder

java.lang.Object
com.luciad.models.features.FeatureModelUpdate.Builder
All Implemented Interfaces:
AutoCloseable
Enclosing class:
FeatureModelUpdate
public static final class FeatureModelUpdate.Builder extends Object implements AutoCloseable
Builder that allows FeatureModelUpdate instances to be created.

  • Constructor Details

  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable

    • build

      @NotNull public FeatureModelUpdate build() throws IllegalStateException
      Build the FeatureModelUpdate instance.
      Returns:
      the feature model update.
      Throws:
      IllegalStateException - If no changes were configured.

    • updaterCallback

      @NotNull public FeatureModelUpdate.Builder updaterCallback(@Nullable IFeatureUpdaterCallback updaterCallback)
      Sets the callback that must be called by IFeatureModelUpdater#update to inform that this update was successful or not, or to notify that features were added.

      This method is optional. If it's not set, a default callback which logs failures is used.

      Parameters:
      updaterCallback - the updater callback
      Returns:
      this builder

    • addFeature

      @NotNull public FeatureModelUpdate.Builder addFeature(@NotNull Feature newFeature)
      Adds the given Feature to the model.

      This Feature may not have an id yet. In that case, IFeatureModelUpdater#update is responsible for assigning an id to the feature when adding it to the model. In general, callers of this method can not assign id's to Features.

      There are a few exceptions though. Passing an id with Feature can for example be useful for in-memory models like FeatureModelBuilder, where the caller may want to assign id's to features. If a Feature with an id is passed to this method, the id must be unique.

      When adding the feature is finished, the given callback should be called with the newly added Feature (with id). When the Feature could not be added, the callback should be called as well to notify this.

      Parameters:
      newFeature - the new Feature
      Returns:
      this builder

    • updateFeature

      @NotNull public FeatureModelUpdate.Builder updateFeature(@NotNull Feature newFeature)
      This method is called to replace the Feature with the same id.
      Parameters:
      newFeature - the new Feature
      Returns:
      this builder

    • removeFeature

      @NotNull public FeatureModelUpdate.Builder removeFeature(long featureId)
      Removes the feature with the given id from the model.
      Parameters:
      featureId - a feature id
      Returns:
      this builder