Date: Sun, 4 Dec 2022 22:42:27 +0100
Subject: [PATCH 30/41] core: (WIP) Modularization closes #54
---
.../touchportal/annotations/Action.java | 25 +-
.../annotations/ActionTranslation.java | 1 +
.../annotations/ActionTranslations.java | 4 +
.../touchportal/annotations/Connector.java | 25 +-
.../annotations/ConnectorValue.java | 2 +-
.../touchportal/annotations/Data.java | 2 +-
.../annotations/processor/DataProcessor.java | 1 +
.../touchportal/helpers/ActionHelper.java | 19 ++
.../touchportal/helpers/ConnectorHelper.java | 31 +++
.../touchportal/helpers/DataHelper.java | 40 +++
.../christophecvb/touchportal/TPAction.java | 12 +
.../touchportal/TPConnector.java | 8 +
.../touchportal/TPInvokable.java | 15 +
.../touchportal/TouchPortalPlugin.java | 260 ++++++++++++------
.../touchportal/model/TPActionMessage.java | 5 +
.../model/TPConnectorChangeMessage.java | 5 +
...Message.java => TPListChangedMessage.java} | 2 +-
.../touchportal/test/LibraryTests.java | 2 +-
.../TouchPortalPluginTest/plugin.config | 2 +-
README.md | 2 +-
.../TouchPortalSampleJavaPlugin.java | 13 +-
.../invokable/action/ExampleClassAction.java | 43 +++
.../connector/ExampleClassConnector.java | 39 +++
.../TouchPortalSampleKotlinPlugin.kt | 2 +-
24 files changed, 451 insertions(+), 109 deletions(-)
create mode 100644 Library/src/main/java/com/christophecvb/touchportal/TPAction.java
create mode 100644 Library/src/main/java/com/christophecvb/touchportal/TPConnector.java
create mode 100644 Library/src/main/java/com/christophecvb/touchportal/TPInvokable.java
rename Library/src/main/java/com/christophecvb/touchportal/model/{TPListChangeMessage.java => TPListChangedMessage.java} (94%)
create mode 100644 SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/action/ExampleClassAction.java
create mode 100644 SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/connector/ExampleClassConnector.java
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Action.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Action.java
index ce829ac..31c279b 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Action.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Action.java
@@ -28,17 +28,30 @@
/**
* Action Annotation
*
- * Target is a Method
- *
- *
- * If your method only has @Data annotated parameters, it will be called automatically by the SDK.
- * If it is not the case, the SDK will call the TouchPortalPluginListener.onReceive(JsonObject jsonMessage) instead.
+ * Target is a Method or a Class extending TPAction
*
+ *
+ * -
+ * If used on a Method
+ *
+ * - If the method only has @Data annotated parameters, it will be called automatically by the SDK.
+ * - If it is not the case, the SDK will call the TouchPortalPluginListener.onReceive(JsonObject jsonMessage) instead.
+ *
+ *
+ * -
+ * If used on a Class, the SDK will
+ *
+ * - Create a new instance of the Class
+ * - Set the instance's {@link Data} annotated fields
+ * - Call the onInvoke method
+ *
+ *
+ *
*
* @see TP Documentation: Dynamic Actions
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.METHOD)
+@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Action {
/**
* Action id
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslation.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslation.java
index 1830a22..6338933 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslation.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslation.java
@@ -29,6 +29,7 @@
*
*/
@Repeatable(ActionTranslations.class)
+@Target({ElementType.METHOD, ElementType.TYPE})
public @interface ActionTranslation {
/**
* ActionTranslation Language
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslations.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslations.java
index 3efd044..37bcd53 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslations.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ActionTranslations.java
@@ -1,5 +1,9 @@
package com.christophecvb.touchportal.annotations;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.TYPE})
public @interface ActionTranslations {
ActionTranslation[] value();
}
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Connector.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Connector.java
index d07ecfc..5aafdd0 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Connector.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Connector.java
@@ -28,17 +28,30 @@
/**
* Connector Annotation
*
- * Target is a Method
- *
- *
- * If your method only has @Data annotated parameters, it will be called automatically by the SDK.
- * If it is not the case, the SDK will call the TouchPortalPluginListener.onReceive(JsonObject jsonMessage) instead.
+ * Target is a Method or a Class extending TPConnector
*
+ *
+ * -
+ * If used on a Method
+ *
+ * - If the method only has @Data annotated parameters, it will be called automatically by the SDK.
+ * - If it is not the case, the SDK will call the TouchPortalPluginListener.onReceive(JsonObject jsonMessage) instead.
+ *
+ *
+ * -
+ * If used on a Class, the SDK will
+ *
+ * - Create a new instance of the Class
+ * - Set the instance's {@link Data} annotated fields
+ * - Call the onInvoke method
+ *
+ *
+ *
*
* @see TP Documentation: Connectors
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.METHOD)
+@Target({ElementType.METHOD, ElementType.TYPE})
public @interface Connector {
/**
* Connector id
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ConnectorValue.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ConnectorValue.java
index de3eaa1..c1fdc12 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ConnectorValue.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/ConnectorValue.java
@@ -38,6 +38,6 @@
* @see TP Documentation: Connectors
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.PARAMETER)
+@Target({ElementType.PARAMETER, ElementType.FIELD})
public @interface ConnectorValue {
}
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Data.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Data.java
index 1a57faf..a23a942 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Data.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Data.java
@@ -34,7 +34,7 @@
* @see TP Documentation: Action Data
*/
@Retention(RetentionPolicy.RUNTIME)
-@Target(ElementType.PARAMETER)
+@Target({ElementType.PARAMETER, ElementType.FIELD})
public @interface Data {
/**
* Data id
diff --git a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/DataProcessor.java b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/DataProcessor.java
index e1ebb7f..7d8af7c 100644
--- a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/DataProcessor.java
+++ b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/DataProcessor.java
@@ -19,6 +19,7 @@ public class DataProcessor {
/**
* Generates a JsonObject and a TypeSpec.Builder representing the {@link Data} for an {@link Action} or a {@link Connector}
*
+ * @param Action or Connector Annotation
* @param processor {@link TouchPortalPluginAnnotationsProcessor}
* @param roundEnv RoundEnvironment
* @param pluginElement Element
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ActionHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ActionHelper.java
index 907ae91..4ded488 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ActionHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ActionHelper.java
@@ -24,6 +24,7 @@
import com.christophecvb.touchportal.annotations.Category;
import javax.lang.model.element.Element;
+import java.lang.reflect.Field;
import java.lang.reflect.Method;
/**
@@ -109,6 +110,24 @@ public static String getActionId(Class pluginClass, Method actionMethod) {
return actionId;
}
+ /**
+ * Get the generated Action ID
+ *
+ * @param pluginClass Class
+ * @param actionField Field
+ * @return String actionId
+ */
+ public static String getActionId(Class pluginClass, Field actionField) {
+ String actionId = "";
+
+ if (actionField.getDeclaringClass().isAnnotationPresent(Action.class)) {
+ Action action = actionField.getDeclaringClass().getDeclaredAnnotation(Action.class);
+ actionId = ActionHelper._getActionId(CategoryHelper.getCategoryId(pluginClass, action.categoryId()), (!action.id().isEmpty() ? action.id() : actionField.getDeclaringClass().getSimpleName()));
+ }
+
+ return actionId;
+ }
+
/**
* Internal - Get the formatted Action ID
*
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ConnectorHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ConnectorHelper.java
index 6e0e20c..993075f 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ConnectorHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ConnectorHelper.java
@@ -24,6 +24,7 @@
import com.christophecvb.touchportal.annotations.Connector;
import javax.lang.model.element.Element;
+import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Map;
@@ -105,6 +106,24 @@ public static String getConnectorId(Class pluginClass, Method connectorMethod
return connectorId;
}
+ /**
+ * Get the generated Connector ID
+ *
+ * @param pluginClass Class
+ * @param connectorField Field
+ * @return String connectorId
+ */
+ public static String getConnectorId(Class pluginClass, Field connectorField) {
+ String connectorId = "";
+
+ if (connectorField.getDeclaringClass().isAnnotationPresent(Connector.class)) {
+ Connector connector = connectorField.getDeclaringClass().getDeclaredAnnotation(Connector.class);
+ connectorId = ConnectorHelper.getConnectorId(pluginClass, connectorField.getDeclaringClass(), connector);
+ }
+
+ return connectorId;
+ }
+
/**
* Get the generated Connector ID
*
@@ -117,6 +136,18 @@ public static String getConnectorId(Class pluginClass, Method connectorMethod
return ConnectorHelper._getConnectorId(CategoryHelper.getCategoryId(pluginClass, connector.categoryId()), !connector.id().isEmpty() ? connector.id() : connectorMethod.getName());
}
+ /**
+ * Get the generated Connector ID
+ *
+ * @param pluginClass Class
+ * @param connectorClass Class
+ * @param connector {@link Connector}
+ * @return String connectorId
+ */
+ public static String getConnectorId(Class pluginClass, Class connectorClass, Connector connector) {
+ return ConnectorHelper._getConnectorId(CategoryHelper.getCategoryId(pluginClass, connector.categoryId()), !connector.id().isEmpty() ? connector.id() : connectorClass.getSimpleName());
+ }
+
/**
* Internal - Get the formatted Connector ID
*
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/DataHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/DataHelper.java
index c9e0da8..6bce8c9 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/DataHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/DataHelper.java
@@ -23,6 +23,7 @@
import com.christophecvb.touchportal.annotations.*;
import javax.lang.model.element.Element;
+import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
@@ -150,6 +151,45 @@ else if (method.isAnnotationPresent(Connector.class)) {
return dataId;
}
+ /**
+ * Get the generated Data Id
+ *
+ * @param pluginClass Class
+ * @param field Field
+ * @return String dataId
+ */
+ public static String getDataId(Class pluginClass, Field field) {
+ String dataId = "";
+
+ if (field.isAnnotationPresent(Data.class)) {
+ Data data = field.getAnnotation(Data.class);
+ if (!data.stateId().isEmpty()) {
+ String categoryId = null;
+ if (field.getDeclaringClass().isAnnotationPresent(Action.class)) {
+ Action action = field.getDeclaringClass().getAnnotation(Action.class);
+ categoryId = action.categoryId();
+ }
+ else if (field.getDeclaringClass().isAnnotationPresent(Connector.class)) {
+ Connector connector = field.getDeclaringClass().getAnnotation(Connector.class);
+ categoryId = connector.categoryId();
+ }
+ if (categoryId != null) {
+ dataId = StateHelper.getStateId(pluginClass, categoryId, data.stateId());
+ }
+ }
+ else {
+ if (field.getDeclaringClass().isAnnotationPresent(Action.class)) {
+ dataId = DataHelper._getDataId(ActionHelper.getActionId(pluginClass, field), data.id().isEmpty() ? field.getName() : data.id());
+ }
+ else if (field.getDeclaringClass().isAnnotationPresent(Connector.class)) {
+ dataId = DataHelper._getDataId(ConnectorHelper.getConnectorId(pluginClass, field), data.id().isEmpty() ? field.getName() : data.id());
+ }
+ }
+ }
+
+ return dataId;
+ }
+
/**
* Internal - Get the formatted Data Id
*
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TPAction.java b/Library/src/main/java/com/christophecvb/touchportal/TPAction.java
new file mode 100644
index 0000000..054a147
--- /dev/null
+++ b/Library/src/main/java/com/christophecvb/touchportal/TPAction.java
@@ -0,0 +1,12 @@
+package com.christophecvb.touchportal;
+
+public abstract class TPAction extends TPInvokable {
+
+ public TPAction(T touchPortalPlugin) {
+ super(touchPortalPlugin);
+ }
+
+ protected Boolean isBeingHeld(String actionId) {
+ return this.touchPortalPlugin.isActionBeingHeld(actionId);
+ }
+}
\ No newline at end of file
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TPConnector.java b/Library/src/main/java/com/christophecvb/touchportal/TPConnector.java
new file mode 100644
index 0000000..8e76c7a
--- /dev/null
+++ b/Library/src/main/java/com/christophecvb/touchportal/TPConnector.java
@@ -0,0 +1,8 @@
+package com.christophecvb.touchportal;
+
+public abstract class TPConnector extends TPInvokable {
+
+ public TPConnector(T touchPortalPlugin) {
+ super(touchPortalPlugin);
+ }
+}
\ No newline at end of file
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TPInvokable.java b/Library/src/main/java/com/christophecvb/touchportal/TPInvokable.java
new file mode 100644
index 0000000..8a5ae7f
--- /dev/null
+++ b/Library/src/main/java/com/christophecvb/touchportal/TPInvokable.java
@@ -0,0 +1,15 @@
+package com.christophecvb.touchportal;
+
+import com.christophecvb.touchportal.model.TPListChangedMessage;
+
+abstract class TPInvokable {
+ protected final T touchPortalPlugin;
+
+ public TPInvokable(T touchPortalPlugin) {
+ this.touchPortalPlugin = touchPortalPlugin;
+ }
+
+ public abstract void onInvoke();
+
+ public abstract void onListChanged(TPListChangedMessage tpListChangedMessage);
+}
\ No newline at end of file
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
index deb2940..def900f 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
@@ -30,9 +30,7 @@
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.*;
-import java.lang.reflect.Field;
-import java.lang.reflect.Method;
-import java.lang.reflect.Parameter;
+import java.lang.reflect.*;
import java.net.InetAddress;
import java.net.Socket;
import java.net.SocketException;
@@ -143,6 +141,10 @@ public abstract class TouchPortalPlugin {
* Executor Service for callbacks
*/
private final ExecutorService callbacksExecutor;
+ /**
+ * Registered {@link TPInvokable}s
+ */
+ private final HashMap> registeredInvokables = new HashMap<>();
/**
* Internal Gson Serializer/Deserializer
@@ -188,7 +190,7 @@ private Thread createListenerThread() {
TPMessageDeserializer tpMessageDeserializer = new TPMessageDeserializer();
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_CLOSE_PLUGIN, TPClosePluginMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_INFO, TPInfoMessage.class);
- tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_LIST_CHANGE, TPListChangeMessage.class);
+ tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_LIST_CHANGE, TPListChangedMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_BROADCAST, TPBroadcastMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_SETTINGS, TPSettingsMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_ACTION, TPActionMessage.class);
@@ -233,7 +235,7 @@ private void onMessage(String socketMessage) throws SocketException, JsonParseEx
break;
case ReceivedMessageHelper.TYPE_LIST_CHANGE:
- TPListChangeMessage listChangeMessage = (TPListChangeMessage) tpMessage;
+ TPListChangedMessage listChangeMessage = (TPListChangedMessage) tpMessage;
if (this.touchPortalPluginListener != null) {
this.touchPortalPluginListener.onListChanged(listChangeMessage);
}
@@ -320,105 +322,175 @@ private void updateSettingFields(HashMap settings) {
}
private boolean onActionReceived(TPActionMessage tpActionMessage, JsonObject jsonAction, Boolean held) {
- boolean called = false;
+ boolean invoked = false;
if (tpActionMessage.actionId != null && !tpActionMessage.actionId.isEmpty()) {
- Method[] pluginActionMethods = Arrays.stream(this.pluginClass.getDeclaredMethods()).filter(method -> method.isAnnotationPresent(Action.class)).toArray(Method[]::new);
- for (Method method : pluginActionMethods) {
- String methodActionId = ActionHelper.getActionId(this.pluginClass, method);
- if (tpActionMessage.actionId.equals(methodActionId)) {
- try {
- Parameter[] parameters = method.getParameters();
- Object[] arguments = new Object[parameters.length];
- for (int parameterIndex = 0; parameterIndex < parameters.length; parameterIndex++) {
- Parameter parameter = parameters[parameterIndex];
- if (parameter.isAnnotationPresent(Data.class)) {
- arguments[parameterIndex] = tpActionMessage.getTypedDataValue(this.pluginClass, method, parameter);
- }
- else if (parameter.getType().isAssignableFrom(JsonObject.class)) {
- arguments[parameterIndex] = jsonAction;
- }
- else if (parameter.getType().isAssignableFrom(TPActionMessage.class)) {
- arguments[parameterIndex] = tpActionMessage;
- }
- if (arguments[parameterIndex] == null) {
- throw new MethodDataParameterException(method, parameter);
- }
+ if (this.registeredInvokables.containsKey(tpActionMessage.actionId)) {
+ Class invokableClass = this.registeredInvokables.get(tpActionMessage.actionId);
+ try {
+ Class typedTouchPortalPlugin = (Class) ((ParameterizedType) invokableClass.getGenericSuperclass()).getActualTypeArguments()[0];
+ Constructor constructor = invokableClass.getConstructor(typedTouchPortalPlugin);
+ TPInvokable tpInvokable = constructor.newInstance(this);
+
+ for (Field declaredField : invokableClass.getDeclaredFields()) {
+ if (declaredField.isAnnotationPresent(Data.class)) {
+ declaredField.setAccessible(true);
+ Object fieldValue = tpActionMessage.getTypedDataValue(this.pluginClass, declaredField);
+ declaredField.set(tpInvokable, fieldValue);
}
- this.heldActionsStates.put(tpActionMessage.actionId, held);
- this.callbacksExecutor.submit(() -> {
- try {
- method.setAccessible(true);
- method.invoke(this, arguments);
- }
- catch (Exception e) {
- TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action method could not be invoked", e);
- }
- finally {
- if (held == null || !held) {
- this.heldActionsStates.remove(tpActionMessage.actionId);
+ else if (declaredField.getType().isAssignableFrom(JsonObject.class)) {
+ declaredField.setAccessible(true);
+ declaredField.set(tpInvokable, jsonAction);
+ }
+ else if (declaredField.getType().isAssignableFrom(TPActionMessage.class)) {
+ declaredField.setAccessible(true);
+ declaredField.set(tpInvokable, tpActionMessage);
+ }
+ }
+
+ tpInvokable.onInvoke();
+
+ invoked = true;
+ }
+ catch (ReflectiveOperationException e) {
+ TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action could not be created or invoked", e);
+ }
+ }
+ else {
+ Method[] pluginActionMethods = Arrays.stream(this.pluginClass.getDeclaredMethods()).filter(method -> method.isAnnotationPresent(Action.class)).toArray(Method[]::new);
+ for (Method method : pluginActionMethods) {
+ String methodActionId = ActionHelper.getActionId(this.pluginClass, method);
+ if (tpActionMessage.actionId.equals(methodActionId)) {
+ try {
+ Parameter[] parameters = method.getParameters();
+ Object[] arguments = new Object[parameters.length];
+ for (int parameterIndex = 0; parameterIndex < parameters.length; parameterIndex++) {
+ Parameter parameter = parameters[parameterIndex];
+ if (parameter.isAnnotationPresent(Data.class)) {
+ arguments[parameterIndex] = tpActionMessage.getTypedDataValue(this.pluginClass, method, parameter);
+ }
+ else if (parameter.getType().isAssignableFrom(JsonObject.class)) {
+ arguments[parameterIndex] = jsonAction;
+ }
+ else if (parameter.getType().isAssignableFrom(TPActionMessage.class)) {
+ arguments[parameterIndex] = tpActionMessage;
+ }
+ if (arguments[parameterIndex] == null) {
+ throw new MethodDataParameterException(method, parameter);
}
}
- });
- called = true;
- }
- catch (MethodDataParameterException e) {
- TouchPortalPlugin.LOGGER.log(Level.WARNING, e.getMessage(), e);
+ this.heldActionsStates.put(tpActionMessage.actionId, held);
+ this.callbacksExecutor.submit(() -> {
+ try {
+ method.setAccessible(true);
+ method.invoke(this, arguments);
+ }
+ catch (Exception e) {
+ TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action method could not be invoked", e);
+ }
+ finally {
+ if (held == null || !held) {
+ this.heldActionsStates.remove(tpActionMessage.actionId);
+ }
+ }
+ });
+ invoked = true;
+ }
+ catch (MethodDataParameterException e) {
+ TouchPortalPlugin.LOGGER.log(Level.WARNING, e.getMessage(), e);
+ }
+ break;
}
- break;
}
}
}
- return called;
+ return invoked;
}
- private boolean onConnectorChangeReceived(TPConnectorChangeMessage tpConnectorChangeMessage, JsonObject jsonAction) {
- boolean called = false;
+ private boolean onConnectorChangeReceived(TPConnectorChangeMessage tpConnectorChangeMessage, JsonObject jsonConnectorChange) {
+ boolean invoked = false;
if (tpConnectorChangeMessage.connectorId != null && !tpConnectorChangeMessage.connectorId.isEmpty()) {
- Method[] pluginConnectorMethods = Arrays.stream(this.pluginClass.getDeclaredMethods()).filter(method -> method.isAnnotationPresent(Connector.class)).toArray(Method[]::new);
- for (Method method : pluginConnectorMethods) {
- String methodConnectorId = ConnectorHelper.getConnectorId(this.pluginClass, method);
- if (tpConnectorChangeMessage.connectorId.equals(methodConnectorId)) {
- try {
- Parameter[] parameters = method.getParameters();
- Object[] arguments = new Object[parameters.length];
- for (int parameterIndex = 0; parameterIndex < parameters.length; parameterIndex++) {
- Parameter parameter = parameters[parameterIndex];
- if (parameter.isAnnotationPresent(Data.class)) {
- arguments[parameterIndex] = tpConnectorChangeMessage.getTypedDataValue(this.pluginClass, method, parameter);
- }
- else if (parameter.isAnnotationPresent(ConnectorValue.class)) {
- arguments[parameterIndex] = tpConnectorChangeMessage.value;
- }
- else if (parameter.getType().isAssignableFrom(JsonObject.class)) {
- arguments[parameterIndex] = jsonAction;
- }
- else if (parameter.getType().isAssignableFrom(TPConnectorChangeMessage.class)) {
- arguments[parameterIndex] = tpConnectorChangeMessage;
- }
- if (arguments[parameterIndex] == null) {
- throw new MethodDataParameterException(method, parameter);
- }
+ if (this.registeredInvokables.containsKey(tpConnectorChangeMessage.connectorId)) {
+ Class invokableClass = this.registeredInvokables.get(tpConnectorChangeMessage.connectorId);
+ try {
+ Class typedTouchPortalPlugin = (Class) ((ParameterizedType) invokableClass.getGenericSuperclass()).getActualTypeArguments()[0];
+ Constructor constructor = invokableClass.getConstructor(typedTouchPortalPlugin);
+ TPInvokable tpInvokable = constructor.newInstance(this);
+
+ for (Field declaredField : invokableClass.getDeclaredFields()) {
+ if (declaredField.isAnnotationPresent(Data.class)) {
+ declaredField.setAccessible(true);
+ Object fieldValue = tpConnectorChangeMessage.getTypedDataValue(this.pluginClass, declaredField);
+ declaredField.set(tpInvokable, fieldValue);
+ }
+ else if (declaredField.isAnnotationPresent(ConnectorValue.class)) {
+ declaredField.setAccessible(true);
+ declaredField.set(tpInvokable, tpConnectorChangeMessage.value);
+ }
+ else if (declaredField.getType().isAssignableFrom(JsonObject.class)) {
+ declaredField.setAccessible(true);
+ declaredField.set(tpInvokable, jsonConnectorChange);
+ }
+ else if (declaredField.getType().isAssignableFrom(TPConnectorChangeMessage.class)) {
+ declaredField.setAccessible(true);
+ declaredField.set(tpInvokable, tpConnectorChangeMessage);
}
- this.currentConnectorValues.put(tpConnectorChangeMessage.getConstructedId(), tpConnectorChangeMessage.value);
- this.callbacksExecutor.submit(() -> {
- try {
- method.setAccessible(true);
- method.invoke(this, arguments);
- }
- catch (Exception e) {
- TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Connector method could not be invoked", e);
- }
- });
- called = true;
}
- catch (MethodDataParameterException e) {
- TouchPortalPlugin.LOGGER.log(Level.WARNING, e.getMessage(), e);
+
+ tpInvokable.onInvoke();
+
+ invoked = true;
+ }
+ catch (ReflectiveOperationException e) {
+ TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action could not be created or invoked", e);
+ }
+ }
+ else {
+ Method[] pluginConnectorMethods = Arrays.stream(this.pluginClass.getDeclaredMethods()).filter(method -> method.isAnnotationPresent(Connector.class)).toArray(Method[]::new);
+ for (Method method : pluginConnectorMethods) {
+ String methodConnectorId = ConnectorHelper.getConnectorId(this.pluginClass, method);
+ if (tpConnectorChangeMessage.connectorId.equals(methodConnectorId)) {
+ try {
+ Parameter[] parameters = method.getParameters();
+ Object[] arguments = new Object[parameters.length];
+ for (int parameterIndex = 0; parameterIndex < parameters.length; parameterIndex++) {
+ Parameter parameter = parameters[parameterIndex];
+ if (parameter.isAnnotationPresent(Data.class)) {
+ arguments[parameterIndex] = tpConnectorChangeMessage.getTypedDataValue(this.pluginClass, method, parameter);
+ }
+ else if (parameter.isAnnotationPresent(ConnectorValue.class)) {
+ arguments[parameterIndex] = tpConnectorChangeMessage.value;
+ }
+ else if (parameter.getType().isAssignableFrom(JsonObject.class)) {
+ arguments[parameterIndex] = jsonConnectorChange;
+ }
+ else if (parameter.getType().isAssignableFrom(TPConnectorChangeMessage.class)) {
+ arguments[parameterIndex] = tpConnectorChangeMessage;
+ }
+ if (arguments[parameterIndex] == null) {
+ throw new MethodDataParameterException(method, parameter);
+ }
+ }
+ this.currentConnectorValues.put(tpConnectorChangeMessage.getConstructedId(), tpConnectorChangeMessage.value);
+ this.callbacksExecutor.submit(() -> {
+ try {
+ method.setAccessible(true);
+ method.invoke(this, arguments);
+ }
+ catch (Exception e) {
+ TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Connector method could not be invoked", e);
+ }
+ });
+ invoked = true;
+ }
+ catch (MethodDataParameterException e) {
+ TouchPortalPlugin.LOGGER.log(Level.WARNING, e.getMessage(), e);
+ }
+ break;
}
- break;
}
}
}
- return called;
+ return invoked;
}
/**
@@ -437,6 +509,16 @@ private boolean sendPair() {
return paired;
}
+ /**
+ * Register a {@link TPAction} or {@link TPConnector}
+ *
+ * @param invokableId String
+ * @param invokableClass Class<{@link TPInvokable}>
+ */
+ protected void registerInvokable(String invokableId, Class invokableClass) {
+ this.registeredInvokables.put(invokableId, invokableClass);
+ }
+
/**
* Get TPInfo
*
@@ -1264,9 +1346,9 @@ public interface TouchPortalPluginListener {
/**
* Called when a List Change Message is received
*
- * @param tpListChangeMessage TPListChangeMessage
+ * @param tpListChangedMessage TPListChangeMessage
*/
- void onListChanged(TPListChangeMessage tpListChangeMessage);
+ void onListChanged(TPListChangedMessage tpListChangedMessage);
/**
* Called when a Broadcast Message is received
diff --git a/Library/src/main/java/com/christophecvb/touchportal/model/TPActionMessage.java b/Library/src/main/java/com/christophecvb/touchportal/model/TPActionMessage.java
index ea6e1f0..2ecf1a4 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/model/TPActionMessage.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/model/TPActionMessage.java
@@ -23,6 +23,7 @@
import com.christophecvb.touchportal.helpers.DataHelper;
import com.christophecvb.touchportal.helpers.ReceivedMessageHelper;
+import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
@@ -41,6 +42,10 @@ public Object getTypedDataValue(Class pluginClass, Method actionMethod, Param
return this.getTypedDataValue(actionMethodParameter.getParameterizedType().getTypeName(), DataHelper.getDataId(pluginClass, actionMethod, actionMethodParameter));
}
+ public Object getTypedDataValue(Class pluginClass, Field actionField) {
+ return this.getTypedDataValue(actionField.getType().getTypeName(), DataHelper.getDataId(pluginClass, actionField));
+ }
+
public Object getTypedDataValue(String actionDataType, String actionDataId) {
Object value = null;
diff --git a/Library/src/main/java/com/christophecvb/touchportal/model/TPConnectorChangeMessage.java b/Library/src/main/java/com/christophecvb/touchportal/model/TPConnectorChangeMessage.java
index ae5db53..b865a25 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/model/TPConnectorChangeMessage.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/model/TPConnectorChangeMessage.java
@@ -24,6 +24,7 @@
import com.christophecvb.touchportal.helpers.DataHelper;
import com.christophecvb.touchportal.helpers.ReceivedMessageHelper;
+import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.ArrayList;
@@ -44,6 +45,10 @@ public Object getTypedDataValue(Class pluginClass, Method actionMethod, Param
return this.getTypedDataValue(connectorMethodParameter.getParameterizedType().getTypeName(), DataHelper.getDataId(pluginClass, actionMethod, connectorMethodParameter));
}
+ public Object getTypedDataValue(Class pluginClass, Field actionField) {
+ return this.getTypedDataValue(actionField.getType().getTypeName(), DataHelper.getDataId(pluginClass, actionField));
+ }
+
public Object getTypedDataValue(String connectorDataType, String connectorDataId) {
Object value = null;
diff --git a/Library/src/main/java/com/christophecvb/touchportal/model/TPListChangeMessage.java b/Library/src/main/java/com/christophecvb/touchportal/model/TPListChangedMessage.java
similarity index 94%
rename from Library/src/main/java/com/christophecvb/touchportal/model/TPListChangeMessage.java
rename to Library/src/main/java/com/christophecvb/touchportal/model/TPListChangedMessage.java
index 83b2c77..f024390 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/model/TPListChangeMessage.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/model/TPListChangedMessage.java
@@ -20,7 +20,7 @@
package com.christophecvb.touchportal.model;
-public class TPListChangeMessage extends TPMessage {
+public class TPListChangedMessage extends TPMessage {
public String pluginId;
public String actionId;
public String listId;
diff --git a/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java b/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
index b271368..55e2cf3 100644
--- a/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
+++ b/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
@@ -71,7 +71,7 @@ public void onInfo(TPInfoMessage tpInfoMessage) {
}
@Override
- public void onListChanged(TPListChangeMessage tpListChangeMessage) {
+ public void onListChanged(TPListChangedMessage tpListChangedMessage) {
}
@Override
diff --git a/Library/src/test/resources/TouchPortalPluginTest/plugin.config b/Library/src/test/resources/TouchPortalPluginTest/plugin.config
index 10fc40b..ec09544 100644
--- a/Library/src/test/resources/TouchPortalPluginTest/plugin.config
+++ b/Library/src/test/resources/TouchPortalPluginTest/plugin.config
@@ -1,4 +1,4 @@
#TouchPortalPluginTest
-#Sat Nov 26 23:11:43 CET 2022
+#Sun Dec 04 22:41:39 CET 2022
samplekey=Sample Value
plugin.version=1
diff --git a/README.md b/README.md
index d06b1ae..2e76fbd 100644
--- a/README.md
+++ b/README.md
@@ -91,7 +91,7 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
/**
* Called when a List Change Message is received
*/
- public void onListChanged(TPListChangeMessage tpListChangeMessage) { }
+ public void onListChanged(TPListChangeMessage tpListChangedMessage) { }
/**
* Called when a Broadcast Message is received
diff --git a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
index bdfeca5..14a5a97 100644
--- a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
+++ b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
@@ -25,6 +25,8 @@
import com.christophecvb.touchportal.helpers.PluginHelper;
import com.christophecvb.touchportal.helpers.ReceivedMessageHelper;
import com.christophecvb.touchportal.model.*;
+import com.christophecvb.touchportal.samplejava.invokable.action.ExampleClassAction;
+import com.christophecvb.touchportal.samplejava.invokable.connector.ExampleClassConnector;
import com.google.gson.JsonObject;
import java.io.File;
@@ -98,14 +100,23 @@ public static void main(String... args) {
if (PluginHelper.COMMAND_START.equals(args[0])) {
// Initialize the Plugin
TouchPortalSampleJavaPlugin touchPortalSampleJavaPlugin = new TouchPortalSampleJavaPlugin();
+
+ // Register Invokable
+ touchPortalSampleJavaPlugin.registerInvokable(TouchPortalSampleJavaPluginConstants.BaseCategory.Actions.ExampleClassAction.ID, ExampleClassAction.class);
+ touchPortalSampleJavaPlugin.registerInvokable(TouchPortalSampleJavaPluginConstants.BaseCategory.Connectors.ExampleClassConnector.ID, ExampleClassConnector.class);
+
// Load a properties File
touchPortalSampleJavaPlugin.loadProperties("plugin.config");
+
// Get a property
TouchPortalSampleJavaPlugin.LOGGER.log(Level.INFO, touchPortalSampleJavaPlugin.getProperty("samplekey"));
+
// Set a property
touchPortalSampleJavaPlugin.setProperty("samplekey", "Value set from Plugin");
+
// Store the properties
touchPortalSampleJavaPlugin.storeProperties();
+
// Initiate the connection with the Touch Portal Plugin System
boolean connectedPairedAndListening = touchPortalSampleJavaPlugin.connectThenPairAndListen(touchPortalSampleJavaPlugin);
@@ -300,7 +311,7 @@ public void onInfo(TPInfoMessage tpInfoMessage) {
}
@Override
- public void onListChanged(TPListChangeMessage tpListChangeMessage) {
+ public void onListChanged(TPListChangedMessage tpListChangedMessage) {
}
@Override
diff --git a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/action/ExampleClassAction.java b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/action/ExampleClassAction.java
new file mode 100644
index 0000000..d484e1e
--- /dev/null
+++ b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/action/ExampleClassAction.java
@@ -0,0 +1,43 @@
+package com.christophecvb.touchportal.samplejava.invokable.action;
+
+import com.christophecvb.touchportal.TPAction;
+import com.christophecvb.touchportal.TouchPortalPlugin;
+import com.christophecvb.touchportal.annotations.Action;
+import com.christophecvb.touchportal.annotations.ActionTranslation;
+import com.christophecvb.touchportal.annotations.Data;
+import com.christophecvb.touchportal.annotations.Language;
+import com.christophecvb.touchportal.model.TPListChangedMessage;
+import com.christophecvb.touchportal.samplejava.TouchPortalSampleJavaPlugin;
+
+import java.util.logging.Logger;
+
+@Action(
+ name = "Example Class Action",
+ format = "Example Class Action with param {$param$}",
+ categoryId = "BaseCategory"
+)
+@ActionTranslation(
+ language = Language.FRENCH,
+ name = "Exemple d'Action via une Classe",
+ format = "Exemple d'Action via une Classe avec le paramètre {$param$}"
+)
+public class ExampleClassAction extends TPAction {
+ private final static Logger LOGGER = Logger.getLogger(TouchPortalPlugin.class.getName());
+
+ @Data
+ private String param;
+
+ public ExampleClassAction(TouchPortalSampleJavaPlugin touchPortalPlugin) {
+ super(touchPortalPlugin);
+ }
+
+ @Override
+ public void onInvoke() {
+ LOGGER.info("ExampleClassAction.onInvoke this.param=" + this.param);
+ }
+
+ @Override
+ public void onListChanged(TPListChangedMessage tpListChangedMessage) {
+ LOGGER.info("ExampleClassAction.onListChanged");
+ }
+}
diff --git a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/connector/ExampleClassConnector.java b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/connector/ExampleClassConnector.java
new file mode 100644
index 0000000..8ffc387
--- /dev/null
+++ b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/invokable/connector/ExampleClassConnector.java
@@ -0,0 +1,39 @@
+package com.christophecvb.touchportal.samplejava.invokable.connector;
+
+import com.christophecvb.touchportal.TPConnector;
+import com.christophecvb.touchportal.TouchPortalPlugin;
+import com.christophecvb.touchportal.annotations.Connector;
+import com.christophecvb.touchportal.annotations.ConnectorValue;
+import com.christophecvb.touchportal.annotations.Data;
+import com.christophecvb.touchportal.model.TPListChangedMessage;
+import com.christophecvb.touchportal.samplejava.TouchPortalSampleJavaPlugin;
+
+import java.util.logging.Logger;
+
+@Connector(
+ name = "Example Class Connector",
+ categoryId = "BaseCategory",
+ format = "Connect Example Class Connector with param {$param$}"
+)
+public class ExampleClassConnector extends TPConnector {
+ private final static Logger LOGGER = Logger.getLogger(TouchPortalPlugin.class.getName());
+
+ @ConnectorValue
+ private Integer value;
+ @Data
+ private String param;
+
+ public ExampleClassConnector(TouchPortalSampleJavaPlugin touchPortalPlugin) {
+ super(touchPortalPlugin);
+ }
+
+ @Override
+ public void onInvoke() {
+ LOGGER.info("Example Class Connector with param=" + this.param + " and value=" + this.value);
+ }
+
+ @Override
+ public void onListChanged(TPListChangedMessage tpListChangedMessage) {
+ LOGGER.info("ExampleClassConnector.onListChanged");
+ }
+}
diff --git a/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt b/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt
index 470fa00..d88020c 100644
--- a/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt
+++ b/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt
@@ -82,7 +82,7 @@ class TouchPortalSampleKotlinPlugin(parallelizeActions: Boolean) : TouchPortalPl
}
override fun onReceived(jsonMessage: JsonObject) {}
- override fun onListChanged(tpListChangeMessage: TPListChangeMessage) {}
+ override fun onListChanged(tpListChangedMessage: TPListChangedMessage) {}
override fun onInfo(tpInfoMessage: TPInfoMessage) {}
override fun onBroadcast(tpBroadcastMessage: TPBroadcastMessage) {}
override fun onSettings(tpSettingsMessage: TPSettingsMessage) {}
From 00ca01dd90a36e41fce822068a173c80dd4495af Mon Sep 17 00:00:00 2001
From: Christophe Carvalho Vilas-Boas
Date: Thu, 15 Dec 2022 01:56:07 +0100
Subject: [PATCH 31/41] doc: Update Samples and README.md
---
README.md | 58 ++++++++++++-------
.../TouchPortalSampleJavaPlugin.java | 16 +++--
.../TouchPortalSampleKotlinPlugin.kt | 19 +++---
3 files changed, 57 insertions(+), 36 deletions(-)
diff --git a/README.md b/README.md
index 2e76fbd..9a5241f 100644
--- a/README.md
+++ b/README.md
@@ -103,16 +103,15 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
*/
public void onSettings(TPSettingsMessage tpSettingsMessage) { }
- /**
- * Called when a Notification Option Clicked Message is received
- */
- public void onNotificationOptionClicked(TPNotificationOptionClickedMessage tpNotificationOptionClickedMessage) {}
+ /**
+ * Called when a Notification Option Clicked Message is received
+ */
+ public void onNotificationOptionClicked(TPNotificationOptionClickedMessage tpNotificationOptionClickedMessage) { }
}
```
## Development and Interaction
-
-- The SDK will automatically callback your action methods if they only contain `@Data` annotated parameters
+The SDK will automatically invoke your action methods if they contain only `@Data` annotated parameters
```java
public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPortalPlugin.TouchPortalPluginListener {
@@ -125,14 +124,14 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
*/
@Action(description = "Long Description of Dummy Action with Data Text", format = "Set text to {$text$}", categoryId = "BaseCategory")
private void actionWithText(@Data String text) {
- TouchPortalSamplePlugin.LOGGER.log(Level.INFO, "Action actionWithText received: " + text);
+ MyTouchPortalPlugin.LOGGER.log(Level.INFO, "Action actionWithText received: " + text);
}
// ...
}
```
-- Otherwise, call your actions manually in the `onReceived(JsonObject jsonMessage)` method
+Otherwise, call your actions manually in the `onReceived(JsonObject jsonMessage)` method
```java
public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPortalPlugin.TouchPortalPluginListener {
@@ -157,7 +156,7 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
}
```
-- Don't forget to initialize all your services once you receive the onInfo event. The TPInfoMessage will also contain the initial values of your settings.
+Don't forget to initialize all your services once you receive the onInfo event. The TPInfoMessage will also contain the initial values of your settings.
```java
public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPortalPlugin.TouchPortalPluginListener {
@@ -174,7 +173,7 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
}
```
-- Finally, send messages back to TouchPortal when you want to update your states
+Finally, send messages back to TouchPortal when you want to update your states
```java
public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPortalPlugin.TouchPortalPluginListener {
@@ -194,16 +193,24 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
}
```
-## Use Annotations to describe your plugin and package it
+## Use Annotations to describe your plugin
+
+The provided Annotations help you in the automatic generation of the `entry.tp` file (necessary for packaging and deployment of your plugin)
+
+Current supported annotations include: Plugin, Category, Action, Data, State, Event and Setting
-- The provided Annotations help you in the automatic generation of the `entry.tp` file (necessary for packaging and deployment of your plugin)
-- Current supported annotations include: Plugin, Category, Action, Data, State, Event and Setting
-- More examples can be found in the sample modules
+More examples can be found in the sample modules
```java
// ...
-@Plugin(version = BuildConfig.VERSION_CODE, colorDark = "#203060", colorLight = "#4070F0", name = "My Touch Portal Plugin")
+@Plugin(
+ name = "My Touch Portal Plugin",
+ version = BuildConfig.VERSION_CODE,
+ colorDark = "#203060",
+ colorLight = "#4070F0",
+ parentCategory = ParentCategory.MISC
+)
public class MyTouchPortalPlugin extends TouchPortalPlugin {
//...
@@ -212,7 +219,11 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin {
*
* @param text String
*/
- @Action(description = "Long Description of Dummy Action with Data", format = "Set text to {$text$}", categoryId = "BaseCategory")
+ @Action(
+ description = "Long Description of Dummy Action with Data",
+ format = "Set text to {$text$}",
+ categoryId = "BaseCategory"
+ )
private void dummyWithData(@Data String text) {
LOGGER.log(Level.Info, "Action dummyWithData received: " + text);
}
@@ -238,13 +249,16 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin {
## Prepackaging
-- Add the Plugin icon and extra resources into the `src/main/resources/` directory of your module
+Add the Plugin icon and extra resources into the `src/main/resources/` directory of your module
-## Build
+## Clean, Build and Package
-- Use the common `gradlew clean` task to clean your build directories.
-- Use the common `gradlew build` task to build your project with the Annotations.
-- Use the `gradlew packagePlugin` task to pack your plugin into a `.tpp` file. Output files will be in your module `build/plugin` directory.
+- Clean Project
+ - `gradlew clean`
+- Build Project
+ - `gradlew build`
+- Package Project
+ - `gradlew packagePlugin` task to pack your plugin into a `.tpp` file. Output files will be in your module's `build/plugin` directory.
## Debugging tips
@@ -259,4 +273,4 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin {
- Main Class: `your.package.YourTouchPortalPlugin`
- Arguments: `start`
- Working Directory: `YourModule/build/plugin/YourTouchPortalPlugin`
-[](#debugging-tips)
+
diff --git a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
index 14a5a97..c7f15fc 100644
--- a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
+++ b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
@@ -33,8 +33,13 @@
import java.util.logging.Level;
import java.util.logging.Logger;
-@SuppressWarnings("unused")
-@Plugin(version = BuildConfig.VERSION_CODE, colorDark = "#203060", colorLight = "#4070F0", name = "Touch Portal Plugin Example", parentCategory = ParentCategory.CONTENT)
+@Plugin(
+ version = BuildConfig.VERSION_CODE,
+ colorDark = "#203060",
+ colorLight = "#4070F0",
+ name = BuildConfig.NAME,
+ parentCategory = ParentCategory.CONTENT
+)
public class TouchPortalSampleJavaPlugin extends TouchPortalPlugin implements TouchPortalPlugin.TouchPortalPluginListener {
/**
* Logger
@@ -80,7 +85,7 @@ private enum Categories {
* Setting of type number definition example
*/
@Setting(name = "Update Delay", defaultValue = "10", minValue = 10, maxValue = 30)
- private int updateDelaySetting;
+ private int updateDelaySetting = 10;
/**
* Setting of type String and is read only definition example
@@ -122,7 +127,7 @@ public static void main(String... args) {
if (connectedPairedAndListening) {
// Update a State with the ID from the Generated Constants Class
- boolean stateUpdated = touchPortalSampleJavaPlugin.sendStateUpdate(TouchPortalSampleJavaPluginConstants.BaseCategory.States.CustomStateWithEvent.ID, "2");
+ touchPortalSampleJavaPlugin.sendStateUpdate(TouchPortalSampleJavaPluginConstants.BaseCategory.States.CustomStateWithEvent.ID, "2");
// Create a new State
touchPortalSampleJavaPlugin.sendCreateState("BaseCategory", "createdState1", "Created State 01", System.currentTimeMillis() + "1");
@@ -147,7 +152,8 @@ public static void main(String... args) {
touchPortalSampleJavaPlugin.sendConnectorUpdate(TouchPortalSampleJavaPluginConstants.ID, TouchPortalSampleJavaPluginConstants.BaseCategory.Connectors.ConnectorSimple.ID, 90, null);
try {
Thread.sleep(1000);
- } catch (InterruptedException ignored) {}
+ } catch (InterruptedException ignored) {
+ }
touchPortalSampleJavaPlugin.sendConnectorUpdate(TouchPortalSampleJavaPluginConstants.ID, TouchPortalSampleJavaPluginConstants.BaseCategory.Connectors.ConnectorSimple.ID, 50, null);
}
}
diff --git a/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt b/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt
index d88020c..7e23c6c 100644
--- a/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt
+++ b/SampleKotlin/src/main/kotlin/com/christophecvb/touchportal/samplekotlin/TouchPortalSampleKotlinPlugin.kt
@@ -20,25 +20,27 @@
package com.christophecvb.touchportal.samplekotlin
-import com.christophecvb.touchportal.annotations.Action
-import com.christophecvb.touchportal.annotations.Category
-import com.christophecvb.touchportal.annotations.Plugin
import com.christophecvb.touchportal.helpers.PluginHelper
import com.christophecvb.touchportal.TouchPortalPlugin
-import com.christophecvb.touchportal.annotations.Data
+import com.christophecvb.touchportal.annotations.*
import com.christophecvb.touchportal.model.*
import com.google.gson.JsonObject
import java.util.logging.Level
import java.util.logging.Logger
import kotlin.system.exitProcess
-@Suppress("unused")
-@Plugin(version = BuildConfig.VERSION_CODE, colorDark = "#556677", colorLight = "#112233")
+@Plugin(
+ name = BuildConfig.NAME,
+ version = BuildConfig.VERSION_CODE,
+ colorDark = "#556677",
+ colorLight = "#112233",
+ parentCategory = ParentCategory.MISC
+)
class TouchPortalSampleKotlinPlugin(parallelizeActions: Boolean) : TouchPortalPlugin(parallelizeActions), TouchPortalPlugin.TouchPortalPluginListener {
companion object {
/**
- * Logger
+ * Logger used within the plugin
*/
private val LOGGER = Logger.getLogger(TouchPortalPlugin::class.java.name)
@@ -51,7 +53,7 @@ class TouchPortalSampleKotlinPlugin(parallelizeActions: Boolean) : TouchPortalPl
// Initiate the connection with the Touch Portal Plugin System
val connectedPairedAndListening = touchPortalSampleKotlinPlugin.connectThenPairAndListen(touchPortalSampleKotlinPlugin)
- @Suppress("ControlFlowWithEmptyBody")
+
if (connectedPairedAndListening) {
// Let's go!
LOGGER.log(Level.INFO, "Plugin with ID[${TouchPortalSampleKotlinPluginConstants.ID}] Connected and Paired!")
@@ -61,7 +63,6 @@ class TouchPortalSampleKotlinPlugin(parallelizeActions: Boolean) : TouchPortalPl
}
}
- @Suppress("unused")
enum class Categories {
@Category(imagePath = "images/icon-24.png")
BaseCategory
From e775dcec812fee4b5416eaf7279524ff7e8fd959 Mon Sep 17 00:00:00 2001
From: Christophe Carvalho Vilas-Boas
Date: Fri, 16 Dec 2022 01:17:44 +0100
Subject: [PATCH 32/41] core: Call TPInvokable.onInvoke from callbacksExecutor
---
.../touchportal/TouchPortalPlugin.java | 33 ++++++++++++++++---
README.md | 2 +-
2 files changed, 29 insertions(+), 6 deletions(-)
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
index def900f..1a75cd0 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
@@ -347,12 +347,25 @@ else if (declaredField.getType().isAssignableFrom(TPActionMessage.class)) {
}
}
- tpInvokable.onInvoke();
+ this.heldActionsStates.put(tpActionMessage.actionId, held);
+ this.callbacksExecutor.submit(() -> {
+ try {
+ tpInvokable.onInvoke();
+ }
+ catch (Exception e) {
+ TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action could not be invoked", e);
+ }
+ finally {
+ if (held == null || !held) {
+ this.heldActionsStates.remove(tpActionMessage.actionId);
+ }
+ }
+ });
invoked = true;
}
catch (ReflectiveOperationException e) {
- TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action could not be created or invoked", e);
+ TouchPortalPlugin.LOGGER.log(Level.WARNING, "Action could not be instanced", e);
}
}
else {
@@ -396,7 +409,7 @@ else if (parameter.getType().isAssignableFrom(TPActionMessage.class)) {
invoked = true;
}
catch (MethodDataParameterException e) {
- TouchPortalPlugin.LOGGER.log(Level.WARNING, e.getMessage(), e);
+ TouchPortalPlugin.LOGGER.log(Level.WARNING, "Action method data parameters could not be retrieved", e);
}
break;
}
@@ -436,12 +449,20 @@ else if (declaredField.getType().isAssignableFrom(TPConnectorChangeMessage.class
}
}
- tpInvokable.onInvoke();
+ this.currentConnectorValues.put(tpConnectorChangeMessage.getConstructedId(), tpConnectorChangeMessage.value);
+ this.callbacksExecutor.submit(() -> {
+ try {
+ tpInvokable.onInvoke();
+ }
+ catch (Exception e) {
+ TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Connector could not be invoked", e);
+ }
+ });
invoked = true;
}
catch (ReflectiveOperationException e) {
- TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Action could not be created or invoked", e);
+ TouchPortalPlugin.LOGGER.log(Level.WARNING, "Connector could not be created or invoked", e);
}
}
else {
@@ -470,6 +491,7 @@ else if (parameter.getType().isAssignableFrom(TPConnectorChangeMessage.class)) {
throw new MethodDataParameterException(method, parameter);
}
}
+
this.currentConnectorValues.put(tpConnectorChangeMessage.getConstructedId(), tpConnectorChangeMessage.value);
this.callbacksExecutor.submit(() -> {
try {
@@ -480,6 +502,7 @@ else if (parameter.getType().isAssignableFrom(TPConnectorChangeMessage.class)) {
TouchPortalPlugin.LOGGER.log(Level.SEVERE, "Connector method could not be invoked", e);
}
});
+
invoked = true;
}
catch (MethodDataParameterException e) {
diff --git a/README.md b/README.md
index 9a5241f..6445d72 100644
--- a/README.md
+++ b/README.md
@@ -164,7 +164,7 @@ public class MyTouchPortalPlugin extends TouchPortalPlugin implements TouchPorta
public void onInfo(TPInfoMessage tpInfoMessage) {
// TPInfoMessage will contain the initial settings stored by TP
- // -> Note that your annotated Settings fields will be up to date at this point
+ // -> Note that your annotated Settings fields will be up-to-date at this point
// continue plugin initialization
}
From d7f8526051577c49189f393900b100077ccf4d23 Mon Sep 17 00:00:00 2001
From: Christophe Carvalho Vilas-Boas
Date: Tue, 20 Dec 2022 02:05:07 +0100
Subject: [PATCH 33/41] core: TPInvokable.onListChanged core: Use
callbacksExecutor
---
.../helpers/ReceivedMessageHelper.java | 4 +-
.../touchportal/TouchPortalPlugin.java | 59 ++++++++++++++-----
.../touchportal/test/LibraryTests.java | 4 +-
3 files changed, 48 insertions(+), 19 deletions(-)
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ReceivedMessageHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ReceivedMessageHelper.java
index 2af3ced..b6e7c96 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ReceivedMessageHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/ReceivedMessageHelper.java
@@ -40,7 +40,7 @@ public class ReceivedMessageHelper {
public static final String TYPE_CONNECTOR_CHANGE = "connectorChange";
public static final String TYPE_SHORT_CONNECTOR_ID_NOTIFICATION = "shortConnectorIdNotification";
public static final String TYPE_INFO = "info";
- public static final String TYPE_LIST_CHANGE = "listChange";
+ public static final String TYPE_LIST_CHANGED = "listChange";
public static final String TYPE_CLOSE_PLUGIN = "closePlugin";
public static final String TYPE_BROADCAST = "broadcast";
public static final String TYPE_SETTINGS = "settings";
@@ -87,7 +87,7 @@ public static boolean isTypeAction(JsonObject jsonMessage) {
* @return boolean isMessageAListChange
*/
public static boolean isTypeListChange(JsonObject jsonMessage) {
- return ReceivedMessageHelper.TYPE_LIST_CHANGE.equals(ReceivedMessageHelper.getType(jsonMessage));
+ return ReceivedMessageHelper.TYPE_LIST_CHANGED.equals(ReceivedMessageHelper.getType(jsonMessage));
}
/**
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
index 1a75cd0..700c690 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
@@ -26,6 +26,7 @@
import com.christophecvb.touchportal.model.deserializer.TPMessageDeserializer;
import com.google.gson.*;
import okhttp3.*;
+import org.jetbrains.annotations.NotNull;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
@@ -190,7 +191,7 @@ private Thread createListenerThread() {
TPMessageDeserializer tpMessageDeserializer = new TPMessageDeserializer();
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_CLOSE_PLUGIN, TPClosePluginMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_INFO, TPInfoMessage.class);
- tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_LIST_CHANGE, TPListChangedMessage.class);
+ tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_LIST_CHANGED, TPListChangedMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_BROADCAST, TPBroadcastMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_SETTINGS, TPSettingsMessage.class);
tpMessageDeserializer.registerTPMessageType(ReceivedMessageHelper.TYPE_ACTION, TPActionMessage.class);
@@ -230,21 +231,40 @@ private void onMessage(String socketMessage) throws SocketException, JsonParseEx
this.updateSettingFields(this.tpInfoMessage.settings);
if (this.touchPortalPluginListener != null) {
- this.touchPortalPluginListener.onInfo(this.tpInfoMessage);
+ this.callbacksExecutor.submit(() -> {
+ this.touchPortalPluginListener.onInfo(this.tpInfoMessage);
+ });
}
break;
- case ReceivedMessageHelper.TYPE_LIST_CHANGE:
- TPListChangedMessage listChangeMessage = (TPListChangedMessage) tpMessage;
+ case ReceivedMessageHelper.TYPE_LIST_CHANGED:
+ TPListChangedMessage tpListChangedMessage = (TPListChangedMessage) tpMessage;
+ if (this.registeredInvokables.containsKey(tpListChangedMessage.actionId)) {
+ Class invokableClass = this.registeredInvokables.get(tpListChangedMessage.actionId);
+ try {
+ TPInvokable tpInvokable = this.instantiateTPInvokable(invokableClass);
+
+ this.callbacksExecutor.submit(() -> {
+ tpInvokable.onListChanged(tpListChangedMessage);
+ });
+ }
+ catch (ReflectiveOperationException e) {
+ TouchPortalPlugin.LOGGER.log(Level.WARNING, "Invokable could not be created or its onListChanged could not be invoked", e);
+ }
+ }
if (this.touchPortalPluginListener != null) {
- this.touchPortalPluginListener.onListChanged(listChangeMessage);
+ this.callbacksExecutor.submit(() -> {
+ this.touchPortalPluginListener.onListChanged(tpListChangedMessage);
+ });
}
break;
case ReceivedMessageHelper.TYPE_BROADCAST:
TPBroadcastMessage tpBroadcastMessage = (TPBroadcastMessage) tpMessage;
if (this.touchPortalPluginListener != null) {
- this.touchPortalPluginListener.onBroadcast(tpBroadcastMessage);
+ this.callbacksExecutor.submit(() -> {
+ this.touchPortalPluginListener.onBroadcast(tpBroadcastMessage);
+ });
}
break;
@@ -254,14 +274,18 @@ private void onMessage(String socketMessage) throws SocketException, JsonParseEx
this.updateSettingFields(tpSettingsMessage.settings);
if (this.touchPortalPluginListener != null) {
- this.touchPortalPluginListener.onSettings(tpSettingsMessage);
+ this.callbacksExecutor.submit(() -> {
+ this.touchPortalPluginListener.onSettings(tpSettingsMessage);
+ });
}
break;
case ReceivedMessageHelper.TYPE_NOTIFICATION_OPTION_CLICKED:
TPNotificationOptionClickedMessage tpNotificationOptionClickedMessage = (TPNotificationOptionClickedMessage) tpMessage;
if (this.touchPortalPluginListener != null) {
- this.touchPortalPluginListener.onNotificationOptionClicked(tpNotificationOptionClickedMessage);
+ this.callbacksExecutor.submit(() -> {
+ this.touchPortalPluginListener.onNotificationOptionClicked(tpNotificationOptionClickedMessage);
+ });
}
break;
@@ -293,7 +317,9 @@ private void onMessage(String socketMessage) throws SocketException, JsonParseEx
}
if (!called) {
if (this.touchPortalPluginListener != null) {
- this.touchPortalPluginListener.onReceived(jsonMessage);
+ this.callbacksExecutor.submit(() -> {
+ this.touchPortalPluginListener.onReceived(jsonMessage);
+ });
}
}
}
@@ -303,6 +329,13 @@ private void onMessage(String socketMessage) throws SocketException, JsonParseEx
}
}
+ private TPInvokable instantiateTPInvokable(Class invokableClass) throws NoSuchMethodException, InstantiationException, IllegalAccessException, InvocationTargetException {
+ Class typedTouchPortalPlugin = (Class) ((ParameterizedType) invokableClass.getGenericSuperclass()).getActualTypeArguments()[0];
+ Constructor constructor = invokableClass.getConstructor(typedTouchPortalPlugin);
+ TPInvokable tpInvokable = constructor.newInstance(this);
+ return tpInvokable;
+ }
+
private void updateSettingFields(HashMap settings) {
Field[] pluginSettingFields = Arrays.stream(this.pluginClass.getDeclaredFields()).filter(field -> field.isAnnotationPresent(Setting.class)).toArray(Field[]::new);
for (String settingName : settings.keySet()) {
@@ -327,9 +360,7 @@ private boolean onActionReceived(TPActionMessage tpActionMessage, JsonObject jso
if (this.registeredInvokables.containsKey(tpActionMessage.actionId)) {
Class invokableClass = this.registeredInvokables.get(tpActionMessage.actionId);
try {
- Class typedTouchPortalPlugin = (Class) ((ParameterizedType) invokableClass.getGenericSuperclass()).getActualTypeArguments()[0];
- Constructor constructor = invokableClass.getConstructor(typedTouchPortalPlugin);
- TPInvokable tpInvokable = constructor.newInstance(this);
+ TPInvokable tpInvokable = this.instantiateTPInvokable(invokableClass);
for (Field declaredField : invokableClass.getDeclaredFields()) {
if (declaredField.isAnnotationPresent(Data.class)) {
@@ -425,9 +456,7 @@ private boolean onConnectorChangeReceived(TPConnectorChangeMessage tpConnectorCh
if (this.registeredInvokables.containsKey(tpConnectorChangeMessage.connectorId)) {
Class invokableClass = this.registeredInvokables.get(tpConnectorChangeMessage.connectorId);
try {
- Class typedTouchPortalPlugin = (Class) ((ParameterizedType) invokableClass.getGenericSuperclass()).getActualTypeArguments()[0];
- Constructor constructor = invokableClass.getConstructor(typedTouchPortalPlugin);
- TPInvokable tpInvokable = constructor.newInstance(this);
+ TPInvokable tpInvokable = this.instantiateTPInvokable(invokableClass);
for (Field declaredField : invokableClass.getDeclaredFields()) {
if (declaredField.isAnnotationPresent(Data.class)) {
diff --git a/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java b/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
index 55e2cf3..d71df95 100644
--- a/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
+++ b/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
@@ -734,7 +734,7 @@ public void testReceiveListChange() throws IOException, InterruptedException {
LOGGER.log(Level.FINE, "Now");
JsonObject jsonMessage = new JsonObject();
jsonMessage.addProperty(ReceivedMessageHelper.PLUGIN_ID, TouchPortalPluginTestConstants.ID);
- jsonMessage.addProperty(ReceivedMessageHelper.TYPE, ReceivedMessageHelper.TYPE_LIST_CHANGE);
+ jsonMessage.addProperty(ReceivedMessageHelper.TYPE, ReceivedMessageHelper.TYPE_LIST_CHANGED);
PrintWriter out = new PrintWriter(this.serverSocketClient.getOutputStream(), true);
out.println(jsonMessage);
@@ -751,7 +751,7 @@ public void testReceiveListChangeNoListener() throws IOException, InterruptedExc
this.touchPortalPluginTest.connectThenPairAndListen(null);
JsonObject jsonMessage = new JsonObject();
jsonMessage.addProperty(ReceivedMessageHelper.PLUGIN_ID, TouchPortalPluginTestConstants.ID);
- jsonMessage.addProperty(ReceivedMessageHelper.TYPE, ReceivedMessageHelper.TYPE_LIST_CHANGE);
+ jsonMessage.addProperty(ReceivedMessageHelper.TYPE, ReceivedMessageHelper.TYPE_LIST_CHANGED);
PrintWriter out = new PrintWriter(this.serverSocketClient.getOutputStream(), true);
out.println(jsonMessage);
From 2135ebbe10d51d5cee2fb6c78c3170f611c8ff1d Mon Sep 17 00:00:00 2001
From: Christophe Carvalho Vilas-Boas
Date: Tue, 20 Dec 2022 16:11:26 +0100
Subject: [PATCH 34/41] core: Revert to System Java instalation
---
.../com/christophecvb/touchportal/helpers/PluginHelper.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
index 66febb3..34a590c 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
@@ -59,7 +59,7 @@ public class PluginHelper {
/**
* Touch Portal Plugin System TP_JAVA_FILE
*/
- public static final String TP_JAVA = "%TP_JAVA_FILE%";
+ public static final String TP_JAVA = "java";
/**
* Touch Portal entry file
*/
From 5c77140b19cd01d07d1b92d22869a6225eeb0f2f Mon Sep 17 00:00:00 2001
From: Christophe Carvalho Vilas-Boas
Date: Tue, 20 Dec 2022 17:05:50 +0100
Subject: [PATCH 35/41] core: Revert to System Java instalation
---
.../annotations/processor/PluginProcessor.java | 8 ++++----
.../christophecvb/touchportal/helpers/PluginHelper.java | 2 +-
2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java
index eb5182b..7ddbbdc 100644
--- a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java
+++ b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java
@@ -44,10 +44,10 @@ public static Pair process(TouchPortalPluginAnnota
jsonConfiguration.addProperty(PluginHelper.CONFIGURATION_COLOR_LIGHT, plugin.colorLight());
jsonConfiguration.addProperty(PluginHelper.CONFIGURATION_PARENT_CATEGORY, plugin.parentCategory().getKey());
jsonPlugin.add(PluginHelper.CONFIGURATION, jsonConfiguration);
- jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND, PluginHelper.TP_JAVA + " -Dapple.awt.UIElement=true -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
- jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND + PluginHelper.PLUGIN_START_COMMAND_SUFFIX_WIN, PluginHelper.TP_JAVA + " -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
- jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND + PluginHelper.PLUGIN_START_COMMAND_SUFFIX_MACOS, PluginHelper.TP_JAVA + " -Dapple.awt.UIElement=true -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
- jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND + PluginHelper.PLUGIN_START_COMMAND_SUFFIX_LINUX, PluginHelper.TP_JAVA + " -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
+ jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND, "java -Dapple.awt.UIElement=true -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
+ jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND + PluginHelper.PLUGIN_START_COMMAND_SUFFIX_WIN, "java -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
+ jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND + PluginHelper.PLUGIN_START_COMMAND_SUFFIX_MACOS, "java -Dapple.awt.UIElement=true -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
+ jsonPlugin.addProperty(PluginHelper.PLUGIN_START_COMMAND + PluginHelper.PLUGIN_START_COMMAND_SUFFIX_LINUX, "java -jar ./" + pluginElement.getSimpleName() + ".jar " + PluginHelper.COMMAND_START);
TypeSpec.Builder settingsTypeSpecBuilder = TypeSpec.classBuilder("Settings").addModifiers(Modifier.PUBLIC, Modifier.STATIC);
JsonArray jsonSettings = new JsonArray();
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
index 34a590c..66febb3 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
@@ -59,7 +59,7 @@ public class PluginHelper {
/**
* Touch Portal Plugin System TP_JAVA_FILE
*/
- public static final String TP_JAVA = "java";
+ public static final String TP_JAVA = "%TP_JAVA_FILE%";
/**
* Touch Portal entry file
*/
From ee1d08995c2f21b2784968a9caa20e14612cd303 Mon Sep 17 00:00:00 2001
From: Christophe Carvalho Vilas-Boas
Date: Tue, 20 Dec 2022 17:41:19 +0100
Subject: [PATCH 36/41] core: 9.0.0
---
build.gradle | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/build.gradle b/build.gradle
index 0d0f82d..8bff204 100644
--- a/build.gradle
+++ b/build.gradle
@@ -4,8 +4,8 @@ allprojects {
}
}
-ext.versionMajor = 8
-ext.versionMinor = 4
+ext.versionMajor = 9
+ext.versionMinor = 0
ext.versionPatch = 0
ext.isRelease = System.getenv('IS_RELEASE') == 'YES'
From 170d48323f307078cba247fbe2d5cba1f4622f2b Mon Sep 17 00:00:00 2001
From: Pjiesco <55349095+Pjiesco@users.noreply.github.com>
Date: Fri, 6 Oct 2023 14:13:04 +0200
Subject: [PATCH 37/41] Feat: TriggerEvent (#63)
---
.../helpers/SentMessageHelper.java | 3 ++
.../touchportal/TouchPortalPlugin.java | 31 ++++++++++++++++++-
.../touchportal/test/LibraryTests.java | 13 ++++++++
.../TouchPortalSampleJavaPlugin.java | 6 ++++
4 files changed, 52 insertions(+), 1 deletion(-)
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java
index a852b12..bfb1339 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java
@@ -34,6 +34,7 @@ public class SentMessageHelper {
public static final String TYPE_SETTING_UPDATE = "settingUpdate";
public static final String TYPE_SHOW_NOTIFICATION = "showNotification";
public static final String TYPE_CONNECTOR_UPDATE = "connectorUpdate";
+ public static final String TYPE_TRIGGER_EVENT = "triggerEvent";
public static final String INSTANCE_ID = "instanceId";
public static final String ID = GenericHelper.ID;
public static final String VALUE = GenericHelper.VALUE;
@@ -48,5 +49,7 @@ public class SentMessageHelper {
public static final String CONNECTOR_ID = "connectorId";
public static final String SHORT_ID = "shortId";
public static final String PARENT_GROUP = "parentGroup";
+ public static final String EVENT_ID = "eventId";
+ public static final String STATES = "states";
}
\ No newline at end of file
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
index 700c690..9ba6233 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
@@ -26,7 +26,6 @@
import com.christophecvb.touchportal.model.deserializer.TPMessageDeserializer;
import com.google.gson.*;
import okhttp3.*;
-import org.jetbrains.annotations.NotNull;
import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
@@ -1050,6 +1049,36 @@ public boolean sendShowNotification(String notificationId, String title, String
return sent;
}
+ /**
+ * Send a Trigger Event message to the Touch Portal Plugin System
+ *
+ * @param eventId String
+ * @param states Map<String, Object> Key value pair of state id and value
+ * @return Boolean sent
+ */
+ public boolean sendTriggerEvent(String eventId, Map states) {
+ boolean sent = false;
+ if (eventId != null && !eventId.isEmpty()) {
+ JsonObject triggerEventMessage = new JsonObject();
+ triggerEventMessage.addProperty(SentMessageHelper.TYPE, SentMessageHelper.TYPE_TRIGGER_EVENT);
+ triggerEventMessage.addProperty(SentMessageHelper.EVENT_ID, eventId);
+
+ if (states != null && !states.isEmpty()) {
+ JsonObject jsonStates = new JsonObject();
+
+ states.forEach((id, value) -> {
+ jsonStates.addProperty(id, String.valueOf(value));
+ });
+ triggerEventMessage.add(SentMessageHelper.STATES, jsonStates);
+ }
+
+ sent = this.send(triggerEventMessage);
+ TouchPortalPlugin.LOGGER.info("Trigger Event [" + eventId + "] Sent [" + sent + "]");
+ }
+
+ return sent;
+ }
+
/**
* Send a Connector Update Message to the Touch Portal Plugin System
*
diff --git a/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java b/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
index d71df95..dc16d5a 100644
--- a/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
+++ b/Library/src/test/java/com/christophecvb/touchportal/test/LibraryTests.java
@@ -395,6 +395,19 @@ public void testSendFail() {
assertFalse(this.touchPortalPluginTest.sendRemoveState("BaseCategory", "StateId"));
}
+ @Test
+ public void testTriggerEvent() {
+ LOGGER.log(Level.FINE, "Now");
+ assertFalse(this.touchPortalPluginTest.sendTriggerEvent(null, null));
+ assertFalse(this.touchPortalPluginTest.sendTriggerEvent("", null));
+
+ assertTrue(this.touchPortalPluginTest.sendTriggerEvent(TouchPortalPluginTestConstants.BaseCategory.Events.CustomState.ID, null));
+
+ HashMap states = new HashMap<>();
+ states.put(TouchPortalPluginTestConstants.BaseCategory.States.CustomState.ID, "StateValue");
+ assertTrue(this.touchPortalPluginTest.sendTriggerEvent(TouchPortalPluginTestConstants.BaseCategory.Events.CustomState.ID, states));
+ }
+
@Test
public void testReceiveActionNoId() throws IOException, InterruptedException {
LOGGER.log(Level.FINE, "Now");
diff --git a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
index c7f15fc..2737b69 100644
--- a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
+++ b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
@@ -30,6 +30,8 @@
import com.google.gson.JsonObject;
import java.io.File;
+import java.util.HashMap;
+import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -155,6 +157,10 @@ public static void main(String... args) {
} catch (InterruptedException ignored) {
}
touchPortalSampleJavaPlugin.sendConnectorUpdate(TouchPortalSampleJavaPluginConstants.ID, TouchPortalSampleJavaPluginConstants.BaseCategory.Connectors.ConnectorSimple.ID, 50, null);
+
+ HashMap states = new HashMap<>();
+ states.put(TouchPortalSampleJavaPluginConstants.BaseCategory.States.CustomStateWithEvent.ID, "Value");
+ touchPortalSampleJavaPlugin.sendTriggerEvent(TouchPortalSampleJavaPluginConstants.BaseCategory.Events.CustomStateWithEvent.ID, states);
}
}
}
From 1964ce0f9cea3af972386b3c4233c986e3d757f1 Mon Sep 17 00:00:00 2001
From: Pjiesco <55349095+Pjiesco@users.noreply.github.com>
Date: Fri, 6 Oct 2023 14:14:49 +0200
Subject: [PATCH 38/41] Feat: forceUpdate (#64)
Co-authored-by: Christophe Carvalho Vilas-Boas
---
.../com/christophecvb/touchportal/helpers/SentMessageHelper.java | 1 +
.../java/com/christophecvb/touchportal/TouchPortalPlugin.java | 1 +
2 files changed, 2 insertions(+)
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java
index bfb1339..afa854a 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SentMessageHelper.java
@@ -49,6 +49,7 @@ public class SentMessageHelper {
public static final String CONNECTOR_ID = "connectorId";
public static final String SHORT_ID = "shortId";
public static final String PARENT_GROUP = "parentGroup";
+ public static final String FORCE_UPDATE = "forceUpdate";
public static final String EVENT_ID = "eventId";
public static final String STATES = "states";
diff --git a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
index 9ba6233..7beec98 100644
--- a/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
+++ b/Library/src/main/java/com/christophecvb/touchportal/TouchPortalPlugin.java
@@ -904,6 +904,7 @@ public boolean sendCreateState(String categoryId, String stateId, String parentG
createStateMessage.addProperty(SentMessageHelper.ID, stateId);
createStateMessage.addProperty(SentMessageHelper.DESCRIPTION, description);
createStateMessage.addProperty(SentMessageHelper.DEFAULT_VALUE, valueStr);
+ createStateMessage.addProperty(SentMessageHelper.FORCE_UPDATE, true);
if (parentGroup == null || parentGroup.isEmpty()) {
classLoop:
for (Class subClass : this.pluginClass.getDeclaredClasses()) {
From cc5c91577aa8ec79dec329249b7971c34f5a9be7 Mon Sep 17 00:00:00 2001
From: Pjiesco <55349095+Pjiesco@users.noreply.github.com>
Date: Fri, 6 Oct 2023 16:56:03 +0200
Subject: [PATCH 39/41] Change `sdk` to `api` (#66)
---
.../touchportal/annotations/processor/PluginProcessor.java | 2 +-
.../com/christophecvb/touchportal/helpers/PluginHelper.java | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java
index 7ddbbdc..f68dcde 100644
--- a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java
+++ b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/PluginProcessor.java
@@ -35,7 +35,7 @@ public static Pair process(TouchPortalPluginAnnota
TypeSpec.Builder pluginTypeSpecBuilder = SpecUtils.createPluginTypeSpecBuilder(pluginElement, plugin);
JsonObject jsonPlugin = new JsonObject();
- jsonPlugin.addProperty(PluginHelper.SDK, PluginHelper.TOUCH_PORTAL_PLUGIN_VERSION);
+ jsonPlugin.addProperty(PluginHelper.API, PluginHelper.TOUCH_PORTAL_PLUGIN_VERSION);
jsonPlugin.addProperty(PluginHelper.VERSION, plugin.version());
jsonPlugin.addProperty(PluginHelper.NAME, PluginHelper.getPluginName(pluginElement, plugin));
jsonPlugin.addProperty(PluginHelper.ID, PluginHelper.getPluginId(pluginElement));
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
index 66febb3..fc777ec 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/PluginHelper.java
@@ -29,7 +29,7 @@
* Touch Portal Plugin Plugin Helper
*/
public class PluginHelper {
- public static final String SDK = "sdk";
+ public static final String API = "api";
public static final String VERSION = "version";
public static final String NAME = GenericHelper.NAME;
public static final String ID = GenericHelper.ID;
From ca95a1ffb65c8cd4a7a6db66b8774fded83f72b0 Mon Sep 17 00:00:00 2001
From: "lgtm-com[bot]" <43144390+lgtm-com[bot]@users.noreply.github.com>
Date: Fri, 6 Oct 2023 17:14:48 +0200
Subject: [PATCH 40/41] Add CodeQL workflow for GitHub code scanning (#53)
Co-authored-by: LGTM Migrator
---
.github/workflows/codeql.yml | 41 ++++++++++++++++++++++++++++++++++++
1 file changed, 41 insertions(+)
create mode 100644 .github/workflows/codeql.yml
diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml
new file mode 100644
index 0000000..2e7379e
--- /dev/null
+++ b/.github/workflows/codeql.yml
@@ -0,0 +1,41 @@
+name: "CodeQL"
+
+on:
+ push:
+ branches: [ "master", "develop" ]
+ pull_request:
+ branches: [ "master" ]
+ schedule:
+ - cron: "28 7 * * 6"
+
+jobs:
+ analyze:
+ name: Analyze
+ runs-on: ubuntu-latest
+ permissions:
+ actions: read
+ contents: read
+ security-events: write
+
+ strategy:
+ fail-fast: false
+ matrix:
+ language: [ java ]
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v2
+ with:
+ languages: ${{ matrix.language }}
+ queries: +security-and-quality
+
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v2
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v2
+ with:
+ category: "/language:${{ matrix.language }}"
From b034dd9421ccc5c8de22daddf070ca9ebf9d5f77 Mon Sep 17 00:00:00 2001
From: Pjiesco <55349095+Pjiesco@users.noreply.github.com>
Date: Thu, 26 Oct 2023 09:30:31 +0200
Subject: [PATCH 41/41] [API 7] Setting Tooltip (#65)
* Feat: Setting Tooltip
* fix: use java 8
* Remove empty lines
* Check if empty
* use UpperCamelCase instead of Full uppercase
* Check if empty
---
.../touchportal/annotations/Setting.java | 13 +++++++++++
.../processor/SettingProcessor.java | 16 ++++++++++++++
.../processor/utils/SpecUtils.java | 22 +++++++++++++++++++
.../touchportal/helpers/SettingHelper.java | 7 ++++++
.../TouchPortalSampleJavaPlugin.java | 7 ++++--
5 files changed, 63 insertions(+), 2 deletions(-)
diff --git a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Setting.java b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Setting.java
index eded71f..6d276dc 100644
--- a/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Setting.java
+++ b/Annotations/src/main/java/com/christophecvb/touchportal/annotations/Setting.java
@@ -99,4 +99,17 @@
* @return boolean isReadOnly
*/
boolean isReadOnly() default false;
+
+ /**
+ * Setting Tooltip
+ *
+ * @return {@link Tooltip} tooltip
+ */
+ Tooltip tooltip() default @Tooltip(body = "");
+
+ @interface Tooltip {
+ String title() default "";
+ String body();
+ String docUrl() default "";
+ }
}
diff --git a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/SettingProcessor.java b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/SettingProcessor.java
index 589f1c3..6e27f22 100644
--- a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/SettingProcessor.java
+++ b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/SettingProcessor.java
@@ -34,6 +34,22 @@ public static Pair process(TouchPortalPluginAnnota
jsonSetting.addProperty(SettingHelper.TYPE, desiredTPType);
jsonSetting.addProperty(SettingHelper.DEFAULT, setting.defaultValue());
jsonSetting.addProperty(SettingHelper.IS_READ_ONLY, setting.isReadOnly());
+
+ if (!setting.tooltip().body().isEmpty()) {
+ JsonObject tooltip = new JsonObject();
+
+ tooltip.addProperty(SettingHelper.Tooltip.BODY, setting.tooltip().body());
+
+ if (!setting.tooltip().title().isEmpty()) {
+ tooltip.addProperty(SettingHelper.Tooltip.TITLE, setting.tooltip().title());
+ }
+ if (!setting.tooltip().docUrl().isEmpty()) {
+ tooltip.addProperty(SettingHelper.Tooltip.DOC_URL, setting.tooltip().docUrl());
+ }
+
+ jsonSetting.add(SettingHelper.TOOLTIP, tooltip);
+ }
+
switch (desiredTPType) {
case SettingHelper.TYPE_TEXT:
if (setting.maxLength() > 0) {
diff --git a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/utils/SpecUtils.java b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/utils/SpecUtils.java
index c681c16..044022f 100644
--- a/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/utils/SpecUtils.java
+++ b/AnnotationsProcessor/src/main/java/com/christophecvb/touchportal/annotations/processor/utils/SpecUtils.java
@@ -197,9 +197,31 @@ public static TypeSpec.Builder createSettingTypeSpecBuilder(Element settingEleme
stateTypeSpecBuilder.addField(SpecUtils.getStaticFinalDoubleFieldSpec("max_value", setting.maxValue()));
}
+ if (!setting.tooltip().body().isEmpty()) {
+ stateTypeSpecBuilder.addType(createSettingTooltipTypeSpecBuilder(setting.tooltip()).build());
+ }
+
return stateTypeSpecBuilder;
}
+ /**
+ * Generates a TypeSpec.Builder with Constants for the {@link Setting.Tooltip}
+ *
+ * @param tooltip {@link Setting.Tooltip}
+ * @return TypeSpec.Builder tooltipTypeSpecBuilder
+ */
+ public static TypeSpec.Builder createSettingTooltipTypeSpecBuilder(Setting.Tooltip tooltip) {
+ TypeSpec.Builder tooltipTypeSpecBuilder = TypeSpec.classBuilder("Tooltip").addModifiers(Modifier.PUBLIC, Modifier.STATIC);
+ tooltipTypeSpecBuilder.addField(SpecUtils.getStaticFinalStringFieldSpec("body", tooltip.body()));
+ if (!tooltip.title().isEmpty()) {
+ tooltipTypeSpecBuilder.addField(SpecUtils.getStaticFinalStringFieldSpec("title", tooltip.title()));
+ }
+ if (!tooltip.title().isEmpty()) {
+ tooltipTypeSpecBuilder.addField(SpecUtils.getStaticFinalStringFieldSpec("docUrl", tooltip.docUrl()));
+ }
+ return tooltipTypeSpecBuilder;
+ }
+
/**
* Generates a TypeSpec.Builder with Constants for the {@link State}
*
diff --git a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SettingHelper.java b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SettingHelper.java
index e559e98..a78eff3 100644
--- a/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SettingHelper.java
+++ b/Helpers/src/main/java/com/christophecvb/touchportal/helpers/SettingHelper.java
@@ -39,6 +39,13 @@ public class SettingHelper {
public static final String MIN_VALUE = "minValue";
public static final String MAX_VALUE = "maxValue";
public static final String IS_READ_ONLY = "readOnly";
+ public static final String TOOLTIP = "tooltip";
+
+ public static class Tooltip {
+ public static final String TITLE = "title";
+ public static final String BODY = "body";
+ public static final String DOC_URL = "docUrl";
+ }
/**
* Get the generated Setting Name
diff --git a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
index 2737b69..0f96873 100644
--- a/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
+++ b/SampleJava/src/main/java/com/christophecvb/touchportal/samplejava/TouchPortalSampleJavaPlugin.java
@@ -31,7 +31,6 @@
import java.io.File;
import java.util.HashMap;
-import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;
@@ -80,7 +79,11 @@ private enum Categories {
/**
* Setting of type text definition example
*/
- @Setting(name = "IP", defaultValue = "localhost", maxLength = 15)
+ @Setting(name = "IP", defaultValue = "localhost", maxLength = 15, tooltip = @Setting.Tooltip(
+ title = "IP address",
+ body = "ip address to connect to",
+ docUrl = "https://example.com"
+ ))
private String ipSetting;
/**