Package com.trimblemaps.mapsdk.util

Class TileServerOptions

java.lang.Object
com.trimblemaps.mapsdk.util.TileServerOptions
All Implemented Interfaces:
android.os.Parcelable
public class TileServerOptions extends Object implements android.os.Parcelable
Tile server options - baseUrl and similar properties

  • Field Details

    • CREATOR

      public static final android.os.Parcelable.Creator<TileServerOptions> CREATOR
      Inner class responsible for recreating Parcels into objects.

  • Constructor Details

    • TileServerOptions

      public TileServerOptions(String baseURL, String uriSchemeAlias, String sourceTemplate, String sourceDomainName, @Nullable String sourceVersionPrefix, String styleTemplate, String styleDomainName, @Nullable String styleVersionPrefix, String spritesTemplate, String spritesDomainName, @Nullable String spritesVersionPrefix, String glyphsTemplate, String glyphsDomainName, @Nullable String glyphsVersionPrefix, String tileTemplate, String tileDomainName, @Nullable String tileVersionPrefix, String apiKeyParameterName, boolean apiKeyRequired, String defaultStyle, DefaultStyle[] defaultStyles)
      Construct a new TileServerOptions given string arguments
      Parameters:
      baseURL - tile server base url
      uriSchemeAlias - scheme alias such as trimblemaps://
      sourceTemplate - tile source url template
      sourceDomainName - tile source domain name
      sourceVersionPrefix - tile source version prefix
      styleTemplate - style url template
      styleDomainName - the name of style domain in canonical url
      styleVersionPrefix - version prefix
      spritesTemplate - sprites url template
      spritesDomainName - the name of the sprites domain in canonical url
      spritesVersionPrefix - the sprite version prefix
      glyphsTemplate - glyphs url template
      glyphsDomainName - the name of the glyphs domain in canonical url
      glyphsVersionPrefix - the glyphs version prefix
      tileTemplate - tile url template
      tileDomainName - the name of the tile domain in canonical url
      tileVersionPrefix - the tile version prefix
      apiKeyParameterName - the name of api key parameter
      apiKeyRequired - indicates if API key is required
      defaultStyle - the name of the default style
      defaultStyles - the list of default styles

    • TileServerOptions

      protected TileServerOptions(android.os.Parcel in)
      Constructs a new tile server options tuple given a parcel.
      Parameters:
      in - the parcel containing the tile server options values

  • Method Details

    • setBaseURL

      public void setBaseURL(String baseURL)

    • getBaseURL

      public String getBaseURL()

    • setUriSchemeAlias

      public void setUriSchemeAlias(String uriSchemeAlias)

    • getUriSchemeAlias

      public String getUriSchemeAlias()

    • setSourceTemplate

      public void setSourceTemplate(String sourceTemplate)

    • getSourceTemplate

      public String getSourceTemplate()

    • setSourceDomainName

      public void setSourceDomainName(String domainName)

    • getSourceDomainName

      public String getSourceDomainName()

    • setSourceVersionPrefix

      public void setSourceVersionPrefix(String sourceVersionPrefix)

    • getSourceVersionPrefix

      public String getSourceVersionPrefix()

    • setStyleTemplate

      public void setStyleTemplate(String styleTemplate)

    • getStyleTemplate

      public String getStyleTemplate()

    • setStyleDomainName

      public void setStyleDomainName(String styleDomainName)

    • getStyleDomainName

      public String getStyleDomainName()

    • setStyleVersionPrefix

      public void setStyleVersionPrefix(String styleVersionPrefix)

    • getStyleVersionPrefix

      public String getStyleVersionPrefix()

    • setSpritesTemplate

      public void setSpritesTemplate(String spritesTemplate)

    • getSpritesTemplate

      public String getSpritesTemplate()

    • setSpritesDomainName

      public void setSpritesDomainName(String spritesDomainName)

    • getSpritesDomainName

      public String getSpritesDomainName()

    • setSpritesVersionPrefix

      public void setSpritesVersionPrefix(String spritesVersionPrefix)

    • getSpritesVersionPrefix

      public String getSpritesVersionPrefix()

    • setGlyphsTemplate

      public void setGlyphsTemplate(String glyphsTemplate)

    • getGlyphsTemplate

      public String getGlyphsTemplate()

    • setGlyphsDomainName

      public void setGlyphsDomainName(String glyphsDomainName)

    • getGlyphsDomainName

      public String getGlyphsDomainName()

    • setGlyphsVersionPrefix

      public void setGlyphsVersionPrefix(String glyphsVersionPrefix)

    • getGlyphsVersionPrefix

      public String getGlyphsVersionPrefix()

    • setTileTemplate

      public void setTileTemplate(String tileTemplate)

    • getTileTemplate

      public String getTileTemplate()

    • setTileDomainName

      public void setTileDomainName(String tileDomainName)

    • getTileDomainName

      public String getTileDomainName()

    • setTileVersionPrefix

      public void setTileVersionPrefix(String tileVersionPrefix)

    • getTileVersionPrefix

      public String getTileVersionPrefix()

    • setApiKeyParameterName

      public void setApiKeyParameterName(String apiKeyParameterName)

    • getApiKeyParameterName

      public String getApiKeyParameterName()

    • setApiKeyRequired

      public void setApiKeyRequired(boolean isRequired)

    • getApiKeyRequired

      public boolean getApiKeyRequired()

    • setDefaultStyles

      public void setDefaultStyles(DefaultStyle[] defaultStyles)

    • getDefaultStyles

      public DefaultStyle[] getDefaultStyles()

    • setDefaultStyle

      public void setDefaultStyle(String defaultStyleName)

    • getDefaultStyle

      public String getDefaultStyle()

    • describeContents

      public int describeContents()
      Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
      Specified by:
      describeContents in interface android.os.Parcelable
      Returns:
      a bitmask indicating the set of special object types marshaled by this Parcelable object instance.

    • writeToParcel

      public void writeToParcel(@NonNull android.os.Parcel out, int flags)
      Flatten this object in to a Parcel.
      Specified by:
      writeToParcel in interface android.os.Parcelable
      Parameters:
      out - The Parcel in which the object should be written.
      flags - Additional flags about how the object should be written

    • get

      public static TileServerOptions get(WellKnownTileServer tileServer)

    • get

      public static TileServerOptions get(WellKnownTileServer tileServer, String region)
      Internal region-aware method that uses TrimbleTileServerOptions factory for Trimble servers while maintaining backward compatibility for other tile servers.
      Parameters:
      tileServer - the tile server type
      region - the region code (e.g., "na", "eu", "au") - defaults to "na"
      Returns:
      TileServerOptions configured for the specified server and region