net.zer0bandwidth.android.lib.app

Class Managers

java.lang.Object

net.zer0bandwidth.android.lib.app.Managers

public class Managers
extends java.lang.Object

Provides instances of Android OS managers. This class is largely irrelevant after Android API 23, which adds the new getSystemService(Class) method to the Context class. System service classes added after Android API 23 are not supported by this class; if you are using a system service added after API 23, then you should consider this class deprecated and use the new method in Context instead. For backward compatibility from Android API 14 onward, the class provides constant values for all static manager tags that were added to Context after API 14.

Since:

zer0bandwidth-net/android 0.1.3 (#29)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP_OPS_SERVICE Backward-compatibility constant for Context.APP_OPS_SERVICE (added in Android API 19)
static java.lang.String	APPWIDGET_SERVICE Backward-compatibility constant for Context.APPWIDGET_SERVICE (added in Android API 21)
static java.lang.String	BATTERY_SERVICE Backward-compatibility constant for Context.BATTERY_SERVICE (added in Android API 21)
static java.lang.String	BLUETOOTH_SERVICE Backward-compatibility constant for Context.BLUETOOTH_SERVICE (added in Android API 18)
static java.lang.String	CAMERA_SERVICE Backward-compatibility constant for Context.CAMERA_SERVICE (added in Android API 21)
static java.lang.String	CAPTIONING_SERVICE Backward-compatibility constant for Context.CAPTIONING_SERVICE (added in Android API 19)
static java.lang.String	CONSUMER_IR_SERVICE Backward-compatibility constant for Context.CONSUMER_IR_SERVICE (added in Android API 19)
static java.lang.String	DISPLAY_SERVICE Backward-compatibility constant for Context.DISPLAY_SERVICE (added in Android API 17)
static java.lang.String	INPUT_SERVICE Backward-compatibility constant for Context.INPUT_SERVICE (added in Android API 16)
static java.lang.String	JOB_SCHEDULER_SERVICE Backward-compatibility constant for Context.JOB_SCHEDULER_SERVICE (added in Android API 21)
static java.lang.String	LAUNCHER_APPS_SERVICE Backward-compatibility constant for Context.LAUNCHER_APPS_SERVICE (added in Android API 21)
protected static java.lang.String	LOG_TAG
static java.lang.String	MEDIA_PROJECTION_SERVICE Backward-compatibility constant for Context.MEDIA_PROJECTION_SERVICE (added in Android API 21)
static java.lang.String	MEDIA_ROUTER_SERVICE Backward-compatibility constant for Context.MEDIA_ROUTER_SERVICE (added in Android API 16)
static java.lang.String	MEDIA_SESSION_SERVICE Backward-compatibility constant for Context.MEDIA_SESSION_SERVICE (added in Android API 21)
static java.lang.String	NSD_SERVICE Backward-compatibility constant for Context.NSD_SERVICE (added in Android API 16)
static java.lang.String	PRINT_SERVICE Backward-compatibility constant for Context.PRINT_SERVICE (added in Android API 19)
static java.lang.String	RESTRICTIONS_SERVICE Backward-compatibility constant for Context.RESTRICTIONS_SERVICE (added in Android API 21)
static java.util.HashMap<java.lang.Class<?>,java.lang.String>	REVERSE_MAP Defines a reverse mapping from class definitions to the constants by which they are identified in Context.
static java.lang.String	TELECOM_SERVICE Backward-compatibility constant for Context.TELECOM_SERVICE (added in Android API 21)
static java.lang.String	TELEPHONY_SUBSCRIPTION_SERVICE Backward-compatibility constant for Context.TELECOM_SUBSCRIPTION_SERVICE (added in Android API 22)
static java.lang.String	TV_INPUT_SERVICE Backward-compatibility constant for Context.TV_INPUT_SERVICE (added in Android API 21)
static java.lang.String	USAGE_STATS_SERVICE Backward-compatibility constant for Context.USAGE_STATS_SERVICE (added in Android API 22)
static java.lang.String	USER_SERVICE Backward-compatibility constant for Context.USER_SERVICE (added in Android API 17)

Constructor Summary

Constructors

Constructor and Description
Managers()

Method Summary

Modifier and Type	Method and Description
static <MGR> MGR	get(android.content.Context ctx, java.lang.Class<MGR> cls) Obtains an instance of the Android OS service whose class is given.
protected static void	initReverseMap(int nVersion) Initializes the reverse mapping of manager classes to constants from the Context class.
static <MGR> MGR	tryToGet(android.content.Context ctx, java.lang.Class<MGR> cls) As get(android.content.Context, java.lang.Class<MGR>), but executes the action inside a try&hellip;catch structure, returning null if an exception is thrown

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final java.lang.String LOG_TAG

INPUT_SERVICE

public static final java.lang.String INPUT_SERVICE

Backward-compatibility constant for Context.INPUT_SERVICE (added in Android API 16)

See Also:

Constant Field Values

MEDIA_ROUTER_SERVICE

public static final java.lang.String MEDIA_ROUTER_SERVICE

Backward-compatibility constant for Context.MEDIA_ROUTER_SERVICE (added in Android API 16)

See Also:

Constant Field Values

NSD_SERVICE

public static final java.lang.String NSD_SERVICE

Backward-compatibility constant for Context.NSD_SERVICE (added in Android API 16)

See Also:

Constant Field Values

DISPLAY_SERVICE

public static final java.lang.String DISPLAY_SERVICE

Backward-compatibility constant for Context.DISPLAY_SERVICE (added in Android API 17)

See Also:

Constant Field Values

USER_SERVICE

public static final java.lang.String USER_SERVICE

Backward-compatibility constant for Context.USER_SERVICE (added in Android API 17)

See Also:

Constant Field Values

BLUETOOTH_SERVICE

public static final java.lang.String BLUETOOTH_SERVICE

Backward-compatibility constant for Context.BLUETOOTH_SERVICE (added in Android API 18)

See Also:

Constant Field Values

APP_OPS_SERVICE

public static final java.lang.String APP_OPS_SERVICE

Backward-compatibility constant for Context.APP_OPS_SERVICE (added in Android API 19)

See Also:

Constant Field Values

CAPTIONING_SERVICE

public static final java.lang.String CAPTIONING_SERVICE

Backward-compatibility constant for Context.CAPTIONING_SERVICE (added in Android API 19)

See Also:

Constant Field Values

CONSUMER_IR_SERVICE

public static final java.lang.String CONSUMER_IR_SERVICE

Backward-compatibility constant for Context.CONSUMER_IR_SERVICE (added in Android API 19)

See Also:

Constant Field Values

PRINT_SERVICE

public static final java.lang.String PRINT_SERVICE

Backward-compatibility constant for Context.PRINT_SERVICE (added in Android API 19)

See Also:

Constant Field Values

APPWIDGET_SERVICE

public static final java.lang.String APPWIDGET_SERVICE

Backward-compatibility constant for Context.APPWIDGET_SERVICE (added in Android API 21)

See Also:

Constant Field Values

BATTERY_SERVICE

public static final java.lang.String BATTERY_SERVICE

Backward-compatibility constant for Context.BATTERY_SERVICE (added in Android API 21)

See Also:

Constant Field Values

CAMERA_SERVICE

public static final java.lang.String CAMERA_SERVICE

Backward-compatibility constant for Context.CAMERA_SERVICE (added in Android API 21)

See Also:

Constant Field Values

JOB_SCHEDULER_SERVICE

public static final java.lang.String JOB_SCHEDULER_SERVICE

Backward-compatibility constant for Context.JOB_SCHEDULER_SERVICE (added in Android API 21)

See Also:

Constant Field Values

LAUNCHER_APPS_SERVICE

public static final java.lang.String LAUNCHER_APPS_SERVICE

Backward-compatibility constant for Context.LAUNCHER_APPS_SERVICE (added in Android API 21)

See Also:

Constant Field Values

MEDIA_PROJECTION_SERVICE

public static final java.lang.String MEDIA_PROJECTION_SERVICE

Backward-compatibility constant for Context.MEDIA_PROJECTION_SERVICE (added in Android API 21)

See Also:

Constant Field Values

MEDIA_SESSION_SERVICE

public static final java.lang.String MEDIA_SESSION_SERVICE

Backward-compatibility constant for Context.MEDIA_SESSION_SERVICE (added in Android API 21)

See Also:

Constant Field Values

RESTRICTIONS_SERVICE

public static final java.lang.String RESTRICTIONS_SERVICE

Backward-compatibility constant for Context.RESTRICTIONS_SERVICE (added in Android API 21)

See Also:

Constant Field Values

TELECOM_SERVICE

public static final java.lang.String TELECOM_SERVICE

Backward-compatibility constant for Context.TELECOM_SERVICE (added in Android API 21)

See Also:

Constant Field Values

TV_INPUT_SERVICE

public static final java.lang.String TV_INPUT_SERVICE

Backward-compatibility constant for Context.TV_INPUT_SERVICE (added in Android API 21)

See Also:

Constant Field Values

TELEPHONY_SUBSCRIPTION_SERVICE

public static final java.lang.String TELEPHONY_SUBSCRIPTION_SERVICE

Backward-compatibility constant for Context.TELECOM_SUBSCRIPTION_SERVICE (added in Android API 22)

See Also:

Constant Field Values

USAGE_STATS_SERVICE

public static final java.lang.String USAGE_STATS_SERVICE

Backward-compatibility constant for Context.USAGE_STATS_SERVICE (added in Android API 22)

See Also:

Constant Field Values

REVERSE_MAP

public static java.util.HashMap<java.lang.Class<?>,java.lang.String> REVERSE_MAP

Defines a reverse mapping from class definitions to the constants by which they are identified in Context. Where those constants are not defined until later API versions, the map instead uses one of the compatibility constants defined in this class.

Documentation Conflicts

The following errors in the Android API documentation for Context were observed during unit testing.

Context Token	Documented Class	Actual Class	Resolution
Context.SENSOR_SERVICE	SensorManager	android.hardware.SystemSensorManager	The actual class is assignable.
Context.WALLPAPER_SERVICE	android.service.wallpaper.WallpaperService	WallpaperManager	The returned class is not assignable; the map uses WallpaperManager instead of WallpaperService.

This map is instantiated only when the app's API version is lower than 23. When greater than 23, the get(android.content.Context, java.lang.Class<MGR>) method will simply call the existing getSystemService(Class) method in the API 23+ version of Context, so the map would not need to be populated.

See Also:

Context

Constructor Detail

Managers

public Managers()

Method Detail

initReverseMap

protected static void initReverseMap(int nVersion)

Initializes the reverse mapping of manager classes to constants from the Context class. Invoked by a static initializer for the class itself; the method is not intended to be called directly, except in unit testing scenarios.

Parameters:

nVersion - (since 0.2.1/#53) the environment's current SDK version; passed in as a parameter solely to support testing. See how this is used "normally" in the static initializer.

get

public static <MGR> MGR get(android.content.Context ctx,
                            java.lang.Class<MGR> cls)

Obtains an instance of the Android OS service whose class is given. If the app's API version is already 23 or higher, then the method will simply call the new getSystemService(Class) method instead of executing its own compatibility logic. The return value of this method is already an instance of the type specified in the parameter; there is no need for additional typecasting after the instance is returned to the caller. This is exactly how the getSystemService(Class) method works in the API 23+ version of Context.

Type Parameters:

MGR - the class to be obtained, as a generic return type

Parameters:

ctx - the context in which to obtain the service

cls - the class to be obtained, as a parameter

Returns:

an instance of the specified class, or null if the system does not return an instance

tryToGet

public static <MGR> MGR tryToGet(android.content.Context ctx,
                                 java.lang.Class<MGR> cls)

As get(android.content.Context, java.lang.Class<MGR>), but executes the action inside a try…catch structure, returning null if an exception is thrown

Type Parameters:

MGR - the class to be obtained, as a generic return type

Parameters:

ctx - the context in which to obtain the service

cls - the class to be obtained, as a parameter

Returns:

an instance of the specified class, or null if the system does not return an instance, or null if an exception occurred