org.kt3k.straw
Class StrawDrink

java.lang.Object
  org.kt3k.straw.StrawDrink

public class StrawDrink
extends java.lang.Object

StrawDrink represents the straw api's execution context one StrawDrink for each straw API call other naming candidates were: StrawCall, StrawShot, StrawContext etc

Nested Class Summary

static class	StrawDrink.SingleIntegerValueResult generic plugin's result class for single Integer value result
static class	StrawDrink.SingleStringValueResult generic plugin's result class for single String value result

Constructor Summary

StrawDrink(java.lang.String pluginName, java.lang.String actionName, java.lang.String argumentJson, java.lang.String callbackId, Straw straw)

Method Summary

void	exec()
void	fail(java.lang.String errorId, java.lang.String errorMessage)
java.lang.String	getActionName()
java.lang.String	getArgumentJson()
java.lang.String	getCallbackId()
java.lang.Boolean	getKeepAlive()
java.lang.String	getPluginName()
java.lang.String	getResultJson()
java.lang.Boolean	isSuccess()
void	setKeepAlive(java.lang.Boolean bool)
void	success() notify Straw Framework that plugin excecution is success without any value
void	success(java.lang.Integer value) notify Straw Framework that plugin excecution is success with Integer value
void	success(java.lang.Object value) notify Straw Framework that plugin excecution is success with Custom object value
void	success(java.lang.String value) notify Straw Framework that plugin excecution is success with String value
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

StrawDrink

public StrawDrink(java.lang.String pluginName,
                  java.lang.String actionName,
                  java.lang.String argumentJson,
                  java.lang.String callbackId,
                  Straw straw)

Method Detail

exec

public void exec()

getPluginName

public java.lang.String getPluginName()

getActionName

public java.lang.String getActionName()

getCallbackId

public java.lang.String getCallbackId()

getResultJson

public java.lang.String getResultJson()

getArgumentJson

public java.lang.String getArgumentJson()

isSuccess

public java.lang.Boolean isSuccess()

getKeepAlive

public java.lang.Boolean getKeepAlive()

setKeepAlive

public void setKeepAlive(java.lang.Boolean bool)

success

public void success()

notify Straw Framework that plugin excecution is success without any value

Parameters:

value - success value

success

public void success(java.lang.Integer value)

notify Straw Framework that plugin excecution is success with Integer value

Parameters:

value - success value

success

public void success(java.lang.String value)

notify Straw Framework that plugin excecution is success with String value

Parameters:

value - success value

success

public void success(java.lang.Object value)

notify Straw Framework that plugin excecution is success with Custom object value

Parameters:

value - success value

fail

public void fail(java.lang.String errorId,
                 java.lang.String errorMessage)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object