ru.noties.requirements

Class RequirementCase<T>

java.lang.Object

ru.noties.requirements.RequirementCase<T>

Direct Known Subclasses:

PermissionCase

public abstract class RequirementCase<T>
extends java.lang.Object

Represents stateless requirement case.

Library provides a subclass for easier interaction with Android Permissions, see: PermissionCase

Changed in 1.1.0: added type parameter to indicate `target` of this requirement case

See Also:

meetsRequirement(), startResolution(), PermissionCase

Constructor Summary

Constructors

Constructor and Description
RequirementCase()

Method Summary

Modifier and Type	Method and Description
protected android.app.Activity	activity()
protected android.content.Context	appContext()
void	attach(EventDispatcher<T> dispatcher, ru.noties.requirements.RequirementCase.Callback callback)
protected boolean	checkSelfPermission(java.lang.String permission)
protected void	deliverResult(boolean result) Call this method after resolution has finished (in whatever case: success or cancellation)
protected void	deliverResult(boolean result, Payload payload) Call this method after resolution has finished (in whatever case: success or cancellation)
void	detach()
abstract boolean	meetsRequirement() Synchronous method to check if requirement is satisfied
boolean	onActivityResult(int requestCode, int resultCode, android.content.Intent data) Please override this method if your RequirementCase need to receive `onActivityResult` event
boolean	onRequestPermissionsResult(int requestCode, java.lang.String[] permissions, int[] grantResults) Please override this method if your RequirementCase need to receive `onRequestPermissionsResult` event
protected void	requestPermission(java.lang.String permission, int requestCode)
protected boolean	shouldShowRequestPermissionRationale(java.lang.String permission)
protected void	startActivityForResult(android.content.Intent intent, int requestCode)
abstract void	startResolution() Starts requirement resolution process.
protected T	target()

Methods inherited from class java.lang.Object

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

Constructor Detail

RequirementCase

public RequirementCase()

Method Detail

meetsRequirement

public abstract boolean meetsRequirement()

Synchronous method to check if requirement is satisfied

Returns:

a boolean indicating if this requirement is satisfied

startResolution

public abstract void startResolution()

Starts requirement resolution process. This method will be called only if meetsRequirement() returns false

attach

public final void attach(EventDispatcher<T> dispatcher,
                         ru.noties.requirements.RequirementCase.Callback callback)

detach

public final void detach()

onActivityResult

public boolean onActivityResult(int requestCode,
                                int resultCode,
                                android.content.Intent data)

Please override this method if your RequirementCase need to receive `onActivityResult` event

Returns:

boolean indicating if this event was consumed

onRequestPermissionsResult

public boolean onRequestPermissionsResult(int requestCode,
                                          java.lang.String[] permissions,
                                          int[] grantResults)

Please override this method if your RequirementCase need to receive `onRequestPermissionsResult` event

Returns:

boolean indicating if this event was consumed

appContext

protected android.content.Context appContext()

Returns:

application Context (only if this case is attached)

activity

protected android.app.Activity activity()

Returns:

Activity to which this requirement case currently attached

target

protected T target()

Returns:

target of this requirement case

Since:

1.1.0

See Also:

EventDispatcher.target()

deliverResult

protected void deliverResult(boolean result)

Call this method after resolution has finished (in whatever case: success or cancellation)

Parameters:

result - true for success, false for failure

Since:

1.0.1

deliverResult

protected void deliverResult(boolean result,
                             Payload payload)

Call this method after resolution has finished (in whatever case: success or cancellation)

Parameters:

result - true for success, false for failure

payload - Payload to identify _error_ state. Please note that it will be ignored in case of success result

Since:

1.0.1

startActivityForResult

protected void startActivityForResult(android.content.Intent intent,
                                      int requestCode)

requestPermission

protected void requestPermission(java.lang.String permission,
                                 int requestCode)

checkSelfPermission

protected boolean checkSelfPermission(java.lang.String permission)

shouldShowRequestPermissionRationale

protected boolean shouldShowRequestPermissionRationale(java.lang.String permission)