From 9257f3fad957fe1990cfd8b68ed442d09a4be690 Mon Sep 17 00:00:00 2001 From: CyB3RC0nN0R Date: Thu, 9 Jul 2020 09:37:31 +0200 Subject: [PATCH] Simplify cache storage with a CacheMap class --- src/main/java/envoy/client/data/CacheMap.java | 46 +++++++++++++++++++ src/main/java/envoy/client/net/Client.java | 28 +++++------ src/main/java/envoy/client/net/Receiver.java | 12 +++-- src/main/java/envoy/client/ui/Startup.java | 3 +- .../client/ui/controller/LoginScene.java | 13 +++--- 5 files changed, 74 insertions(+), 28 deletions(-) create mode 100644 src/main/java/envoy/client/data/CacheMap.java diff --git a/src/main/java/envoy/client/data/CacheMap.java b/src/main/java/envoy/client/data/CacheMap.java new file mode 100644 index 0000000..462b966 --- /dev/null +++ b/src/main/java/envoy/client/data/CacheMap.java @@ -0,0 +1,46 @@ +package envoy.client.data; + +import java.util.HashMap; +import java.util.Map; + +/** + * Stores a heterogeneous map of {@link Cache} objects with different type + * parameters. + *

+ * Project: envoy-client
+ * File: CacheMap.java
+ * Created: 09.07.2020
+ * + * @author Kai S. K. Engelbart + * @since Envoy Client v0.1-beta + */ +public final class CacheMap { + + private final Map, Cache> map = new HashMap<>(); + + /** + * Adds a cache to the map. + * + * @param the type accepted by the cache + * @param key the class that maps to the cache + * @param cache the cache to store + * @since Envoy Client v0.1-beta + */ + public void put(Class key, Cache cache) { map.put(key, cache); } + + /** + * Returns a cache mapped by a class. + * + * @param the type accepted by the cache + * @param key the class that maps to the cache + * @return the cache + * @since Envoy Client v0.1-beta + */ + public Cache get(Class key) { return (Cache) map.get(key); } + + /** + * @return the map in which the caches are stored + * @since Envoy Client v0.1-beta + */ + public Map, Cache> getMap() { return map; } +} diff --git a/src/main/java/envoy/client/net/Client.java b/src/main/java/envoy/client/net/Client.java index 50cf9dc..f9ca937 100644 --- a/src/main/java/envoy/client/net/Client.java +++ b/src/main/java/envoy/client/net/Client.java @@ -3,13 +3,11 @@ package envoy.client.net; import java.io.Closeable; import java.io.IOException; import java.net.Socket; -import java.util.Map; import java.util.concurrent.TimeoutException; -import java.util.function.Consumer; import java.util.logging.Level; import java.util.logging.Logger; -import envoy.client.data.Cache; +import envoy.client.data.CacheMap; import envoy.client.data.ClientConfig; import envoy.client.data.LocalDB; import envoy.client.event.SendEvent; @@ -40,8 +38,6 @@ public class Client implements Closeable { private Receiver receiver; private boolean online; - private Map, Cache> cacheMap; - // Asynchronously initialized during handshake private volatile User sender; private volatile boolean rejected; @@ -64,7 +60,8 @@ public class Client implements Closeable { * @throws InterruptedException if the current thread is interrupted while * waiting for the handshake response */ - public void performHandshake(LoginCredentials credentials, Map, Cache> cacheMap) + public void performHandshake(LoginCredentials credentials, + CacheMap cacheMap) throws TimeoutException, IOException, InterruptedException { if (online) throw new IllegalStateException("Handshake has already been performed successfully"); @@ -78,7 +75,7 @@ public class Client implements Closeable { // Register user creation processor, contact list processor and message cache receiver.registerProcessor(User.class, sender -> this.sender = sender); - cacheMap.forEach((inputclass, cache) -> receiver.registerProcessor(inputclass, cache)); + receiver.registerProcessors(cacheMap.getMap()); receiver.registerProcessor(HandshakeRejection.class, evt -> { rejected = true; eventBus.dispatch(evt); }); rejected = false; @@ -124,7 +121,7 @@ public class Client implements Closeable { * requested from the server * @since Envoy Client v0.2-alpha */ - public void initReceiver(LocalDB localDB, Map, Cache> cacheMap) throws IOException { + public void initReceiver(LocalDB localDB, CacheMap cacheMap) throws IOException { checkOnline(); // Process incoming messages @@ -134,18 +131,17 @@ public class Client implements Closeable { final GroupMessageStatusChangeProcessor groupMessageStatusChangeProcessor = new GroupMessageStatusChangeProcessor(); receiver.registerProcessor(GroupMessage.class, receivedGroupMessageProcessor); - receiver.registerProcessor(Message.class, receivedMessageProcessor); - receiver.registerProcessor(MessageStatusChange.class, messageStatusChangeProcessor); - receiver.registerProcessor(GroupMessageStatusChange.class, groupMessageStatusChangeProcessor); + // Relay cached unread messages and unread groupMessages - cacheMap.get(Message.class).setProcessor((Consumer) receivedMessageProcessor); - cacheMap.get(GroupMessage.class).setProcessor((Consumer) receivedGroupMessageProcessor); - // Process message status changes - cacheMap.get(MessageStatusChange.class).setProcessor((Consumer) messageStatusChangeProcessor); - cacheMap.get(GroupMessageStatusChange.class).setProcessor((Consumer) groupMessageStatusChangeProcessor); + cacheMap.get(Message.class).setProcessor(receivedMessageProcessor); + cacheMap.get(GroupMessage.class).setProcessor(receivedGroupMessageProcessor); + + // Relay cached status changes + cacheMap.get(MessageStatusChange.class).setProcessor(messageStatusChangeProcessor); + cacheMap.get(GroupMessageStatusChange.class).setProcessor(groupMessageStatusChangeProcessor); // Process user status changes receiver.registerProcessor(UserStatusChange.class, eventBus::dispatch); diff --git a/src/main/java/envoy/client/net/Receiver.java b/src/main/java/envoy/client/net/Receiver.java index f90d10b..e325c4f 100644 --- a/src/main/java/envoy/client/net/Receiver.java +++ b/src/main/java/envoy/client/net/Receiver.java @@ -79,9 +79,7 @@ public class Receiver extends Thread { @SuppressWarnings("rawtypes") final Consumer processor = processors.get(obj.getClass()); if (processor == null) - logger.log(Level.WARNING, String.format( - "The received object has the %s for which no processor is defined.", - obj.getClass())); + logger.log(Level.WARNING, String.format("The received object has the %s for which no processor is defined.", obj.getClass())); else processor.accept(obj); } } catch (final SocketException e) { @@ -103,6 +101,14 @@ public class Receiver extends Thread { */ public void registerProcessor(Class processorClass, Consumer processor) { processors.put(processorClass, processor); } + /** + * Adds a map of object processors to this {@link Receiver}. + * + * @param processors the processors to add the processors to add + * @since Envoy Client v0.1-beta + */ + public void registerProcessors(Map, ? extends Consumer> processors) { this.processors.putAll(processors); } + /** * Removes all object processors registered at this {@link Receiver}. * diff --git a/src/main/java/envoy/client/ui/Startup.java b/src/main/java/envoy/client/ui/Startup.java index 605501c..99f163e 100644 --- a/src/main/java/envoy/client/ui/Startup.java +++ b/src/main/java/envoy/client/ui/Startup.java @@ -2,7 +2,6 @@ package envoy.client.ui; import java.io.File; import java.io.IOException; -import java.util.HashMap; import java.util.Properties; import java.util.logging.Level; import java.util.logging.Logger; @@ -100,7 +99,7 @@ public final class Startup extends Application { // Initialize client and unread message cache client = new Client(); - final var cacheMap = new HashMap, Cache>(); + final var cacheMap = new CacheMap(); cacheMap.put(Message.class, new Cache()); cacheMap.put(GroupMessage.class, new Cache()); cacheMap.put(MessageStatusChange.class, new Cache()); diff --git a/src/main/java/envoy/client/ui/controller/LoginScene.java b/src/main/java/envoy/client/ui/controller/LoginScene.java index 98f9940..7d7ba99 100644 --- a/src/main/java/envoy/client/ui/controller/LoginScene.java +++ b/src/main/java/envoy/client/ui/controller/LoginScene.java @@ -2,7 +2,6 @@ package envoy.client.ui.controller; import java.io.FileNotFoundException; import java.io.IOException; -import java.util.Map; import java.util.concurrent.TimeoutException; import java.util.logging.Level; import java.util.logging.Logger; @@ -55,10 +54,10 @@ public final class LoginScene { @FXML private Label connectionLabel; - private Client client; - private LocalDB localDB; - private Map, Cache> cacheMap; - private SceneContext sceneContext; + private Client client; + private LocalDB localDB; + private CacheMap cacheMap; + private SceneContext sceneContext; private static final Logger logger = EnvoyLog.getLogger(LoginScene.class); private static final EventBus eventBus = EventBus.getInstance(); @@ -81,7 +80,7 @@ public final class LoginScene { * @param sceneContext the scene context used to initialize the chat scene * @since Envoy Client v0.1-beta */ - public void initializeData(Client client, LocalDB localDB, Map, Cache> cacheMap, SceneContext sceneContext) { + public void initializeData(Client client, LocalDB localDB, CacheMap cacheMap, SceneContext sceneContext) { this.client = client; this.localDB = localDB; this.cacheMap = cacheMap; @@ -198,6 +197,6 @@ public final class LoginScene { sceneContext.getController().initializeData(sceneContext, localDB, client, writeProxy); // Relay unread messages from cache - if (client.isOnline()) cacheMap.values().forEach(cache -> { if (cache != null) cache.relay(); }); + if (client.isOnline()) cacheMap.getMap().values().forEach(cache -> { if (cache != null) cache.relay(); }); } }