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