Package: JavaFXSafeProxy$Proxied

JavaFXSafeProxy$Proxied

Coverage

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * SteelBlue: DCI User Interfaces
5: * http://tidalwave.it/projects/steelblue
6: *
7: * Copyright (C) 2015 - 2025 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/steelblue-src
22: * git clone https://github.com/tidalwave-it/steelblue-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.ui.javafx.impl.util;
27:
28: import java.lang.reflect.InvocationHandler;
29: import java.lang.reflect.Method;
30: import java.lang.reflect.Proxy;
31: import jakarta.annotation.Nonnull;
32: import javafx.application.Platform;
33: import org.slf4j.LoggerFactory;
34: import lombok.Getter;
35: import lombok.RequiredArgsConstructor;
36: import lombok.Setter;
37: import lombok.extern.slf4j.Slf4j;
38: import static it.tidalwave.ui.javafx.impl.util.JavaFXSafeRunner.runSafelyAndWait;
39: import static java.util.Arrays.asList;
40: import static it.tidalwave.util.CollectionUtils.concat;
41:
42: /***************************************************************************************************************************************************************
43: *
44: * An {@link InvocationHandler} that safely wraps all method calls with {@link Platform#runLater(Runnable)}. The caller
45: * is not blocked if the method is declared as {@code void}; it is blocked otherwise, so it can immediately retrieve
46: * the result.
47: *
48: * This behaviour is required by {@link it.tidalwave.ui.javafx.NodeAndDelegate#of(Class)} ()}.
49: *
50: * TODO: add support for aysnc returning a Future.
51: *
52: * @author Fabrizio Giudici
53: *
54: **************************************************************************************************************************************************************/
55: @RequiredArgsConstructor @Slf4j
56: public class JavaFXSafeProxy implements InvocationHandler
57: {
58: /***********************************************************************************************************************************************************
59: * An auxiliary interface that is always injected to the proxy, allowing to retrive the class of the proxied object.
60: **********************************************************************************************************************************************************/
61: public interface Proxied
62: {
63: /** {@return the class of the proxied object}. */
64: @Nonnull
65: public Object __getProxiedObject();
66: }
67:
68: @Getter @Setter
69: private static boolean logDelegateInvocations;
70:
71: @Nonnull @Getter @Setter
72: private Object delegate;
73:
74: /***********************************************************************************************************************************************************
75: *
76: **********************************************************************************************************************************************************/
77: @Nonnull @SuppressWarnings("unchecked")
78: public static <T> T of (@Nonnull final T target, @Nonnull final Class<?>[] interfaces)
79: {
80: final var augmentedInterfaces = concat(asList(interfaces), Proxied.class).toArray(Class<?>[]::new);
81: final var contextClassLoader = Thread.currentThread().getContextClassLoader();
82: return (T)Proxy.newProxyInstance(contextClassLoader, augmentedInterfaces, new JavaFXSafeProxy(target));
83: }
84:
85: /***********************************************************************************************************************************************************
86: * {@inheritDoc}
87: **********************************************************************************************************************************************************/
88: @Override
89: public Object invoke (@Nonnull final Object proxy, @Nonnull final Method method, @Nonnull final Object[] args)
90: throws Throwable
91: {
92: if ("__getProxiedObject".equals(method.getName()))
93: {
94: return delegate;
95: }
96:
97: final var result = runSafelyAndWait(() ->
98: {
99: if (logDelegateInvocations)
100: {
101: logInvocation(delegate.getClass(), method, args);
102: }
103:
104: return method.invoke(delegate, args);
105: });
106:
107: return method.getReturnType().equals(void.class) ? null : result;
108: }
109:
110: /***********************************************************************************************************************************************************
111: *
112: **********************************************************************************************************************************************************/
113: private static void logInvocation (@Nonnull final Class<?> clazz, @Nonnull final Method method, @Nonnull final Object[] args)
114: {
115: final var logger = LoggerFactory.getLogger(clazz);
116:
117: if (logger.isDebugEnabled())
118: {
119: final var builder = new StringBuilder();
120: builder.append(method.getName());
121: builder.append("(");
122: var separator = "";
123:
124: for (final Object arg : args)
125: {
126: builder.append(separator);
127: builder.append(arg != null ? arg.toString() : null);
128: separator = ", ";
129: }
130:
131: builder.append(")");
132: logger.debug(builder.toString());
133: }
134: }
135: }
136: