DefaultConfigurationProvider (osmdroid-android 5.6.4 API)

java.lang.Object
- org.osmdroid.config.DefaultConfigurationProvider

All Implemented Interfaces:

IConfigurationProvider
```
public class DefaultConfigurationProvider
extends Object
implements IConfigurationProvider
```
Default configuration provider for osmdroid Issue 481 Created on 11/29/2016.

See Also:

IConfigurationProvider, Configuration

Field Summary

Fields
Modifier and Type	Field and Description
`protected short`	`cacheMapTileCount`
`protected boolean`	`debugMapTileDownloader`
`protected boolean`	`debugMapView`
`protected boolean`	`debugMode`
`protected boolean`	`debugTileProviders`
`protected long`	`expirationAdder`
`protected Long`	`expirationOverride`
`protected long`	`gpsWaitTime`
`protected SimpleDateFormat`	`httpHeaderDateTimeFormat`
`protected boolean`	`isMapViewHardwareAccelerated`
`protected File`	`osmdroidBasePath`
`protected File`	`osmdroidTileCache`
`protected short`	`tileDownloadMaxQueueSize`
`protected short`	`tileDownloadThreads`
`protected long`	`tileFileSystemCacheMaxBytes`
`protected long`	`tileFileSystemCacheTrimBytes`
`protected short`	`tileFileSystemMaxQueueSize`
`protected short`	`tileFileSystemThreads`
`protected String`	`userAgentHttpHeader`
`protected String`	`userAgentValue`

Constructor Summary

Constructors
Constructor and Description

DefaultConfigurationProvider()

Constructors
Constructor and Description
`DefaultConfigurationProvider()`

Method Summary

All Methods Instance Methods Concrete 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()` default is 20 seconds
`SimpleDateFormat`	`getHttpHeaderDateTimeFormat()`
`File`	`getOsmdroidBasePath()` Base path for osmdroid files.
`File`	`getOsmdroidTileCache()` by default, maps to getOsmdroidBasePath() + "/tiles" By default, it is defined in SD card, osmdroid directory.
`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 When calling @link `IConfigurationProvider.load(Context, SharedPreferences)`, it is set to `Context#getPackageName()` which is defined your manifest file 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 prefs)` 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 prefs)` 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)` by default, maps to getOsmdroidBasePath() + "/tiles" Sets the location where the tile cache is stored.
`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)` "User-Agent" is the default value and standard used throughout all http servers, unlikely to change When calling @link `IConfigurationProvider.load(Context, SharedPreferences)`, it is set to `Context#getPackageName()` which is defined your manifest file made adjustable just in case from `OpenStreetMapTileProviderConstants`
`void`	`setUserAgentValue(String userAgentValue)` Enables you to override the default "osmdroid" value for HTTP user agents.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - gpsWaitTime
```
protected long gpsWaitTime
```
  - debugMode
```
protected boolean debugMode
```
  - debugMapView
```
protected boolean debugMapView
```
  - debugTileProviders
```
protected boolean debugTileProviders
```
  - debugMapTileDownloader
```
protected boolean debugMapTileDownloader
```
  - isMapViewHardwareAccelerated
```
protected boolean isMapViewHardwareAccelerated
```
  - userAgentValue
```
protected String userAgentValue
```
  - userAgentHttpHeader
```
protected String userAgentHttpHeader
```
  - cacheMapTileCount
```
protected short cacheMapTileCount
```
  - tileDownloadThreads
```
protected short tileDownloadThreads
```
  - tileFileSystemThreads
```
protected short tileFileSystemThreads
```
  - tileDownloadMaxQueueSize
```
protected short tileDownloadMaxQueueSize
```
  - tileFileSystemMaxQueueSize
```
protected short tileFileSystemMaxQueueSize
```
  - tileFileSystemCacheMaxBytes
```
protected long tileFileSystemCacheMaxBytes
```
  - tileFileSystemCacheTrimBytes
```
protected long tileFileSystemCacheTrimBytes
```
  - httpHeaderDateTimeFormat
```
protected SimpleDateFormat httpHeaderDateTimeFormat
```
  - osmdroidBasePath
```
protected File osmdroidBasePath
```
  - osmdroidTileCache
```
protected File osmdroidTileCache
```
  - expirationAdder
```
protected long expirationAdder
```
  - expirationOverride
```
protected Long expirationOverride
```
- Constructor Detail
  - DefaultConfigurationProvider
```
public DefaultConfigurationProvider()
```
- Method Detail
  - getGpsWaitTime
```
public long getGpsWaitTime()
```
    default is 20 seconds
    
    Specified by:
    
    getGpsWaitTime in interface IConfigurationProvider
    
    Returns:
    
    time in ms
  - setGpsWaitTime
```
public void setGpsWaitTime(long gpsWaitTime)
```
    Description copied from interface: IConfigurationProvider
    
    The time we wait after the last gps location before using a non-gps location.
    
    Specified by:
    
    setGpsWaitTime in interface IConfigurationProvider
  - isDebugMode
```
public boolean isDebugMode()
```
    Description copied from interface: IConfigurationProvider
    
    Typically used to enable additional debugging from OpenStreetMapTileProviderConstants
    
    Specified by:
    
    isDebugMode in interface IConfigurationProvider
    
    Returns:
  - setDebugMode
```
public void setDebugMode(boolean debugMode)
```
    Specified by:
    
    setDebugMode in interface IConfigurationProvider
  - isDebugMapView
```
public boolean isDebugMapView()
```
    Description copied from interface: IConfigurationProvider
    
    Typically used to enable additional debugging from MapViewConstants
    
    Specified by:
    
    isDebugMapView in interface IConfigurationProvider
    
    Returns:
  - setDebugMapView
```
public void setDebugMapView(boolean debugMapView)
```
    Specified by:
    
    setDebugMapView in interface IConfigurationProvider
  - isDebugTileProviders
```
public boolean isDebugTileProviders()
```
    Description copied from interface: IConfigurationProvider
    
    Typically used to enable additional debugging from OpenStreetMapTileProviderConstants
    
    Specified by:
    
    isDebugTileProviders in interface IConfigurationProvider
    
    Returns:
  - setDebugTileProviders
```
public void setDebugTileProviders(boolean debugTileProviders)
```
    Specified by:
    
    setDebugTileProviders in interface IConfigurationProvider
  - isDebugMapTileDownloader
```
public boolean isDebugMapTileDownloader()
```
    Specified by:
    
    isDebugMapTileDownloader in interface IConfigurationProvider
  - setDebugMapTileDownloader
```
public void setDebugMapTileDownloader(boolean debugMapTileDownloader)
```
    Specified by:
    
    setDebugMapTileDownloader in interface IConfigurationProvider
  - isMapViewHardwareAccelerated
```
public boolean isMapViewHardwareAccelerated()
```
    Description copied from interface: IConfigurationProvider
    
    default is false
    
    Specified by:
    
    isMapViewHardwareAccelerated in interface IConfigurationProvider
    
    Returns:
  - setMapViewHardwareAccelerated
```
public void setMapViewHardwareAccelerated(boolean mapViewHardwareAccelerated)
```
    Description copied from interface: IConfigurationProvider
    
    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
    
    Specified by:
    
    setMapViewHardwareAccelerated in interface IConfigurationProvider
    
    See Also:
    
    Polygon, Polyline, OsmPath
  - getUserAgentValue
```
public String getUserAgentValue()
```
    Specified by:
    
    getUserAgentValue in interface IConfigurationProvider
  - setUserAgentValue
```
public void setUserAgentValue(String userAgentValue)
```
    Description copied from interface: IConfigurationProvider
    
    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
    
    Specified by:
    
    setUserAgentValue in interface IConfigurationProvider
  - getCacheMapTileCount
```
public short getCacheMapTileCount()
```
    Description copied from interface: IConfigurationProvider
    
    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
    
    Specified by:
    
    getCacheMapTileCount in interface IConfigurationProvider
    
    Returns:
    
    See Also:
    
    MapTileCache
  - setCacheMapTileCount
```
public void setCacheMapTileCount(short cacheMapTileCount)
```
    Specified by:
    
    setCacheMapTileCount in interface IConfigurationProvider
  - getTileDownloadThreads
```
public short getTileDownloadThreads()
```
    Description copied from interface: IConfigurationProvider
    
    number of tile download threads, conforming to OSM policy: http://wiki.openstreetmap.org/wiki/Tile_usage_policy default is 2
    
    Specified by:
    
    getTileDownloadThreads in interface IConfigurationProvider
  - setTileDownloadThreads
```
public void setTileDownloadThreads(short tileDownloadThreads)
```
    Specified by:
    
    setTileDownloadThreads in interface IConfigurationProvider
  - getTileFileSystemThreads
```
public short getTileFileSystemThreads()
```
    Description copied from interface: IConfigurationProvider
    
    used for both file system cache and the sqlite cache
    
    Specified by:
    
    getTileFileSystemThreads in interface IConfigurationProvider
    
    Returns:
  - setTileFileSystemThreads
```
public void setTileFileSystemThreads(short tileFileSystemThreads)
```
    Description copied from interface: IConfigurationProvider
    
    used for both file system cache and the sqlite cache
    
    Specified by:
    
    setTileFileSystemThreads in interface IConfigurationProvider
  - getTileDownloadMaxQueueSize
```
public short getTileDownloadMaxQueueSize()
```
    Specified by:
    
    getTileDownloadMaxQueueSize in interface IConfigurationProvider
  - setTileDownloadMaxQueueSize
```
public void setTileDownloadMaxQueueSize(short tileDownloadMaxQueueSize)
```
    Specified by:
    
    setTileDownloadMaxQueueSize in interface IConfigurationProvider
  - getTileFileSystemMaxQueueSize
```
public short getTileFileSystemMaxQueueSize()
```
    Specified by:
    
    getTileFileSystemMaxQueueSize in interface IConfigurationProvider
  - setTileFileSystemMaxQueueSize
```
public void setTileFileSystemMaxQueueSize(short tileFileSystemMaxQueueSize)
```
    Specified by:
    
    setTileFileSystemMaxQueueSize in interface IConfigurationProvider
  - getTileFileSystemCacheMaxBytes
```
public long getTileFileSystemCacheMaxBytes()
```
    Description copied from interface: IConfigurationProvider
    
    default is 600 Mb
    
    Specified by:
    
    getTileFileSystemCacheMaxBytes in interface IConfigurationProvider
  - setTileFileSystemCacheMaxBytes
```
public void setTileFileSystemCacheMaxBytes(long tileFileSystemCacheMaxBytes)
```
    Specified by:
    
    setTileFileSystemCacheMaxBytes in interface IConfigurationProvider
  - getTileFileSystemCacheTrimBytes
```
public long getTileFileSystemCacheTrimBytes()
```
    Description copied from interface: IConfigurationProvider
    
    When the cache size exceeds maxCacheSize, tiles will be automatically removed to reach this target. In Mb. Default is 500 Mb.
    
    Specified by:
    
    getTileFileSystemCacheTrimBytes in interface IConfigurationProvider
    
    Returns:
  - setTileFileSystemCacheTrimBytes
```
public void setTileFileSystemCacheTrimBytes(long tileFileSystemCacheTrimBytes)
```
    Specified by:
    
    setTileFileSystemCacheTrimBytes in interface IConfigurationProvider
  - getHttpHeaderDateTimeFormat
```
public SimpleDateFormat getHttpHeaderDateTimeFormat()
```
    Specified by:
    
    getHttpHeaderDateTimeFormat in interface IConfigurationProvider
  - setHttpHeaderDateTimeFormat
```
public void setHttpHeaderDateTimeFormat(SimpleDateFormat httpHeaderDateTimeFormat)
```
    Specified by:
    
    setHttpHeaderDateTimeFormat in interface IConfigurationProvider
  - getOsmdroidBasePath
```
public File getOsmdroidBasePath()
```
    Description copied from interface: IConfigurationProvider
    
    Base path for osmdroid files. Zip/sqlite/mbtiles/etc files are in this folder. Note: also used for offline tile sources
    
    Specified by:
    
    getOsmdroidBasePath in interface IConfigurationProvider
    
    Returns:
  - setOsmdroidBasePath
```
public void setOsmdroidBasePath(File osmdroidBasePath)
```
    Description copied from interface: IConfigurationProvider
    
    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
    
    Specified by:
    
    setOsmdroidBasePath in interface IConfigurationProvider
  - getOsmdroidTileCache
```
public File getOsmdroidTileCache()
```
    Description copied from interface: IConfigurationProvider
    
    by default, maps to getOsmdroidBasePath() + "/tiles" By default, it is defined in SD card, osmdroid directory. Sets the location where the tile cache is stored. Changes are only in effect when the @{link MapView} is created. Changes made after it's creation (either pogrammatic or via layout inflator) have no effect until the map is restarted or the MapView.setTileProvider(MapTileProviderBase) is changed or recreated. Note: basePath and tileCache directories can be changed independently This has no effect on offline archives and can be changed independently
    
    Specified by:
    
    getOsmdroidTileCache in interface IConfigurationProvider
    
    Returns:
  - setOsmdroidTileCache
```
public void setOsmdroidTileCache(File osmdroidTileCache)
```
    Description copied from interface: IConfigurationProvider
    
    by default, maps to getOsmdroidBasePath() + "/tiles" Sets the location where the tile cache is stored. Changes are only in effect when the @{link MapView} is created. Changes made after it's creation (either pogrammatic or via layout inflator) have no effect until the map is restarted or the MapView.setTileProvider(MapTileProviderBase) is changed or recreated. This has no effect on offline archives and can be changed independently
    
    Specified by:
    
    setOsmdroidTileCache in interface IConfigurationProvider
  - getUserAgentHttpHeader
```
public String getUserAgentHttpHeader()
```
    Description copied from interface: IConfigurationProvider
    
    "User-Agent" is the default value and standard used throughout all http servers, unlikely to change When calling @link IConfigurationProvider.load(Context, SharedPreferences), it is set to Context#getPackageName() which is defined your manifest file made adjustable just in case from OpenStreetMapTileProviderConstants
    
    Specified by:
    
    getUserAgentHttpHeader in interface IConfigurationProvider
    
    Returns:
  - setUserAgentHttpHeader
```
public void setUserAgentHttpHeader(String userAgentHttpHeader)
```
    Description copied from interface: IConfigurationProvider
    
    "User-Agent" is the default value and standard used throughout all http servers, unlikely to change When calling @link IConfigurationProvider.load(Context, SharedPreferences), it is set to Context#getPackageName() which is defined your manifest file made adjustable just in case from OpenStreetMapTileProviderConstants
    
    Specified by:
    
    setUserAgentHttpHeader in interface IConfigurationProvider
  - load
```
public void load(Context ctx,
                 SharedPreferences prefs)
```
    Description copied from interface: IConfigurationProvider
    
    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.
    
    Specified by:
    
    load in interface IConfigurationProvider
  - save
```
public void save(Context ctx,
                 SharedPreferences prefs)
```
    Description copied from interface: IConfigurationProvider
    
    saves the current configuration to the shared preference location
    
    Specified by:
    
    save in interface IConfigurationProvider
  - getExpirationExtendedDuration
```
public long getExpirationExtendedDuration()
```
    Description copied from interface: IConfigurationProvider
    
    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
    
    Specified by:
    
    getExpirationExtendedDuration in interface IConfigurationProvider
    
    Returns:
    
    time in ms
  - setExpirationExtendedDuration
```
public void setExpirationExtendedDuration(long period)
```
    Description copied from interface: IConfigurationProvider
    
    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
    
    Specified by:
    
    setExpirationExtendedDuration in interface IConfigurationProvider
    
    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
  - setExpirationOverrideDuration
```
public void setExpirationOverrideDuration(Long period)
```
    Description copied from interface: IConfigurationProvider
    
    Optional period of time in ms that will override any downloaded tile's expiration timestamp
    
    Specified by:
    
    setExpirationOverrideDuration in interface IConfigurationProvider
    
    Parameters:
    
    period - if null, this setting is unset, server value + getExpirationExtendedDuration apply if not null, this this value is used
  - getExpirationOverrideDuration
```
public Long getExpirationOverrideDuration()
```
    Description copied from interface: IConfigurationProvider
    
    Optional period of time in ms that will override any downloaded tile's expiration timestamp
    
    Specified by:
    
    getExpirationOverrideDuration in interface IConfigurationProvider
    
    Returns:
    
    period if null, this setting is unset, server value + getExpirationExtendedDuration apply if not null, this this value is used

Class DefaultConfigurationProvider

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

gpsWaitTime

debugMode

debugMapView

debugTileProviders

debugMapTileDownloader

isMapViewHardwareAccelerated

userAgentValue

userAgentHttpHeader

cacheMapTileCount

tileDownloadThreads

tileFileSystemThreads

tileDownloadMaxQueueSize

tileFileSystemMaxQueueSize

tileFileSystemCacheMaxBytes

tileFileSystemCacheTrimBytes

httpHeaderDateTimeFormat

osmdroidBasePath

osmdroidTileCache

expirationAdder

expirationOverride

Constructor Detail

DefaultConfigurationProvider

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