net.zer0bandwidth.android.lib.content

Class IntentUtils

java.lang.Object

net.zer0bandwidth.android.lib.content.IntentUtils

Direct Known Subclasses:

IntentUtils

public class IntentUtils
extends java.lang.Object

Provides utilities for dealing with intents.

Since:

zer0bandwidth-net/android 0.0.1 (#5), moved in 0.0.4 (#13)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IntentUtils.FilterFormatException Exception thrown when a call to one of the intent filter creation methods encounters a problem with one or more arguments.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ACTION_FORMAT The default action name format to be used with getActionListIntentFilter(java.lang.String, java.lang.String, java.lang.String...).
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor and Description
IntentUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	discoverAction(android.content.Intent sig) Discovers the action inscribed into the intent, if any, and logs the result before returning it to the caller.
static android.content.IntentFilter	getActionListIntentFilter(java.lang.String sDomain, java.util.Collection<java.lang.String> asActions) Constructs an IntentFilter for all actions that would be assembled from the specified domain and action list.
static android.content.IntentFilter	getActionListIntentFilter(java.lang.String sDomain, java.lang.String... asActions) Constructs an IntentFilter for all actions that would be assembled from the specified domain and action list.
static android.content.IntentFilter	getActionListIntentFilter(java.lang.String sFormat, java.lang.String sDomain, java.util.Collection<java.lang.String> asActions) Constructs an IntentFilter for all actions that would be assembled from the specified format string, domain, and action list.
static android.content.IntentFilter	getActionListIntentFilter(java.lang.String sCustomFormat, java.lang.String sDomain, java.lang.String... asActions) Constructs an IntentFilter for all actions that would be assembled from the specified format string, domain, and action list.
static android.content.Intent	getBoundIntent(android.content.Context ctx, java.lang.Class<?> cls) Tries to get an Intent that is bound to the specified class, which is expected to process that intent.
static android.content.Intent	getBoundIntent(android.content.Context ctx, java.lang.Class<?> cls, java.lang.String sAction) Tries to get an Intent that is bound to the specified class, which is expected to process that intent.

Methods inherited from class java.lang.Object

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

Field Detail

TAG

public static final java.lang.String TAG

DEFAULT_ACTION_FORMAT

public static final java.lang.String DEFAULT_ACTION_FORMAT

The default action name format to be used with getActionListIntentFilter(java.lang.String, java.lang.String, java.lang.String...). It has two placeholders; one for the intent filter's "domain" and the other for each action token.

Since:

zer0bandwidth-net/android 0.1.7 (#50)

See Also:

Constant Field Values

Constructor Detail

IntentUtils

public IntentUtils()

Method Detail

discoverAction

public static java.lang.String discoverAction(android.content.Intent sig)

Discovers the action inscribed into the intent, if any, and logs the result before returning it to the caller.

Parameters:

sig - the intent to be examined

Returns:

the action discovered if any

getBoundIntent

public static android.content.Intent getBoundIntent(android.content.Context ctx,
                                                    java.lang.Class<?> cls)

Tries to get an Intent that is bound to the specified class, which is expected to process that intent. If the context is null, then the method will still return an intent, but it will not be successfully bound.

Parameters:

ctx - the context in which to create the intent

cls - the class that is expected to process the intent

Returns:

the intent

Since:

zer0bandwidth-net/android 0.0.2 (#8)

getBoundIntent

public static android.content.Intent getBoundIntent(android.content.Context ctx,
                                                    java.lang.Class<?> cls,
                                                    java.lang.String sAction)

Tries to get an Intent that is bound to the specified class, which is expected to process that intent. If the context is null, then the method will still return an intent, but it will not be bound to the specified class. That intent is then inscribed with a specific action.

Parameters:

ctx - the context in which to create the intent

cls - the class that is expected to process the intent

sAction - the action to be inscribed into the intent

Returns:

the intent

Since:

zer0bandwidth-net/android 0.0.2 (#8)

getActionListIntentFilter

public static android.content.IntentFilter getActionListIntentFilter(java.lang.String sCustomFormat,
                                                                     java.lang.String sDomain,
                                                                     java.lang.String... asActions)
                                                              throws IntentUtils.FilterFormatException

Constructs an IntentFilter for all actions that would be assembled from the specified format string, domain, and action list.

Parameters:

sCustomFormat - a format string to be applied to the intent domain and action names

sDomain - the domain under which the intents will be recognized; this is typically a package or class name

asActions - the list of actions to be written to the filter

Returns:

an intent filter for the specified actions

Throws:

IntentUtils.FilterFormatException - if the domain string or action list is not usable

Since:

zer0bandwidth-net/android 0.1.7 (#50)

getActionListIntentFilter

public static android.content.IntentFilter getActionListIntentFilter(java.lang.String sFormat,
                                                                     java.lang.String sDomain,
                                                                     java.util.Collection<java.lang.String> asActions)
                                                              throws IntentUtils.FilterFormatException

Constructs an IntentFilter for all actions that would be assembled from the specified format string, domain, and action list.

Parameters:

sFormat - a format string to be applied to the intent domain and action names

sDomain - the domain under which the intents will be recognized; this is typically a package or class name

asActions - the list of actions to be written to the filter

Returns:

an intent filter for the specified actions

Throws:

IntentUtils.FilterFormatException - if the domain string or action list is not usable

Since:

zer0bandwidth-net/android 0.1.7 (#50)

getActionListIntentFilter

public static android.content.IntentFilter getActionListIntentFilter(java.lang.String sDomain,
                                                                     java.lang.String... asActions)
                                                              throws IntentUtils.FilterFormatException

Constructs an IntentFilter for all actions that would be assembled from the specified domain and action list. Each action token is inserted along with the domain string into the DEFAULT_ACTION_FORMAT specification.

Parameters:

sDomain - the domain under which the intents will be recognized; recognized; this is typically a package or class name

asActions - the list of actions to be written to the filter

Returns:

an intent filter for the specified actions

Throws:

IntentUtils.FilterFormatException - if the domain string or action list is unusable

Since:

zer0bandwidth-net/android 0.1.7 (#50)

getActionListIntentFilter

public static android.content.IntentFilter getActionListIntentFilter(java.lang.String sDomain,
                                                                     java.util.Collection<java.lang.String> asActions)
                                                              throws IntentUtils.FilterFormatException

Constructs an IntentFilter for all actions that would be assembled from the specified domain and action list. Each action token is inserted along with the domain string into the DEFAULT_ACTION_FORMAT specification.

Parameters:

sDomain - the domain under which the intents will be recognized; this is typically a package or class name

asActions - the list of actions to be written to the filter

Returns:

an intent filter for the specified actions

Throws:

IntentUtils.FilterFormatException - if the domain string or action list is unusable

Since:

zer0bandwidth-net/android 0.1.7 (#50)