Class MapSceneLoadOptionsBuilder
Class MapSceneLoadOptionsBuilder
- java.lang.Object
-
- com.here.NativeBase
-
- com.here.sdk.mapview.MapSceneLoadOptionsBuilder
-
public final class MapSceneLoadOptionsBuilder extends NativeBase
Builder for creating
MapSceneLoadOptionsinstances. This builder ensures that either a MapScheme or a configuration file is set, but not both.Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMapSceneLoadOptionsBuilder.InstantiationErrorCodeDescribes a reason for failing to build aMapSceneLoadOptions.static classMapSceneLoadOptionsBuilder.InstantiationErrorDetailsDescribes the reason for failing to build aMapSceneLoadOptions.static classMapSceneLoadOptionsBuilder.InstantiationExceptionThrown when failing to build aMapSceneLoadOptions.
-
Constructor Summary
Constructors Constructor Description MapSceneLoadOptionsBuilder()Creates a new builder instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MapSceneLoadOptionsbuild()Builds theMapSceneLoadOptionsinstance.MapSceneLoadOptionsBuilderwithConfigurationFile(java.lang.String configurationFile)Sets the configuration file path to load.MapSceneLoadOptionsBuilderwithDisabledFeatures(java.util.List<java.lang.String> disabledFeatures)Sets the features to disable in the new configuration.MapSceneLoadOptionsBuilderwithEnabledFeatures(java.util.Map<java.lang.String,java.lang.String> enabledFeatures)Sets the features to enable in the new configuration.MapSceneLoadOptionsBuilderwithMapScheme(MapScheme mapScheme)Sets the map scheme to load.MapSceneLoadOptionsBuilderwithOverridingMapStyle(Style overridingMapStyle)Sets the style to override what is defined in the scene configuration.MapSceneLoadOptionsBuilderwithWatermarkStyle(WatermarkStyle watermarkStyle)Sets the watermark style.
-
-
-
Method Detail
-
withMapScheme
@NonNull public MapSceneLoadOptionsBuilder withMapScheme(@NonNull MapScheme mapScheme)
Sets the map scheme to load. Any configuration file set through
withConfigurationFile(java.lang.String)will be discarded.- Parameters:
mapScheme-Map scheme to load.
- Returns:
This class instance.
-
withConfigurationFile
@NonNull public MapSceneLoadOptionsBuilder withConfigurationFile(@NonNull java.lang.String configurationFile)
Sets the configuration file path to load. Any map scheme set through
withMapScheme(com.here.sdk.mapview.MapScheme)will be discarded.- Parameters:
configurationFile-Configuration file path to load.
- Returns:
This class instance.
-
withEnabledFeatures
@NonNull public MapSceneLoadOptionsBuilder withEnabledFeatures(@NonNull java.util.Map<java.lang.String,java.lang.String> enabledFeatures)
Sets the features to enable in the new configuration.
- Parameters:
enabledFeatures-Features to enable. Key = feature name, value = mode name.
- Returns:
This class instance.
-
withDisabledFeatures
@NonNull public MapSceneLoadOptionsBuilder withDisabledFeatures(@NonNull java.util.List<java.lang.String> disabledFeatures)
Sets the features to disable in the new configuration.
- Parameters:
disabledFeatures-Features to disable.
- Returns:
This class instance.
-
withWatermarkStyle
@NonNull public MapSceneLoadOptionsBuilder withWatermarkStyle(@NonNull WatermarkStyle watermarkStyle)
Sets the watermark style.
- Parameters:
watermarkStyle-Watermark style to use.
- Returns:
This class instance.
-
withOverridingMapStyle
@NonNull public MapSceneLoadOptionsBuilder withOverridingMapStyle(@NonNull Style overridingMapStyle)
Sets the style to override what is defined in the scene configuration.
- Parameters:
overridingMapStyle-Map style to override the scene configuration.
- Returns:
This class instance.
-
build
@NonNull public MapSceneLoadOptions build() throws MapSceneLoadOptionsBuilder.InstantiationException
Builds the
MapSceneLoadOptionsinstance.- Returns:
A new MapSceneLoadOptions instance.
- Throws:
MapSceneLoadOptionsBuilder.InstantiationException-Indicates an instantiation issue.
-
-