org.shredzone.flattr4j.async

Class AbstractFlattrCallable<R>

java.lang.Object

org.shredzone.flattr4j.async.AbstractFlattrCallable<R>

All Implemented Interfaces:

Callable<R>, FlattrCallable<R>

Direct Known Subclasses:

CreateMethod, FlattrMethod, GetActivitiesMethod, GetCategoriesMethod, GetLanguagesMethod, GetMyActivitiesMethod, GetMyselfMethod, GetMySubscriptions, GetSubscriptionMethod, GetThingMethod, GetThingsFromCollectionMethod, GetUserMethod, PaginatedFlattrCallable, ToggleSubscriptionMethod, VoidFlattrCallable

public abstract class AbstractFlattrCallable<R>
extends Object
implements FlattrCallable<R>

Abstract implementation of FlattrCallable.

Author:

Iulius Gutberlet, Richard "Shred" Körber

Constructor Summary

Constructors

Constructor and Description
AbstractFlattrCallable()

Method Summary

Modifier and Type	Method and Description
R	call()
abstract R	call(FlattrService service) Calls the appropriate method at the service and returns the result.
protected FlattrService	createFlattrService(AccessToken token) Creates a new FlattrService for the given AccessToken.
RateLimit	getRateLimit() Returns the RateLimit state after this callable was successfully executed, or null if the call failed or was not invoked yet.
R	getResult() Gets the result of the last call.
boolean	isFullMode()
void	setAccessToken(AccessToken token) Sets the AccessToken to be used if the call requires authorization.
void	setAccessToken(String token) Shortcut to set an AccessToken.
void	setFullMode(boolean full) Sets the full mode to be used when the call is executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFlattrCallable

public AbstractFlattrCallable()

Method Detail

setAccessToken

public void setAccessToken(AccessToken token)

Description copied from interface: FlattrCallable

Sets the AccessToken to be used if the call requires authorization.

Specified by:

setAccessToken in interface FlattrCallable<R>

Parameters:

token - AccessToken, or null if no authorization is needed

setAccessToken

public void setAccessToken(String token)

Description copied from interface: FlattrCallable

Shortcut to set an AccessToken.

Specified by:

setAccessToken in interface FlattrCallable<R>

Parameters:

token - Access token, or null if no authorization is needed

getRateLimit

public RateLimit getRateLimit()

Returns the RateLimit state after this callable was successfully executed, or null if the call failed or was not invoked yet.

setFullMode

public void setFullMode(boolean full)

Sets the full mode to be used when the call is executed.

Parameters:

full - full mode

isFullMode

public boolean isFullMode()

createFlattrService

protected FlattrService createFlattrService(AccessToken token)

Creates a new FlattrService for the given AccessToken. Can be overridden by subclasses if the FlattrService needs a special configuration.

Parameters:

token - AccessToken

Returns:

FlattrService that was created

call

public abstract R call(FlattrService service)
                throws Exception

Calls the appropriate method at the service and returns the result.

Parameters:

service - Preconfigured FlattrService to be invoked

Returns:

Result returned from the Flattr method.

Throws:

Exception

call

public R call()
       throws Exception

Specified by:

call in interface Callable<R>

Throws:

Exception

getResult

public R getResult()

Description copied from interface: FlattrCallable

Gets the result of the last call.

Specified by:

getResult in interface FlattrCallable<R>