Basic useful filter implementations.

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@7031 75d07b2b-3a1a-0410-a2c5-0572b91ccdca

engine/src/networking/com/jme3/network/Filters.java

@@ -0,0 +1,157 @@
+/*
+ * Copyright (c) 2011 jMonkeyEngine
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
+ *   may be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package com.jme3.network;
+
+import java.util.*;
+
+/**
+ *  Static utility methods pertaining to Filter instances.
+ *
+ *  @version   $Revision$
+ *  @author    Paul Speed
+ */
+public class Filters 
+{
+    /**
+     *  Creates a filter that returns true for any value in the specified
+     *  list of values and false for all other cases.
+     */
+    public <T> Filter<T> in( T... values )
+    {
+        return in( new HashSet<T>(Arrays.asList(values)) );
+    }
+    
+    /**
+     *  Creates a filter that returns true for any value in the specified
+     *  collection and false for all other cases.
+     */
+    public <T> Filter<T> in( Collection<? extends T> collection )
+    {
+        return new InFilter<T>(collection);
+    }
+
+    /**
+     *  Creates a filter that returns true for any value NOT in the specified
+     *  list of values and false for all other cases.  This is the equivalent
+     *  of calling not(in(values)).
+     */
+    public <T> Filter<T> notIn( T... values )
+    {
+        return not( in( values ) );
+    }
+    
+    /**
+     *  Creates a filter that returns true for any value NOT in the specified
+     *  collection and false for all other cases.  This is the equivalent
+     *  of calling not(in(collection)).
+     */
+    public <T> Filter<T> notIn( Collection<? extends T> collection )
+    {
+        return not( in( collection ) );
+    }
+    
+    /**
+     *  Creates a filter that returns true for inputs that are .equals()
+     *  equivalent to the specified value.
+     */
+    public <T> Filter<T> equalTo( T value )
+    {
+        return new EqualToFilter<T>(value); 
+    }     
+
+    /**
+     *  Creates a filter that returns true for inputs that are NOT .equals()
+     *  equivalent to the specified value.  This is the equivalent of calling
+     *  not(equalTo(value)).
+     */
+    public <T> Filter<T> notEqualTo( T value )
+    {
+        return not(equalTo(value));
+    }     
+
+    /**
+     *  Creates a filter that returns true when the specified delegate filter
+     *  returns false, and vice versa.
+     */
+    public <T> Filter<T> not( Filter<T> f )
+    {
+        return new NotFilter<T>(f);
+    }
+ 
+    private static class EqualToFilter<T> implements Filter<T>
+    {
+        private T value;
+        
+        public EqualToFilter( T value )
+        {
+            this.value = value;
+        }
+        
+        public boolean apply( T input )
+        {
+            return value == input || (value != null && value.equals(input));
+        }
+    }
+    
+    private static class InFilter<T> implements Filter<T>
+    {
+        private Collection<? extends T> collection;
+        
+        public InFilter( Collection<? extends T> collection )
+        {
+            this.collection = collection;
+        }
+        
+        public boolean apply( T input )
+        {
+            return collection.contains(input);
+        } 
+    }
+    
+    private static class NotFilter<T> implements Filter<T>
+    {
+        private Filter<T> delegate;
+        
+        public NotFilter( Filter<T> delegate )
+        {
+            this.delegate = delegate;
+        }
+        
+        public boolean apply( T input )
+        {
+            return !delegate.apply(input);
+        }
+    } 
+}
+
+

engine/src/networking/com/jme3/network/Server.java

@@ -53,6 +53,14 @@ public interface Server
      *  the filter.  If no filter is specified then this is the same as
      *  calling broadcast(message) and the message will be delivered to
      *  all connections.
+     *  <p>Examples:</p>
+     *  <pre>
+     *    // Broadcast to connections: conn1, conn2, and conn3
+     *    server.broadcast( Filters.in( conn1, conn2, conn3 ), message );
+     *
+     *    // Broadcast to all connections exception source
+     *    server.broadcast( Filters.notEqualTo( source ), message );
+     *  </pre>
      */ 
     public void broadcast( Filter<? super HostedConnection> filter, Message message );