universum.studios.android.intent

Class SimpleIntent

java.lang.Object

universum.studios.android.intent.BaseIntent<SimpleIntent>

universum.studios.android.intent.SimpleIntent

public class SimpleIntent
extends BaseIntent<SimpleIntent>

A BaseIntent builder implementation providing API for building and starting of simple intents.

Activity that should be started by an intent can be specified via activityClass(Class). If you want to specify some intent flag, you can do so via flag(int) or flags(int).

If you want to start activity for some result, you can specify request code via requestCode(int).

Since:

1.0

Author:

Martin Albedinsky

Constructor Summary

Constructors

Constructor and Description
SimpleIntent()

Method Summary

Modifier and Type	Method and Description
String	action() Returns the intent action.
SimpleIntent	action(String action) Specifies an action that will be used to search for available activities (that can handle intent with such action) whenever this intent is started.
Class<? extends android.app.Activity>	activityClass() Returns the class of activity that will be launched.
SimpleIntent	activityClass(Class<? extends android.app.Activity> activityClass) Specifies class of an activity to be launched when this intent is started.
protected void	ensureCanBuildOrThrow() Called to ensure that this builder can build its Intent from its current data.
SimpleIntent	flag(int flag) Appends the specified flag to the current intent flags.
int	flags() Returns the intent flags.
SimpleIntent	flags(int flags) Sets flags for the intent to be started.
protected android.content.Intent	onBuild(android.content.Context context) Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.
protected boolean	onStartWith(IntentStarter starter, android.content.Intent intent) Invoked whenever BaseIntent.startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via BaseIntent.build(Context).
int	requestCode() Returns the request code used to start this intent for result.
SimpleIntent	requestCode(int requestCode) Sets a request code for the intent to be started.

Methods inherited from class universum.studios.android.intent.BaseIntent

activityNotFoundMessage, activityNotFoundMessage, build, cannotBuildIntentException, dialogTitle, dialogTitle, enterTransition, enterTransition, exitTransition, exitTransition, isActivityForIntentAvailable, notifyActivityNotFound, startWith, transitions

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleIntent

public SimpleIntent()

Method Detail

activityClass

public SimpleIntent activityClass(@NonNull
                                  Class<? extends android.app.Activity> activityClass)

Specifies class of an activity to be launched when this intent is started. See Intent.Intent(android.content.Context, Class) for more info.

Parameters:

activityClass - Class of the desired activity that should be launched. May be null to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

activityClass()

activityClass

@Nullable
public Class<? extends android.app.Activity> activityClass()

Returns the class of activity that will be launched.

Returns:

The class of activity or null if no activity class has been specified yet.

See Also:

activityClass(Class)

action

public SimpleIntent action(@NonNull
                           String action)

Specifies an action that will be used to search for available activities (that can handle intent with such action) whenever this intent is started. See Intent.Intent(String) for more info.

Default value: ""

Parameters:

action - The desired intent action. See Intent class for available actions.

Returns:

This intent builder to allow methods chaining.

See Also:

action()

action

@NonNull
public String action()

Returns the intent action.

Returns:

Intent action. See Intent class for allowed actions.

See Also:

action(String)

flags

public SimpleIntent flags(int flags)

Sets flags for the intent to be started. See Intent.setFlags(int) for more info.

Parameters:

flags - The desired flags for Intent. Use | to set multiple flags, like: Intent.FLAG_ACTIVITY_CLEAR_TASK | Intent.FLAG_ACTIVITY_NO_HISTORY .

Returns:

This intent builder to allow methods chaining.

See Also:

flags()

flag

public SimpleIntent flag(int flag)

Appends the specified flag to the current intent flags.

Parameters:

flag - The desired intent flag to append to the current ones.

Returns:

This intent builder to allow methods chaining.

See Also:

flags(int), flags()

flags

public int flags()

Returns the intent flags.

Returns:

Intent flags or 0 if no flags has been specified yet.

See Also:

flags(int)

requestCode

public SimpleIntent requestCode(int requestCode)

Sets a request code for the intent to be started.

Default value: -1

Parameters:

requestCode - The desired request code to start this intent for result. May be negative number to clear the current one.

Returns:

This intent builder to allow methods chaining.

See Also:

requestCode()

requestCode

public int requestCode()

Returns the request code used to start this intent for result.

Returns:

Intent request code.

See Also:

requestCode(int)

ensureCanBuildOrThrow

protected void ensureCanBuildOrThrow()

Description copied from class: BaseIntent

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 BaseIntent.cannotBuildIntentException(String).

Overrides:

ensureCanBuildOrThrow in class BaseIntent<SimpleIntent>

onBuild

@NonNull
protected android.content.Intent onBuild(@NonNull
                                                  android.content.Context context)

Description copied from class: BaseIntent

Invoked from BaseIntent.build(Context) after BaseIntent.ensureCanBuildOrThrow() to build intent specific for this intent builder from the current data.

Specified by:

onBuild in class BaseIntent<SimpleIntent>

Parameters:

context - Context obtained from the IntentStarter.

Returns:

Intent instance with current data.

onStartWith

protected boolean onStartWith(@NonNull
                              IntentStarter starter,
                              @NonNull
                              android.content.Intent intent)

Description copied from class: BaseIntent

Invoked whenever BaseIntent.startWith(IntentStarter) is called and there is an activity available that can handle the given intent that has been created via BaseIntent.build(Context).

This implementation always returns true.

Overrides:

onStartWith in class BaseIntent<SimpleIntent>

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.