BaseIntent (Android Intents API)

java.lang.Object
- universum.studios.android.intent.BaseIntent<I>

Type Parameters:

I - A type of the BaseIntent implementation to allow proper methods chaining.

Direct Known Subclasses:

CalendarIntent, ContentIntent, DialerIntent, EmailIntent, MapIntent, PlayIntent, ShareIntent, SimpleIntent, SmsIntent, WebIntent
```
public abstract class BaseIntent<I extends BaseIntent>
extends Object
```
A BaseIntent specifies base API for intent builders. Some Android intents require a lots of data to be supplied to them and the intent builders should provide API to simplify such a set up process.
Implementation
Implementations of the BaseIntent class need to implement these methods:
- build(Context)
  This method is called whenever startWith(IntentStarter) is invoked and a specific intent builder implementation should build here an intent which is for that type of intent builder specific and configure it with data supplied through its setters API.
- onStartWith(IntentStarter, Intent)
  It is not required to override this method. Default implementation of this method only starts the intent obtained via build(Context) method via IntentStarter.startIntent(Intent). If a specific intent builder implementation requires for example starting intent as activity for result, than it should be done within this method.
Activity transitions
BaseIntent class provides also API to supply activity transitions via enterTransition(int) and exitTransition(int). These transitions will be used whenever onStartWith(IntentStarter, Intent) is called using the intent starter's IntentStarter.overridePendingTransition(int, int).
Since:

1.0

Author:

Martin Albedinsky

Constructor Summary

Constructors
Constructor and Description

BaseIntent()

Constructors
Constructor and Description
`BaseIntent()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`CharSequence`	`activityNotFoundMessage()` Returns the message text for the toast that is shown in case, when there wasn't found any activity for the started intent.
`I`	`activityNotFoundMessage(CharSequence message)` Sets a message for the toast that is shown in case, when there wasn't found any activity that would handle the started intent.
`Intent`	`build(Context context)` Called to create an instance of `Intent` from the current data of this intent builder.
`protected IllegalArgumentException`	`cannotBuildIntentException(String message)` Creates an instance of `IllegalArgumentException` indicating that one of required parameters for this intent builder has not been specified, but `build(Context)` has been invoked.
`CharSequence`	`dialogTitle()` Returns the title text for the chooser dialog.
`I`	`dialogTitle(CharSequence title)` Sets a title for the chooser dialog.
`protected void`	`ensureCanBuildOrThrow()` Called to ensure that this builder can build its Intent from its current data.
`int`	`enterTransition()` Returns the window enter transition used to override window's pending transition.
`I`	`enterTransition(int transition)` Sets a window transition used to override default pending window enter transition when starting this intent.
`int`	`exitTransition()` Returns the window exit transition used to override window's pending transition.
`I`	`exitTransition(int transition)` Sets a window transition used to override default pending window exit transition when starting this intent.
`static boolean`	`isActivityForIntentAvailable(Context context, Intent intent)` Checks whether there is any activity that can handle the specified `intent` available on the current Android device.
`protected void`	`notifyActivityNotFound(Context context)` Notifies situation that there wasn't found any activity to handle the started intent.
`protected abstract Intent`	`onBuild(Context context)` Invoked from `build(Context)` after `ensureCanBuildOrThrow()` to build intent specific for this intent builder from the current data.
`protected boolean`	`onStartWith(IntentStarter starter, Intent intent)` Invoked whenever `startWith(IntentStarter)` is called and there is an activity available that can handle the given `intent` that has been created via `build(Context)`.
`boolean`	`startWith(IntentStarter starter)` Starts na intent specific for this intent builder created via `build(Context)` using the given intent `starter`.
`I`	`transitions(int enterTransition, int exitTransition)` Sets both, enter + exit, window transitions used to override default pending window transition when starting this intent.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BaseIntent
```
public BaseIntent()
```
- Method Detail
  - dialogTitle
```
public I dialogTitle(@Nullable
                     CharSequence title)
```
    Sets a title for the chooser dialog.
    Default value: Choose
    
    Parameters:
    
    title - The desired dialog title text. May be null to clear the current one.
    
    Returns:
    
    This intent builder to allow methods chaining.
    
    See Also:
    
    dialogTitle()
  - dialogTitle
```
@NonNull
public CharSequence dialogTitle()
```
    Returns the title text for the chooser dialog.
    
    Returns:
    
    Title text.
  - activityNotFoundMessage
```
public I activityNotFoundMessage(@Nullable
                                 CharSequence message)
```
    Sets a message for the toast that is shown in case, when there wasn't found any activity that would handle the started intent.
    
    Parameters:
    
    message - The desired message text. May be null to clear the current one.
    
    Returns:
    
    This intent builder to allow methods chaining.
    
    See Also:
    
    activityNotFoundMessage()
  - activityNotFoundMessage
```
@NonNull
public CharSequence activityNotFoundMessage()
```
    Returns the message text for the toast that is shown in case, when there wasn't found any activity for the started intent.
    
    Returns:
    
    Message text.
    
    See Also:
    
    activityNotFoundMessage(CharSequence)
  - enterTransition
```
public I enterTransition(@AnimRes
                         int transition)
```
    Sets a window transition used to override default pending window enter transition when starting this intent.
    See Activity.overridePendingTransition(int, int) for more info.
    
    Parameters:
    
    transition - Resource id of the desired window transition (animation).
    
    Returns:
    
    This intent builder to allow methods chaining.
    
    See Also:
    
    enterTransition()
  - enterTransition
```
@AnimRes
public int enterTransition()
```
    Returns the window enter transition used to override window's pending transition.
    
    Returns:
    
    Resource id of the enter transition or 0 if there was no transition specified.
    
    See Also:
    
    enterTransition(int)
  - exitTransition
```
public I exitTransition(@AnimRes
                        int transition)
```
    Sets a window transition used to override default pending window exit transition when starting this intent.
    See Activity.overridePendingTransition(int, int) for more info.
    
    Parameters:
    
    transition - Resource id of the desired window transition (animation).
    
    Returns:
    
    This intent builder to allow methods chaining.
    
    See Also:
    
    exitTransition()
  - exitTransition
```
@AnimRes
public int exitTransition()
```
    Returns the window exit transition used to override window's pending transition.
    
    Returns:
    
    Resource id of the enter transition or 0 if there was no transition specified.
    
    See Also:
    
    exitTransition(int)
  - transitions
```
public I transitions(@AnimRes
                     int enterTransition,
                     @AnimRes
                     int exitTransition)
```
    Sets both, enter + exit, window transitions used to override default pending window transition when starting this intent.
    
    Parameters:
    
    enterTransition - Resource id of the desired window enter transition (animation). May be 0 to not play any enter animation.
    
    exitTransition - Resource id of the desired window exit transition (animation). May be 0 to not play any enter animation.
    
    Returns:
    
    This intent builder to allow methods chaining.
    
    See Also:
    
    enterTransition(int), exitTransition(int)
  - startWith
```
public boolean startWith(@NonNull
                         IntentStarter starter)
```
    Starts na intent specific for this intent builder created via build(Context) using the given intent starter.
    
    Parameters:
    
    starter - The desired starter to be used to start the intent. See IntentStarters for default available starters.
    
    Returns:
    
    True if the intent has been successfully started, false otherwise.
  - build
```
@NonNull
public Intent build(@NonNull
                             Context context)
```
    Called to create an instance of Intent from the current data of this intent builder.
    
    Parameters:
    
    context - Context obtained from the IntentStarter.
    
    Returns:
    
    An instance of Intent specific for this intent builder.
    
    Throws:
    
    IllegalArgumentException - If this builder does not have all required data to build the requested intent.
  - ensureCanBuildOrThrow
```
protected void ensureCanBuildOrThrow()
```
    Called to ensure that this builder can build its Intent from its current data.
    If there are some required data missing/not specified, an exception indicating such state should be thrown. The default exception may be created via cannotBuildIntentException(String).
  - onBuild
```
@NonNull
protected abstract Intent onBuild(@NonNull
                                           Context context)
```
    Invoked from build(Context) after ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.
    
    Parameters:
    
    context - Context obtained from the IntentStarter.
    
    Returns:
    
    Intent instance with current data.
  - isActivityForIntentAvailable
```
@CheckResult
public static boolean isActivityForIntentAvailable(@NonNull
                                                                Context context,
                                                                @NonNull
                                                                Intent intent)
```
    Checks whether there is any activity that can handle the specified intent available on the current Android device.
    
    Parameters:
    
    context - Context used to obtain package manager.
    
    intent - The intent for which to resolve activity.
    
    Returns:
    
    True if activity for the intent has been resolved/found, false otherwise which means that there is no activity currently installed on the current Android device that could handle that intent.
  - cannotBuildIntentException
```
protected final IllegalArgumentException cannotBuildIntentException(@NonNull
                                                                    String message)
```
    Creates an instance of IllegalArgumentException indicating that one of required parameters for this intent builder has not been specified, but build(Context) has been invoked.
    
    Parameters:
    
    message - Message to be included into exception.
  - onStartWith
```
protected boolean onStartWith(@NonNull
                              IntentStarter starter,
                              @NonNull
                              Intent intent)
```
    Invoked whenever startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via build(Context).
    This implementation always returns true.
    
    Parameters:
    
    starter - The starter with which to start the intent.
    
    intent - The intent instance created by this intent builder.
    
    Returns:
    
    True to indicate that the intent has been started, false otherwise.
  - notifyActivityNotFound
```
protected void notifyActivityNotFound(@NonNull
                                      Context context)
```
    Notifies situation that there wasn't found any activity to handle the started intent.
    This implementation by default shows a toast with the message specified via activityNotFoundMessage(CharSequence), if any.
    
    Parameters:
    
    context - The context obtained from the IntentStarter.
    
    See Also:
    
    activityNotFoundMessage(CharSequence)

Class BaseIntent<I extends BaseIntent>

Implementation

Activity transitions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseIntent

Method Detail

dialogTitle

dialogTitle

activityNotFoundMessage

activityNotFoundMessage

enterTransition

enterTransition

exitTransition

exitTransition

transitions

startWith

build

ensureCanBuildOrThrow

onBuild

isActivityForIntentAvailable

cannotBuildIntentException

onStartWith

notifyActivityNotFound