com.box.androidsdk.preview.ext

Class BoxThreadPoolExecutorActivity

java.lang.Object

AppCompatActivity

com.box.androidsdk.preview.ext.BoxThreadPoolExecutorActivity

Direct Known Subclasses:

BoxPreviewActivity

public abstract class BoxThreadPoolExecutorActivity
extends AppCompatActivity

Base class for all activities that make API requests through the Box Content SDK. This class is responsible for showing a loading spinner while a request is executing and then hiding it when the request is complete. All BoxRequest tasks should be submitted to getApiExecutor and then handled by overriding handleBoxResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ACTION_ENDING_TASK
protected static java.lang.String	ACTION_STARTING_TASK
protected static int	DEFAULT_TIMEOUT
static java.lang.String	EXTRA_ITEM
static java.lang.String	EXTRA_USER_ID
protected BoxItem	mItem
protected BoxSession	mSession

Constructor Summary

Constructors

Constructor and Description
BoxThreadPoolExecutorActivity()

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.util.concurrent.ThreadPoolExecutor	createTaskMessagingExecutor(android.app.Application application, java.util.Queue<BoxResponse> responseQueue) Creates a static ThreadPoolExecutor that is meant to be used in getApiExecutor.
protected void	dismissSpinner() Dismisses the spinner if it is currently showing
abstract java.util.concurrent.ThreadPoolExecutor	getApiExecutor(android.app.Application application) Returns the api executor for the activity
protected BoxItem	getMainItem() Convenient accessor for the BoxItem that will be interacted with
abstract java.util.Queue<BoxResponse>	getResponseQueue() Returns the queue that is used for holding the responses of completed com.box.androidsdk.content.requests.BoxRequest
protected abstract void	handleBoxResponse(BoxResponse response) Handler that will be called after a BoxRequest completes.
protected boolean	isTaskInProgress() Checks if the API executor currently ahs a task in progress
protected void	onCreate(android.os.Bundle savedInstanceState)
protected void	onDestroy()
protected void	onSaveInstanceState(android.os.Bundle outState)
protected void	resumeSpinnerIfNecessary() Check to see if the threadpool executor is currently in the middle of a task and if so, show a spinner dialog again.
protected void	setMainItem(BoxItem boxItem) Sets the main BoxItem that will be interacted with
protected void	showSpinner() Shows the spinner with the default wait messaging
protected void	showSpinner(int stringTitleRes, int stringRes) Shows the spinner with a custom title and description

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_ITEM

public static final java.lang.String EXTRA_ITEM

See Also:

Constant Field Values

EXTRA_USER_ID

public static final java.lang.String EXTRA_USER_ID

See Also:

Constant Field Values

mSession

protected BoxSession mSession

mItem

protected BoxItem mItem

DEFAULT_TIMEOUT

protected static final int DEFAULT_TIMEOUT

See Also:

Constant Field Values

ACTION_STARTING_TASK

protected static final java.lang.String ACTION_STARTING_TASK

See Also:

Constant Field Values

ACTION_ENDING_TASK

protected static final java.lang.String ACTION_ENDING_TASK

See Also:

Constant Field Values

Constructor Detail

BoxThreadPoolExecutorActivity

public BoxThreadPoolExecutorActivity()

Method Detail

onCreate

protected void onCreate(android.os.Bundle savedInstanceState)

onSaveInstanceState

protected void onSaveInstanceState(android.os.Bundle outState)

onDestroy

protected void onDestroy()

getApiExecutor

public abstract java.util.concurrent.ThreadPoolExecutor getApiExecutor(android.app.Application application)

Returns the api executor for the activity

Parameters:

application -

Returns:

getResponseQueue

public abstract java.util.Queue<BoxResponse> getResponseQueue()

Returns the queue that is used for holding the responses of completed com.box.androidsdk.content.requests.BoxRequest

Returns:

Response queue of completed requests

handleBoxResponse

protected abstract void handleBoxResponse(BoxResponse response)

Handler that will be called after a BoxRequest completes. This method should be overridden to handle the appropriate request/response

Parameters:

response - the response object returned after a BoxRequest completes

isTaskInProgress

protected boolean isTaskInProgress()

Checks if the API executor currently ahs a task in progress

Returns:

resumeSpinnerIfNecessary

protected void resumeSpinnerIfNecessary()

Check to see if the threadpool executor is currently in the middle of a task and if so, show a spinner dialog again.

getMainItem

protected BoxItem getMainItem()

Convenient accessor for the BoxItem that will be interacted with

Returns:

the target box item the user is performing actions on.

setMainItem

protected void setMainItem(BoxItem boxItem)

Sets the main BoxItem that will be interacted with

Parameters:

boxItem -

dismissSpinner

protected void dismissSpinner()

Dismisses the spinner if it is currently showing

showSpinner

protected void showSpinner()

Shows the spinner with the default wait messaging

showSpinner

protected void showSpinner(int stringTitleRes,
               int stringRes)

Shows the spinner with a custom title and description

Parameters:

stringTitleRes - string resource for the spinner title

stringRes - string resource for the spinner description

createTaskMessagingExecutor

protected static java.util.concurrent.ThreadPoolExecutor createTaskMessagingExecutor(android.app.Application application,
                                                                  java.util.Queue<BoxResponse> responseQueue)

Creates a static ThreadPoolExecutor that is meant to be used in getApiExecutor. The ThreadPoolExecutor returned should be set to a static variable so that it is not recreated each time

Parameters:

application - application context needed for the LocalBroadcastManager

responseQueue - the queue that will hold all responses after the requests are completed. This should be provided through getResponseQueue()

Returns:

the ThreadPoolExecutor used to execute API requests