Add display properties to DisplayableEvents.

This will allow listeners to change how events are displayed,
for example setting the default FG colour to red when the
user is highlighted.

Depends-On: I21f9babe74a90b5cfea6daba815c08e7a4b5afa5
Change-Id: I0ac716ee335ed40531af698fe475d077aba2766d
Reviewed-on: http://gerrit.dmdirc.com/3833
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/events/ChannelDisplayableEvent.java

@@ -24,6 +24,8 @@ package com.dmdirc.events;
 
 import com.dmdirc.Channel;
 
+import com.google.common.base.Optional;
+
 import java.util.concurrent.atomic.AtomicReference;
 
 /**
@@ -33,6 +35,8 @@ public abstract class ChannelDisplayableEvent extends ChannelEvent implements Di
 
     /** The display format to use for this event. */
     private final AtomicReference<String> displayFormatRef = new AtomicReference<>("");
+    /** The properties associated with this event. */
+    private final DisplayPropertyMap properties = new DisplayPropertyMap();
 
     public ChannelDisplayableEvent(final long timestamp, final Channel channel) {
         super(timestamp, channel);
@@ -48,8 +52,18 @@ public abstract class ChannelDisplayableEvent extends ChannelEvent implements Di
     }
 
     @Override
-    public void setDisplayFormat(String format) {
-        this.displayFormatRef.set(format);
+    public void setDisplayFormat(final String format) {
+        displayFormatRef.set(format);
+    }
+
+    @Override
+    public <T> void setDisplayProperty(final DisplayProperty<T> property, final T value) {
+        properties.put(property, value);
+    }
+
+    @Override
+    public <T> Optional<T> getDisplayProperty(final DisplayProperty<T> property) {
+        return properties.get(property);
     }
 
 }

src/com/dmdirc/events/DisplayProperty.java

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.events;
+
+import com.dmdirc.ui.Colour;
+
+/**
+ * Describes a property that may be set on a {@link DisplayableEvent} to affect its display.
+ */
+public final class DisplayProperty<T> {
+
+    /** The foreground colour of text relating to the event. */
+    public static DisplayProperty<Colour> FOREGROUND_COLOUR = new DisplayProperty<>();
+    /** The background colour of text relating to the event. */
+    public static DisplayProperty<Colour> BACKGROUND_COLOUR = new DisplayProperty<>();
+
+}

src/com/dmdirc/events/DisplayPropertyMap.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.events;
+
+import com.google.common.base.Optional;
+
+import java.util.Map;
+import java.util.concurrent.ConcurrentSkipListMap;
+
+/**
+ * Provides a map of {@link DisplayProperty}s to values, maintaining type safety.
+ */
+public class DisplayPropertyMap {
+
+    private final Map<DisplayProperty<?>, Object> properties = new ConcurrentSkipListMap<>();
+
+    /**
+     * Gets the value of the specified property, if present.
+     *
+     * @param property The property to be retrieved.
+     * @param <T> The type of value the property takes.
+     * @return An optional containing the value of the property if it was present.
+     */
+    @SuppressWarnings("unchecked")
+    public <T> Optional<T> get(final DisplayProperty<T> property) {
+        return Optional.fromNullable((T) properties.get(property));
+    }
+
+    /**
+     * Adds a new value for the specified property. Any previous value will be replaced.
+     *
+     * @param property The property to set.
+     * @param value The new value of the property.
+     * @param <T> The type of value the property takes.
+     */
+    public <T> void put(final DisplayProperty<T> property, final T value) {
+        properties.put(property, value);
+    }
+
+}

src/com/dmdirc/events/DisplayableEvent.java

@@ -22,6 +22,8 @@
 
 package com.dmdirc.events;
 
+import com.google.common.base.Optional;
+
 /**
  * Describes an event which is rendered in the client to the user.
  */
@@ -41,4 +43,22 @@ public interface DisplayableEvent {
      */
     void setDisplayFormat(String format);
 
+    /**
+     * Sets a property relating to how this event should be displayed.
+     *
+     * @param property The property to be set
+     * @param value The value of the property
+     * @param <T> The type of value that the property takes.
+     */
+    <T> void setDisplayProperty(DisplayProperty<T> property, T value);
+
+    /**
+     * Retrieves a property relating to how this event should be displayed.
+     *
+     * @param property The property to be retrieved.
+     * @param <T> The type of value that the property takes.
+     * @return An optional value for the property.
+     */
+    <T> Optional<T> getDisplayProperty(DisplayProperty<T> property);
+
 }

src/com/dmdirc/events/QueryDisplayableEvent.java

@@ -24,6 +24,8 @@ package com.dmdirc.events;
 
 import com.dmdirc.Query;
 
+import com.google.common.base.Optional;
+
 import java.util.concurrent.atomic.AtomicReference;
 
 /**
@@ -34,6 +36,8 @@ public abstract class QueryDisplayableEvent extends QueryEvent implements
 
     /** The display format to use for this event. */
     private final AtomicReference<String> displayFormatRef = new AtomicReference<>("");
+    /** The properties associated with this event. */
+    private final DisplayPropertyMap properties = new DisplayPropertyMap();
 
     public QueryDisplayableEvent(final long timestamp, final Query query) {
         super(timestamp, query);
@@ -49,8 +53,18 @@ public abstract class QueryDisplayableEvent extends QueryEvent implements
     }
 
     @Override
-    public void setDisplayFormat(String format) {
-        this.displayFormatRef.set(format);
+    public void setDisplayFormat(final String format) {
+        displayFormatRef.set(format);
+    }
+
+    @Override
+    public <T> void setDisplayProperty(final DisplayProperty<T> property, final T value) {
+        properties.put(property, value);
+    }
+
+    @Override
+    public <T> Optional<T> getDisplayProperty(final DisplayProperty<T> property) {
+        return properties.get(property);
     }
 
 }

src/com/dmdirc/events/ServerDisplayableEvent.java

@@ -24,6 +24,8 @@ package com.dmdirc.events;
 
 import com.dmdirc.interfaces.Connection;
 
+import com.google.common.base.Optional;
+
 import java.util.concurrent.atomic.AtomicReference;
 
 
@@ -34,6 +36,8 @@ public abstract class ServerDisplayableEvent extends ServerEvent implements Disp
 
     /** The display format to use for this event. */
     private final AtomicReference<String> displayFormatRef = new AtomicReference<>("");
+    /** The properties associated with this event. */
+    private final DisplayPropertyMap properties = new DisplayPropertyMap();
 
     public ServerDisplayableEvent(final long timestamp, final Connection connection) {
         super(timestamp, connection);
@@ -49,7 +53,18 @@ public abstract class ServerDisplayableEvent extends ServerEvent implements Disp
     }
 
     @Override
-    public void setDisplayFormat(String format) {
-        this.displayFormatRef.set(format);
+    public void setDisplayFormat(final String format) {
+        displayFormatRef.set(format);
+    }
+
+    @Override
+    public <T> void setDisplayProperty(final DisplayProperty<T> property, final T value) {
+        properties.put(property, value);
     }
+
+    @Override
+    public <T> Optional<T> getDisplayProperty(final DisplayProperty<T> property) {
+        return properties.get(property);
+    }
+
 }

src/com/dmdirc/events/UnknownCommandEvent.java

@@ -24,6 +24,8 @@ package com.dmdirc.events;
 
 import com.dmdirc.FrameContainer;
 
+import com.google.common.base.Optional;
+
 import java.util.concurrent.atomic.AtomicReference;
 
 import javax.annotation.Nullable;
@@ -35,6 +37,8 @@ public class UnknownCommandEvent extends DMDircEvent implements DisplayableEvent
 
     /** The display format to use for this event. */
     private final AtomicReference<String> displayFormatRef = new AtomicReference<>("");
+    /** The properties associated with this event. */
+    private final DisplayPropertyMap properties = new DisplayPropertyMap();
     @Nullable private final FrameContainer source;
     private final String command;
     private final String[] arguments;
@@ -73,8 +77,18 @@ public class UnknownCommandEvent extends DMDircEvent implements DisplayableEvent
     }
 
     @Override
-    public void setDisplayFormat(String format) {
-        this.displayFormatRef.set(format);
+    public void setDisplayFormat(final String format) {
+        displayFormatRef.set(format);
+    }
+
+    @Override
+    public <T> void setDisplayProperty(final DisplayProperty<T> property, final T value) {
+        properties.put(property, value);
+    }
+
+    @Override
+    public <T> Optional<T> getDisplayProperty(final DisplayProperty<T> property) {
+        return properties.get(property);
     }
 
 }