org.intellimate.izou.sdk.output

Class OutputExtensionArgument<T,X>

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

org.intellimate.izou.sdk.output.OutputExtensionArgument<T,X>

Type Parameters:

T - the return type

X - the type of the Argument

All Implemented Interfaces:

Identifiable, OutputExtensionModel<T,X>, ContextProvider, Loggable, LoggedExceptionCallback, ExceptionCallback

Direct Known Subclasses:

OutputExtension

public abstract class OutputExtensionArgument<T,X>
extends AddOnModule
implements OutputExtensionModel<T,X>

OutputExtension's purpose is to take resourceData and convert it into another data format so that it can be rendered correctly by the output-plugin. These objects are represented in the form of future objects that are stored in tDoneList

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
OutputExtensionArgument(Context context, String id, String pluginId) creates a new outputExtension with a new id
OutputExtensionArgument(String id, Context context) creates a new outputExtension with a new id

Method Summary

Modifier and Type	Method and Description
void	addResourceIdToWishList(String id) adds id of resource to the wish list
boolean	canRun(EventModel event) Checks if the outputExtension can execute with the current event
abstract T	generate(EventModel event, X x) generates the data for the given Event
com.google.common.reflect.TypeToken<X>	getArgumentType() returns the Type of the Argument or null if none
String	getPluginId() gets the id of the output-plugin the outputExtension belongs to
List<String>	getResourceIdWishList() returns its resourceIdWishList
com.google.common.reflect.TypeToken<T>	getReturnType() returns the ReturnType of the generic
void	removeResourceIdFromWishList(String id) removes resourceId from the resourceIdWishList
void	setPluginId(String pluginId) sets the ID of the OutputPlugin the OutputExtension belongs to

Methods inherited from class org.intellimate.izou.sdk.util.AddOnModule

getContext, getID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.identification.Identifiable

getID, isOwner

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Constructor Detail

OutputExtensionArgument

public OutputExtensionArgument(Context context,
                               String id,
                               String pluginId)

creates a new outputExtension with a new id

Parameters:

context - the context of the addon

id - the id to be set to the id of outputExtension

pluginId - the id of the plugin to associate to

OutputExtensionArgument

public OutputExtensionArgument(String id,
                               Context context)

creates a new outputExtension with a new id

Parameters:

id - the id to be set to the id of outputExtension

context - the context of the addon

Method Detail

getResourceIdWishList

public List<String> getResourceIdWishList()

returns its resourceIdWishList

Returns:

a List containing the resourceIDs

addResourceIdToWishList

public void addResourceIdToWishList(String id)

adds id of resource to the wish list

Parameters:

id - the id of the resource to be added to the wish list

removeResourceIdFromWishList

public void removeResourceIdFromWishList(String id)

removes resourceId from the resourceIdWishList

Parameters:

id - the id of the resource to be removed

getPluginId

public String getPluginId()

gets the id of the output-plugin the outputExtension belongs to

Specified by:

getPluginId in interface OutputExtensionModel<T,X>

Returns:

id of the output-plugin the outputExtension belongs to

setPluginId

public void setPluginId(String pluginId)

sets the ID of the OutputPlugin the OutputExtension belongs to

Parameters:

pluginId - the ID of the Plugin

getReturnType

public com.google.common.reflect.TypeToken<T> getReturnType()

returns the ReturnType of the generic

Specified by:

getReturnType in interface OutputExtensionModel<T,X>

Returns:

the type of the generic

getArgumentType

public com.google.common.reflect.TypeToken<X> getArgumentType()

returns the Type of the Argument or null if none

Specified by:

getArgumentType in interface OutputExtensionModel<T,X>

Returns:

the type of the argument

canRun

public boolean canRun(EventModel event)

Checks if the outputExtension can execute with the current event

Specified by:

canRun in interface OutputExtensionModel<T,X>

Parameters:

event - the event to check against

Returns:

the state of whether the outputExtension can execute with the current event

generate

public abstract T generate(EventModel event,
                           X x)

generates the data for the given Event

Specified by:

generate in interface OutputExtensionModel<T,X>

Parameters:

event - the event to generate for

x - the optional argument

Returns:

the result