com.smarterapps.automateitplugin.sdk.fields

Class PluginDataField<FIELD_TYPE>

java.lang.Object

com.smarterapps.automateitplugin.sdk.fields.PluginDataField<FIELD_TYPE>

Type Parameters:

FIELD_TYPE - the field value type

Direct Known Subclasses:

PluginDataFieldBoolean, PluginDataFieldCustom, PluginDataFieldDouble, PluginDataFieldInteger, PluginDataFieldList, PluginDataFieldLong, PluginDataFieldString

public abstract class PluginDataField<FIELD_TYPE>
extends java.lang.Object

An abstract class that represents a plugin data field that can be set by the user to configure the plugin.
Each subclass represents a field of specific type as supported by PluginDataField.FieldType

See Also:

PluginAction.getActionFields(), PluginTrigger.getTriggerFields(), PluginDataFieldCollection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginDataField.FieldType Enum of supported field types.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	JSON_FIELD_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PluginDataField(int id, PluginDataField.FieldType type, java.lang.String title, java.lang.String description, FIELD_TYPE value)
	PluginDataField(org.json.JSONObject fieldJson) Do not use - for internal use only

Method Summary

Modifier and Type	Method and Description
static PluginDataField<?>	createNewField(org.json.JSONObject fieldJson) Do not use - for internal use only
java.lang.String	getDescription() Gets the field description.
protected abstract FIELD_TYPE	getFieldValue(org.json.JSONObject fieldJson, java.lang.String jsonFieldValue) Gets the field value.
int	getId() Gets the field id.
java.lang.String	getTitle() Gets the field title.
PluginDataField.FieldType	getType() Gets the field type.
FIELD_TYPE	getValue() Gets the field value.
org.json.JSONObject	serialize() Do not use - for internal use only
void	setValue(FIELD_TYPE fieldValue) Sets the field value.
void	setValueGeneric(java.lang.Object fieldValue) Sets the field value.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_FIELD_VALUE

protected static final java.lang.String JSON_FIELD_VALUE

See Also:

Constant Field Values

Constructor Detail

PluginDataField

protected PluginDataField(int id,
                          PluginDataField.FieldType type,
                          java.lang.String title,
                          java.lang.String description,
                          FIELD_TYPE value)

PluginDataField

public PluginDataField(org.json.JSONObject fieldJson)

Do not use - for internal use only

Method Detail

getFieldValue

protected abstract FIELD_TYPE getFieldValue(org.json.JSONObject fieldJson,
                                            java.lang.String jsonFieldValue)

Gets the field value.

Parameters:

fieldJson - the field json

jsonFieldValue - the json field value

Returns:

the field value

getId

public int getId()

Gets the field id.

Returns:

the field id

getType

public PluginDataField.FieldType getType()

Gets the field type.

Returns:

the field type

getTitle

public java.lang.String getTitle()

Gets the field title.

Returns:

the field title

getDescription

public java.lang.String getDescription()

Gets the field description.

Returns:

the field description

getValue

public FIELD_TYPE getValue()

Gets the field value.

Returns:

the field value

setValueGeneric

public void setValueGeneric(java.lang.Object fieldValue)
                     throws java.lang.ClassCastException

Sets the field value. In most cases, you should use the specific setValue() method of the used subclass.

Parameters:

fieldValue - the new field value

Throws:

java.lang.ClassCastException - When fieldValue type does not match the generic FIELD_TYPE

setValue

public void setValue(FIELD_TYPE fieldValue)

Sets the field value.

Parameters:

fieldValue - the new value

serialize

public org.json.JSONObject serialize()

Do not use - for internal use only

createNewField

public static PluginDataField<?> createNewField(org.json.JSONObject fieldJson)

Do not use - for internal use only