reactiveairplanemode.pwittchen.github.com.library

Class ReactiveAirplaneMode

java.lang.Object

reactiveairplanemode.pwittchen.github.com.library.ReactiveAirplaneMode

public class ReactiveAirplaneMode
extends java.lang.Object

ReactiveAirplaneMode is an Android library listening airplane mode with RxJava Observables.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	INTENT_EXTRA_STATE

Method Summary

Modifier and Type	Method and Description
protected void	checkContextIsNotNull(android.content.Context context) Validation method, which checks if context of the Activity or Application is not null
static ReactiveAirplaneMode	create() Creates an instance of ReactiveAirplaneMode class
protected android.content.BroadcastReceiver	createBroadcastReceiver(<any> emitter) Creates BroadcastReceiver for monitoring airplane mode
protected android.content.IntentFilter	createIntentFilter() Creates IntentFilter for BroadcastReceiver
<any>	get(android.content.Context context) Gets airplane mode state wrapped within a Single type
<any>	getAndObserve(android.content.Context context) Emits current state of the Airplane Mode in the beginning of the subscription and then Observes Airplane Mode state of the device with BroadcastReceiver.
boolean	isAirplaneModeOn(android.content.Context context) Checks airplane mode once basing on the system settings.
<any>	observe(android.content.Context context) Observes Airplane Mode state of the device with BroadcastReceiver.
protected void	onError(java.lang.String message, java.lang.Exception exception) Handles errors which occurs within this class
protected void	tryToUnregisterReceiver(android.content.BroadcastReceiver receiver, android.content.Context context) Tries to unregister BroadcastReceiver.

Methods inherited from class java.lang.Object

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

Field Detail

INTENT_EXTRA_STATE

protected static final java.lang.String INTENT_EXTRA_STATE

See Also:

Constant Field Values

Method Detail

create

public static ReactiveAirplaneMode create()

Creates an instance of ReactiveAirplaneMode class

Returns:

ReactiveAirplaneMode object

getAndObserve

public <any> getAndObserve(android.content.Context context)

Emits current state of the Airplane Mode in the beginning of the subscription and then Observes Airplane Mode state of the device with BroadcastReceiver. RxJava2 Observable emits true if the airplane mode turns on and false otherwise.

Parameters:

context - of the Application or Activity

Returns:

RxJava2 Observable with Boolean value indicating state of the airplane mode

observe

public <any> observe(android.content.Context context)

Observes Airplane Mode state of the device with BroadcastReceiver. RxJava2 Observable emits true if the airplane mode turns on and false otherwise.

Parameters:

context - of the Application or Activity

Returns:

RxJava2 Observable with Boolean value indicating state of the airplane mode

createIntentFilter

protected android.content.IntentFilter createIntentFilter()

Creates IntentFilter for BroadcastReceiver

Returns:

IntentFilter

createBroadcastReceiver

protected android.content.BroadcastReceiver createBroadcastReceiver(<any> emitter)

Creates BroadcastReceiver for monitoring airplane mode

Parameters:

emitter - for RxJava

Returns:

BroadcastReceiver

tryToUnregisterReceiver

protected void tryToUnregisterReceiver(android.content.BroadcastReceiver receiver,
                                       android.content.Context context)

Tries to unregister BroadcastReceiver. Calls onError(java.lang.String, java.lang.Exception) method if receiver was already unregistered

Parameters:

receiver - BroadcastReceiver

context - of the Application or Activity

onError

protected void onError(java.lang.String message,
                       java.lang.Exception exception)

Handles errors which occurs within this class

Parameters:

message - with an error

exception - which occurred

get

public <any> get(android.content.Context context)

Gets airplane mode state wrapped within a Single type

Parameters:

context - of the Application or Activity

Returns:

RxJava2 Single with Boolean value indicating state of the airplane mode

isAirplaneModeOn

public boolean isAirplaneModeOn(android.content.Context context)

Checks airplane mode once basing on the system settings. Returns true if airplane mode is on or false otherwise.

Parameters:

context - of the Activity or Application

Returns:

boolean value indicating state of the airplane mode.

checkContextIsNotNull

protected void checkContextIsNotNull(android.content.Context context)

Validation method, which checks if context of the Activity or Application is not null

Parameters:

context - of the Activity or application