ch.qos.logback.core.android

Class AndroidContextUtil

java.lang.Object

ch.qos.logback.core.android.AndroidContextUtil

public class AndroidContextUtil
extends Object

This class provides utility methods to get common directory paths and context data (such as package name).

Since:

1.0.8-1

Constructor Summary

Constructors

Constructor and Description
AndroidContextUtil()
AndroidContextUtil(ContextWrapper contextWrapper)

Method Summary

Modifier and Type	Method and Description
String	getCacheDirectoryPath()
String	getDatabaseDirectoryPath() Returns the absolute path to the directory on the Android filesystem where databases are stored for the current application.
String	getDatabasePath(String databaseName)
String	getExternalCacheDirectoryPath()
String	getExternalFilesDirectoryPath()
String	getExternalStorageDirectoryPath() Gets the path to the external storage directory
String	getFilesDirectoryPath() Returns the absolute path to the directory on the Android filesystem where files are stored for the current application.
String	getMountedExternalStorageDirectoryPath() Gets the path to the external storage directory only if mounted.
String	getNoBackupFilesDirectoryPath() Returns the absolute path to the directory on the Android filesystem similar to getFilesDirectoryPath().
String	getPackageName()
String	getVersionCode()
String	getVersionName()
void	setupProperties(LoggerContext context) Sets properties for use in configs

Methods inherited from class java.lang.Object

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

Constructor Detail

AndroidContextUtil

public AndroidContextUtil()

AndroidContextUtil

public AndroidContextUtil(ContextWrapper contextWrapper)

Method Detail

setupProperties

public void setupProperties(LoggerContext context)

Sets properties for use in configs

Parameters:

context - logger context whose property map is updated

getMountedExternalStorageDirectoryPath

public String getMountedExternalStorageDirectoryPath()

Gets the path to the external storage directory only if mounted.

Returns:

the absolute path to the external storage directory; or null if not mounted.

getExternalStorageDirectoryPath

public String getExternalStorageDirectoryPath()

Gets the path to the external storage directory

Returns:

the absolute path to the external storage directory

getExternalFilesDirectoryPath

public String getExternalFilesDirectoryPath()

getCacheDirectoryPath

public String getCacheDirectoryPath()

getExternalCacheDirectoryPath

public String getExternalCacheDirectoryPath()

getPackageName

public String getPackageName()

getFilesDirectoryPath

public String getFilesDirectoryPath()

Returns the absolute path to the directory on the Android filesystem where files are stored for the current application. Unlike the equivalent function in Android, this function does not create the directory if it's non-existent.

Returns:

the absolute path to the files directory (example: "/data/data/com.example/files")

getNoBackupFilesDirectoryPath

public String getNoBackupFilesDirectoryPath()

Returns the absolute path to the directory on the Android filesystem similar to getFilesDirectoryPath(). The difference is these files are excluded from automatic backup to remote storage by BackupAgent. This API is only available on SDK 21+. On older versions, this function returns an empty string.

Returns:

the absolute path to the files directory (example: "/data/data/com.example/nobackup/files")

getDatabaseDirectoryPath

public String getDatabaseDirectoryPath()

Returns the absolute path to the directory on the Android filesystem where databases are stored for the current application.

Returns:

the absolute path to the databases directory (example: "/data/data/com.example/databases")

getDatabasePath

public String getDatabasePath(String databaseName)

getVersionCode

public String getVersionCode()

getVersionName

public String getVersionName()