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 java.util.concurrent.CountDownLatch;
33: import java.util.concurrent.atomic.AtomicReference;
34: import javafx.application.Platform;
35: import it.tidalwave.ui.javafx.impl.DefaultNodeAndDelegate;
36: import org.slf4j.LoggerFactory;
37: import lombok.Getter;
38: import lombok.RequiredArgsConstructor;
39: import lombok.Setter;
40: import lombok.extern.slf4j.Slf4j;
41: import static java.util.Arrays.asList;
42: import static it.tidalwave.util.CollectionUtils.concat;
43:
44: /***************************************************************************************************************************************************************
45: *
46: * An {@link InvocationHandler} that safely wraps all method calls with {@link Platform#runLater(Runnable)}. The caller
47: * is not blocked if the method is declared as {@code void}; it is blocked otherwise, so it can immediately retrieve
48: * the result.
49: *
50: * This behaviour is required by {@link it.tidalwave.ui.javafx.NodeAndDelegate#of(Class)} ()}.
51: *
52: * TODO: add support for aysnc returning a Future.
53: *
54: * @author Fabrizio Giudici
55: *
56: **************************************************************************************************************************************************************/
57: @RequiredArgsConstructor @Slf4j
58: public class JavaFXSafeProxy implements InvocationHandler
59: {
60: /***********************************************************************************************************************************************************
61: * An auxiliary interface that is always injected to the proxy, allowing to retrive the class of the proxied object.
62: **********************************************************************************************************************************************************/
63: public interface Proxied
64: {
65: /** {@return the class of the proxied object}. */
66: @Nonnull
67: public Class<?> __getProxiedClass();
68: }
69:
70: @Nonnull @Getter @Setter
71: private Object delegate;
72:
73: /***********************************************************************************************************************************************************
74: *
75: **********************************************************************************************************************************************************/
76: @Nonnull @SuppressWarnings("unchecked")
77: public static <T> T of (@Nonnull final T target, @Nonnull final Class<?>[] interfaces)
78: {
79: final var augmentedInterfaces = concat(asList(interfaces), Proxied.class).toArray(Class<?>[]::new);
80: final var contextClassLoader = Thread.currentThread().getContextClassLoader();
81: return (T)Proxy.newProxyInstance(contextClassLoader, augmentedInterfaces, new JavaFXSafeProxy(target));
82: }
83:
84: /***********************************************************************************************************************************************************
85: * {@inheritDoc}
86: **********************************************************************************************************************************************************/
87: @Override
88: public Object invoke (@Nonnull final Object proxy, @Nonnull final Method method, @Nonnull final Object[] args)
89: throws Throwable
90: {
91: if ("__getProxiedClass".equals(method.getName()))
92: {
93: return delegate.getClass();
94: }
95:
96: final var result = new AtomicReference<>();
97: final var throwable = new AtomicReference<Throwable>();
98: final var waitForReturn = new CountDownLatch(1);
99:
100: JavaFXSafeRunner.runSafely(() ->
101: {
102: try
103: {
104: if (DefaultNodeAndDelegate.isLogDelegateInvocations())
105: {
106: logInvocation(delegate.getClass(), method, args);
107: }
108:
109: result.set(method.invoke(delegate, args));
110: }
111: catch (Throwable t)
112: {
113: throwable.set(t);
114: log.error("Exception while calling JavaFX", t);
115: }
116: finally
117: {
118: waitForReturn.countDown();
119: }
120: });
121:
122: log.trace(">>>> waiting for method completion");
123: waitForReturn.await();
124:
125: // This is probably useless - void methods return asynchronously
126: if (throwable.get() != null)
127: {
128: throw throwable.get();
129: }
130:
131: return method.getReturnType().equals(void.class) ? null : result.get();
132: }
133:
134: /***********************************************************************************************************************************************************
135: *
136: **********************************************************************************************************************************************************/
137: private static void logInvocation (@Nonnull final Class<?> clazz, @Nonnull final Method method, @Nonnull final Object[] args)
138: {
139: final var logger = LoggerFactory.getLogger(clazz);
140:
141: if (logger.isDebugEnabled())
142: {
143: final var builder = new StringBuilder();
144: builder.append(method.getName());
145: builder.append("(");
146: var separator = "";
147:
148: for (final Object arg : args)
149: {
150: builder.append(separator);
151: builder.append(arg != null ? arg.toString() : null);
152: separator = ", ";
153: }
154:
155: builder.append(")");
156: logger.debug(builder.toString());
157: }
158: }
159: }
160: