IConfigurationProvider (osmdroid-android 5.6.2 API)

All Known Implementing Classes:

DefaultConfigurationProvider
```
public interface IConfigurationProvider
```
Singleton class to get/set a configuration provider for osmdroid Issue 481 Created on 11/29/2016.

Since:

5.6

See Also:

OpenStreetMapTileProviderConstants

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`short`	`getCacheMapTileCount()` Initial tile cache size (in memory).
`long`	`getExpirationExtendedDuration()` Returns the amount of time in ms added to server specified tile expiration time Added as part of issue https://github.com/osmdroid/osmdroid/issues/490
`Long`	`getExpirationOverrideDuration()` Optional period of time in ms that will override any downloaded tile's expiration timestamp
`long`	`getGpsWaitTime()` The time we wait after the last gps location before using a non-gps location.
`SimpleDateFormat`	`getHttpHeaderDateTimeFormat()`
`File`	`getOsmdroidBasePath()` Base path for osmdroid files.
`File`	`getOsmdroidTileCache()` maps to getOsmdroidBasePath() + "/tiles" Change the root path of the osmdroid tile cache.
`short`	`getTileDownloadMaxQueueSize()`
`short`	`getTileDownloadThreads()` number of tile download threads, conforming to OSM policy: http://wiki.openstreetmap.org/wiki/Tile_usage_policy default is 2
`long`	`getTileFileSystemCacheMaxBytes()` default is 600 Mb
`long`	`getTileFileSystemCacheTrimBytes()` When the cache size exceeds maxCacheSize, tiles will be automatically removed to reach this target.
`short`	`getTileFileSystemMaxQueueSize()`
`short`	`getTileFileSystemThreads()` used for both file system cache and the sqlite cache
`String`	`getUserAgentHttpHeader()` "User-Agent" is the default value and standard used throughout all http servers, unlikely to change made adjustable just in case from `OpenStreetMapTileProviderConstants`
`String`	`getUserAgentValue()`
`boolean`	`isDebugMapTileDownloader()`
`boolean`	`isDebugMapView()` Typically used to enable additional debugging from `MapViewConstants`
`boolean`	`isDebugMode()` Typically used to enable additional debugging from `OpenStreetMapTileProviderConstants`
`boolean`	`isDebugTileProviders()` Typically used to enable additional debugging from `OpenStreetMapTileProviderConstants`
`boolean`	`isMapViewHardwareAccelerated()` default is false
`void`	`load(Context ctx, SharedPreferences preferences)` loads the configuration from shared preferences, if the preferences defined in this file are not already set, them they will be populated with defaults.
`void`	`save(Context ctx, SharedPreferences preferences)` saves the current configuration to the shared preference location
`void`	`setCacheMapTileCount(short cacheMapTileCount)`
`void`	`setDebugMapTileDownloader(boolean debugMapTileDownloader)`
`void`	`setDebugMapView(boolean debugMapView)`
`void`	`setDebugMode(boolean debugMode)`
`void`	`setDebugTileProviders(boolean debugTileProviders)`
`void`	`setExpirationExtendedDuration(long period)` Optionally extends the amount of time that downloaded tiles remain in the cache beyond either the server specified expiration time stamp or the default expiration time {`OpenStreetMapTileProviderConstants.DEFAULT_MAXIMUM_CACHED_FILE_AGE`} Note: this setting only controls tiles as they are downloaded.
`void`	`setExpirationOverrideDuration(Long period)` Optional period of time in ms that will override any downloaded tile's expiration timestamp
`void`	`setGpsWaitTime(long gpsWaitTime)` The time we wait after the last gps location before using a non-gps location.
`void`	`setHttpHeaderDateTimeFormat(SimpleDateFormat httpHeaderDateTimeFormat)`
`void`	`setMapViewHardwareAccelerated(boolean mapViewHardwareAccelerated)` must be set before the mapview is created or inflated from a layout.
`void`	`setOsmdroidBasePath(File osmdroidBasePath)` Base path for osmdroid files.
`void`	`setOsmdroidTileCache(File osmdroidTileCache)`
`void`	`setTileDownloadMaxQueueSize(short tileDownloadMaxQueueSize)`
`void`	`setTileDownloadThreads(short tileDownloadThreads)`
`void`	`setTileFileSystemCacheMaxBytes(long tileFileSystemCacheMaxBytes)`
`void`	`setTileFileSystemCacheTrimBytes(long tileFileSystemCacheTrimBytes)`
`void`	`setTileFileSystemMaxQueueSize(short tileFileSystemMaxQueueSize)`
`void`	`setTileFileSystemThreads(short tileFileSystemThreads)` used for both file system cache and the sqlite cache
`void`	`setUserAgentHttpHeader(String userAgentHttpHeader)`
`void`	`setUserAgentValue(String userAgentValue)` Enables you to override the default "osmdroid" value for HTTP user agents.

- Method Detail
  - getGpsWaitTime
```
long getGpsWaitTime()
```
    The time we wait after the last gps location before using a non-gps location. was previously at org.osmdroid.util.constants.UtilConstants
    
    Returns:
    
    time in ms
  - setGpsWaitTime
```
void setGpsWaitTime(long gpsWaitTime)
```
    The time we wait after the last gps location before using a non-gps location.
    
    Parameters:
    
    gpsWaitTime -
  - isDebugMode
```
boolean isDebugMode()
```
    Typically used to enable additional debugging from OpenStreetMapTileProviderConstants
    
    Returns:
  - setDebugMode
```
void setDebugMode(boolean debugMode)
```
  - isDebugMapView
```
boolean isDebugMapView()
```
    Typically used to enable additional debugging from MapViewConstants
    
    Returns:
  - setDebugMapView
```
void setDebugMapView(boolean debugMapView)
```
  - isDebugTileProviders
```
boolean isDebugTileProviders()
```
    Typically used to enable additional debugging from OpenStreetMapTileProviderConstants
    
    Returns:
  - setDebugTileProviders
```
void setDebugTileProviders(boolean debugTileProviders)
```
  - isDebugMapTileDownloader
```
boolean isDebugMapTileDownloader()
```
  - setDebugMapTileDownloader
```
void setDebugMapTileDownloader(boolean debugMapTileDownloader)
```
  - isMapViewHardwareAccelerated
```
boolean isMapViewHardwareAccelerated()
```
    default is false
    
    Returns:
  - setMapViewHardwareAccelerated
```
void setMapViewHardwareAccelerated(boolean mapViewHardwareAccelerated)
```
    must be set before the mapview is created or inflated from a layout. If you're only using single point icons, then youc an probably get away with setting this to true otherwise (using polylines, paths, polygons) set it to false. default is false
    
    Parameters:
    
    mapViewHardwareAccelerated -
    
    See Also:
    
    Polygon, Polyline, OsmPath
  - getUserAgentValue
```
String getUserAgentValue()
```
  - setUserAgentValue
```
void setUserAgentValue(String userAgentValue)
```
    Enables you to override the default "osmdroid" value for HTTP user agents. Used when downloading tiles You MUST use this to set the user agent to some value specific to your application. Typical usage: Context.getApplicationContext().getPackageName(); from OpenStreetMapTileProviderConstants
    
    Parameters:
    
    userAgentValue -
    
    Since:
    
    5.0
  - getCacheMapTileCount
```
short getCacheMapTileCount()
```
    Initial tile cache size (in memory). The size will be increased as required by calling LRUMapTileCache.ensureCapacity(int) The tile cache will always be at least 3x3. from OpenStreetMapTileProviderConstants used by MapTileCache
    
    Returns:
    
    See Also:
    
    MapTileCache
  - setCacheMapTileCount
```
void setCacheMapTileCount(short cacheMapTileCount)
```
  - getTileDownloadThreads
```
short getTileDownloadThreads()
```
    number of tile download threads, conforming to OSM policy: http://wiki.openstreetmap.org/wiki/Tile_usage_policy default is 2
  - setTileDownloadThreads
```
void setTileDownloadThreads(short tileDownloadThreads)
```
  - getTileFileSystemThreads
```
short getTileFileSystemThreads()
```
    used for both file system cache and the sqlite cache
    
    Returns:
  - setTileFileSystemThreads
```
void setTileFileSystemThreads(short tileFileSystemThreads)
```
    used for both file system cache and the sqlite cache
    
    Parameters:
    
    tileFileSystemThreads -
  - getTileDownloadMaxQueueSize
```
short getTileDownloadMaxQueueSize()
```
  - setTileDownloadMaxQueueSize
```
void setTileDownloadMaxQueueSize(short tileDownloadMaxQueueSize)
```
  - getTileFileSystemMaxQueueSize
```
short getTileFileSystemMaxQueueSize()
```
  - setTileFileSystemMaxQueueSize
```
void setTileFileSystemMaxQueueSize(short tileFileSystemMaxQueueSize)
```
  - getTileFileSystemCacheMaxBytes
```
long getTileFileSystemCacheMaxBytes()
```
    default is 600 Mb
  - setTileFileSystemCacheMaxBytes
```
void setTileFileSystemCacheMaxBytes(long tileFileSystemCacheMaxBytes)
```
  - getTileFileSystemCacheTrimBytes
```
long getTileFileSystemCacheTrimBytes()
```
    When the cache size exceeds maxCacheSize, tiles will be automatically removed to reach this target. In Mb. Default is 500 Mb.
    
    Returns:
  - setTileFileSystemCacheTrimBytes
```
void setTileFileSystemCacheTrimBytes(long tileFileSystemCacheTrimBytes)
```
  - getHttpHeaderDateTimeFormat
```
SimpleDateFormat getHttpHeaderDateTimeFormat()
```
  - setHttpHeaderDateTimeFormat
```
void setHttpHeaderDateTimeFormat(SimpleDateFormat httpHeaderDateTimeFormat)
```
  - getOsmdroidBasePath
```
File getOsmdroidBasePath()
```
    Base path for osmdroid files. Zip/sqlite/mbtiles/etc files are in this folder. Note: also used for offline tile sources
    
    Returns:
  - setOsmdroidBasePath
```
void setOsmdroidBasePath(File osmdroidBasePath)
```
    Base path for osmdroid files. Zip/sqlite/mbtiles/etc files are in this folder. Note: also used for offline tile sources Default is StorageUtils.getStorage().getAbsolutePath(),"osmdroid", which usually maps to /sdcard/osmdroid
    
    Parameters:
    
    osmdroidBasePath -
  - getOsmdroidTileCache
```
File getOsmdroidTileCache()
```
    maps to getOsmdroidBasePath() + "/tiles" Change the root path of the osmdroid tile cache. By default, it is defined in SD card, osmdroid directory.
    
    Returns:
  - setOsmdroidTileCache
```
void setOsmdroidTileCache(File osmdroidTileCache)
```
  - getUserAgentHttpHeader
```
String getUserAgentHttpHeader()
```
    "User-Agent" is the default value and standard used throughout all http servers, unlikely to change made adjustable just in case from OpenStreetMapTileProviderConstants
    
    Returns:
  - setUserAgentHttpHeader
```
void setUserAgentHttpHeader(String userAgentHttpHeader)
```
  - load
```
void load(Context ctx,
          SharedPreferences preferences)
```
    loads the configuration from shared preferences, if the preferences defined in this file are not already set, them they will be populated with defaults. This also initializes the tile storage cache to the largested writable storage partition available.
    
    Parameters:
    
    ctx -
    
    preferences -
  - save
```
void save(Context ctx,
          SharedPreferences preferences)
```
    saves the current configuration to the shared preference location
    
    Parameters:
    
    ctx -
    
    preferences -
  - getExpirationExtendedDuration
```
long getExpirationExtendedDuration()
```
    Returns the amount of time in ms added to server specified tile expiration time Added as part of issue https://github.com/osmdroid/osmdroid/issues/490
    
    Returns:
    
    time in ms
    
    Since:
    
    5.6.1
  - setExpirationExtendedDuration
```
void setExpirationExtendedDuration(long period)
```
    Optionally extends the amount of time that downloaded tiles remain in the cache beyond either the server specified expiration time stamp or the default expiration time {OpenStreetMapTileProviderConstants.DEFAULT_MAXIMUM_CACHED_FILE_AGE} Note: this setting only controls tiles as they are downloaded. tiles already in the cache are not effected by this setting Added as part of issue https://github.com/osmdroid/osmdroid/issues/490
    
    Parameters:
    
    period - time in ms, if 0, no additional time to the 'server provided expiration' or the 'default expiration time' is added. If the value is less than 0, 0 will be used
    
    Since:
    
    5.6.1
  - setExpirationOverrideDuration
```
void setExpirationOverrideDuration(Long period)
```
    Optional period of time in ms that will override any downloaded tile's expiration timestamp
    
    Parameters:
    
    period - if null, this setting is unset, server value + getExpirationExtendedDuration apply if not null, this this value is used
    
    Since:
    
    5.6.1
  - getExpirationOverrideDuration
```
Long getExpirationOverrideDuration()
```
    Optional period of time in ms that will override any downloaded tile's expiration timestamp
    
    Returns:
    
    period if null, this setting is unset, server value + getExpirationExtendedDuration apply if not null, this this value is used
    
    Since:
    
    5.6.1

Interface IConfigurationProvider

Method Summary

Method Detail

getGpsWaitTime

setGpsWaitTime

isDebugMode

setDebugMode

isDebugMapView

setDebugMapView

isDebugTileProviders

setDebugTileProviders

isDebugMapTileDownloader

setDebugMapTileDownloader

isMapViewHardwareAccelerated

setMapViewHardwareAccelerated

getUserAgentValue

setUserAgentValue

getCacheMapTileCount

setCacheMapTileCount

getTileDownloadThreads

setTileDownloadThreads

getTileFileSystemThreads

setTileFileSystemThreads

getTileDownloadMaxQueueSize

setTileDownloadMaxQueueSize

getTileFileSystemMaxQueueSize

setTileFileSystemMaxQueueSize

getTileFileSystemCacheMaxBytes

setTileFileSystemCacheMaxBytes

getTileFileSystemCacheTrimBytes

setTileFileSystemCacheTrimBytes

getHttpHeaderDateTimeFormat

setHttpHeaderDateTimeFormat

getOsmdroidBasePath

setOsmdroidBasePath

getOsmdroidTileCache

setOsmdroidTileCache

getUserAgentHttpHeader

setUserAgentHttpHeader

load

save

getExpirationExtendedDuration

setExpirationExtendedDuration

setExpirationOverrideDuration

getExpirationOverrideDuration