[4/8] incubator-tinkerpop git commit: Add javadoc and tests for Contains.

[sp...@apache.org]

Add javadoc and tests for Contains.


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/bccac41d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/bccac41d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/bccac41d

Branch: refs/heads/master
Commit: bccac41d800167e7e1d8730cd33166231fe37f28
Parents: ba1cdf3
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Aug 14 15:07:36 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Aug 14 15:07:36 2015 -0400

----------------------------------------------------------------------
 .../gremlin/process/traversal/Contains.java     | 12 +++-
 .../gremlin/process/traversal/ContainsTest.java | 68 ++++++++++++++++++++
 2 files changed, 78 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bccac41d/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Contains.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Contains.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Contains.java
index 5e4e804..2da0436 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Contains.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/process/traversal/Contains.java
@@ -22,7 +22,7 @@ import java.util.Collection;
 import java.util.function.BiPredicate;
 
 /**
- * {@link Contains} is a {@link java.util.function.BiPredicate} that evaluates whether the first object is contained within (or not
+ * {@link Contains} is a {@link BiPredicate} that evaluates whether the first object is contained within (or not
  * within) the second collection object. For example:
  * <p/>
  * <pre>
@@ -36,12 +36,20 @@ import java.util.function.BiPredicate;
  */
 public enum Contains implements BiPredicate<Object, Collection> {
 
+    /**
+     * The first object is within the {@link Collection} provided in the second object.
+     */
     within {
         @Override
         public boolean test(final Object first, final Collection second) {
             return second.contains(first);
         }
-    }, without {
+    },
+
+    /**
+     * The first object is not within the {@link Collection} provided in the second object.
+     */
+    without {
         @Override
         public boolean test(final Object first, final Collection second) {
             return !second.contains(first);

http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/bccac41d/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/ContainsTest.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/ContainsTest.java b/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/ContainsTest.java
new file mode 100644
index 0000000..6d9ea38
--- /dev/null
+++ b/gremlin-core/src/test/java/org/apache/tinkerpop/gremlin/process/traversal/ContainsTest.java
@@ -0,0 +1,68 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.tinkerpop.gremlin.process.traversal;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.Collections;
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * @author Stephen Mallette (http://stephen.genoprime.com)
+ */
+@RunWith(Parameterized.class)
+public class ContainsTest {
+
+    @Parameterized.Parameters(name = "{0}({1},{2}) = {3}")
+    public static Iterable<Object[]> data() {
+        return new ArrayList<>(Arrays.asList(new Object[][]{
+                {Contains.within, 10, Arrays.asList(1, 2, 3, 4, 10), true},
+                {Contains.without, 10, Arrays.asList(1, 2, 3, 4, 10), false},
+                {Contains.within, 10, Collections.emptyList(), false},
+                {Contains.without, 10, Collections.emptyList(), true},
+                {Contains.within, 100, Arrays.asList(1, 2, 3, 4, 10), false},
+                {Contains.without, 10l, Arrays.asList(1, 2, 3, 4, 10), true},    // no forgiveness
+                {Contains.within, "test", Arrays.asList(1, 2, 3, "test", 10), true},
+                {Contains.without, "testing", Arrays.asList(1, 2, 3, "test", 10), true}
+        }));
+    }
+
+    @Parameterized.Parameter(value = 0)
+    public Contains contains;
+
+    @Parameterized.Parameter(value = 1)
+    public Object first;
+
+    @Parameterized.Parameter(value = 2)
+    public Collection collection;
+
+    @Parameterized.Parameter(value = 3)
+    public boolean expected;
+
+    @Test
+    public void shouldTest() {
+        assertEquals(expected, contains.test(first, collection));
+    }
+}