org.osmdroid.tileprovider.util

Class StorageUtils

java.lang.Object

org.osmdroid.tileprovider.util.StorageUtils

public class StorageUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StorageUtils.StorageInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_SD_CARD
static String	SD_CARD

Constructor Summary

Constructors

Constructor and Description
StorageUtils()

Method Summary

Modifier and Type	Method and Description
static Map<String,File>	getAllStorageLocations() Deprecated. As of 6.1.7, use getStorageList() instead.
static StorageUtils.StorageInfo	getBestWritableStorage() Gets the best possible storage location by free space
static StorageUtils.StorageInfo	getBestWritableStorage(Context context) Gets the best possible storage location by free space
static String	getSdCardPath() Deprecated. As of 6.1.7, will be removed in the future.
static File	getStorage() Deprecated. As of 6.1.7, use getBestWritableStorage() instead.
static File	getStorage(Context context) Deprecated. As of 6.1.7, use getBestWritableStorage(Context) instead.
static List<StorageUtils.StorageInfo>	getStorageList() Attention! This method only gets storage locations that are context independent.
static List<StorageUtils.StorageInfo>	getStorageList(Context context) Detects all available storage locations, writable or not.
static boolean	isAvailable() Deprecated. As of 6.1.7, will be removed in the future.
static boolean	isWritable() Deprecated. As of 6.1.7, will be removed in the future.
static boolean	isWritable(File path)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SD_CARD

public static final String SD_CARD

See Also:

Constant Field Values

EXTERNAL_SD_CARD

public static final String EXTERNAL_SD_CARD

See Also:

Constant Field Values

Constructor Detail

StorageUtils

public StorageUtils()

Method Detail

getStorageList

public static List<StorageUtils.StorageInfo> getStorageList()

Attention! This method only gets storage locations that are context independent. Especially it does not return application specific paths like getFilesDir() or getCacheDir(), which might lead to problems especially on API29 and up due to scoped storage restrictions, where this method will always return an empty list! It's always recommended to use getStorageList(Context) instead!

Returns:

A List of StorageUtils.StorageInfo of all storage paths, writable or not.

getStorageList

public static List<StorageUtils.StorageInfo> getStorageList(Context context)

Detects all available storage locations, writable or not.

Attention! If context==null this method only gets storage locations that are context independent. Especially it will not return application specific paths like getFilesDir() or getCacheDir(), which might lead to problems especially on API29 and up due to scoped storage restrictions, where this is then guaranteed to return an empty list!

Returns:

A List of StorageUtils.StorageInfo of all storage paths, writable or not.

getStorage

@Deprecated
public static File getStorage()

Deprecated. As of 6.1.7, use getBestWritableStorage() instead.

Gets the best possible storage location by free space

Attention! This method only gets storage locations that are context independent. Especially it does not return application specific paths like getFilesDir() or getCacheDir(), which might lead to problems especially on API29 and up due to scoped storage restrictions, where this method will always return null! It's always recommended to use getBestWritableStorage(Context) instead!

getBestWritableStorage

public static StorageUtils.StorageInfo getBestWritableStorage()

Gets the best possible storage location by free space

Attention! This method only gets storage locations that are context independent. Especially it does not return application specific paths like getFilesDir() or getCacheDir(), which might lead to problems especially on API29 and up due to scoped storage restrictions. For now it is advised to manually determine a proper cache location and set it via IConfigurationProvider.setOsmdroidTileCache(File).

Returns:

A StorageUtils.StorageInfo object.

getStorage

@Deprecated
public static File getStorage(Context context)

Deprecated. As of 6.1.7, use getBestWritableStorage(Context) instead.

Gets the best possible storage location by free space

Attention! If context==null this method only gets storage locations that are context independent. Especially it will not return application specific paths like getFilesDir() or getCacheDir(), which might lead to problems especially on API29 and up due to scoped storage restrictions, where this is then guaranteed to return null!

getBestWritableStorage

public static StorageUtils.StorageInfo getBestWritableStorage(Context context)

Gets the best possible storage location by free space

Attention! If context==null this method only gets storage locations that are context independent. Especially it will not return application specific paths like getFilesDir() or getCacheDir(), which might lead to problems especially on API29 and up due to scoped storage restrictions, where this is then guaranteed to return null!

Returns:

A StorageUtils.StorageInfo object.

isAvailable

@Deprecated
public static boolean isAvailable()

Deprecated. As of 6.1.7, will be removed in the future.

Returns:

True if the primary shared storage is available. False otherwise.

getSdCardPath

@Deprecated
public static String getSdCardPath()

Deprecated. As of 6.1.7, will be removed in the future.

Returns:

The path of the primary shared storage.

isWritable

@Deprecated
public static boolean isWritable()

Deprecated. As of 6.1.7, will be removed in the future.

Returns:

True if the primary shared storage is writable. False otherwise.

isWritable

public static boolean isWritable(File path)

Returns:

True if the path is writable. False otherwise.

getAllStorageLocations

public static Map<String,File> getAllStorageLocations()

Deprecated. As of 6.1.7, use getStorageList() instead.

Returns:

A Map of all storage locations available