From f2b3fa453372b5f2b56263f05fdcee9b014eefaa Mon Sep 17 00:00:00 2001
From: Jean-Noel Rouvignac <jean-noel.rouvignac@forgerock.com>
Date: Tue, 22 Jul 2014 15:05:32 +0000
Subject: [PATCH] Code Review: Matthew Swift
---
opendj-core/src/test/java/com/forgerock/opendj/util/PairTestCase.java | 105 +++++++++++++++++++++++++++++++++++
opendj-core/src/main/java/com/forgerock/opendj/util/Pair.java | 39 ++++++++++++
2 files changed, 143 insertions(+), 1 deletions(-)
diff --git a/opendj-core/src/main/java/com/forgerock/opendj/util/Pair.java b/opendj-core/src/main/java/com/forgerock/opendj/util/Pair.java
index 7953a69..a28b316 100644
--- a/opendj-core/src/main/java/com/forgerock/opendj/util/Pair.java
+++ b/opendj-core/src/main/java/com/forgerock/opendj/util/Pair.java
@@ -21,10 +21,12 @@
* CDDL HEADER END
*
*
- * Copyright 2013 ForgeRock AS
+ * Copyright 2013-2014 ForgeRock AS
*/
package com.forgerock.opendj.util;
+import java.util.Comparator;
+
/**
* Ordered pair of arbitrary objects.
*
@@ -35,9 +37,29 @@
*/
public final class Pair<F, S> {
+ private static final class ComparablePairComparator
+ <F extends Comparable<F>, S extends Comparable<S>>
+ implements Comparator<Pair<F, S>> {
+ /** {@inheritDoc} */
+ @Override
+ public int compare(Pair<F, S> o1, Pair<F, S> o2) {
+ final int compareResult = o1.getFirst().compareTo(o2.getFirst());
+ if (compareResult == 0) {
+ return o1.getSecond().compareTo(o2.getSecond());
+ }
+ return compareResult;
+ }
+ }
+
/** An empty Pair. */
public static final Pair<?, ?> EMPTY = Pair.of(null, null);
+ /**
+ * {@link Comparator} for {@link Pair}s made of {@link Comparable} elements.
+ */
+ @SuppressWarnings("rawtypes")
+ public static final Comparator COMPARATOR = new ComparablePairComparator();
+
/** The first pair element. */
private final F first;
@@ -89,6 +111,21 @@
}
/**
+ * Returns a comparator for Pairs of comparable objects.
+ *
+ * @param <F>
+ * type of the first pair element
+ * @param <S>
+ * type of the second pair element
+ * @return a comparator for Pairs of comparable objects.
+ */
+ @SuppressWarnings("unchecked")
+ public static <F extends Comparable<F>, S extends Comparable<S>>
+ Comparator<Pair<F, S>> getPairComparator() {
+ return COMPARATOR;
+ }
+
+ /**
* Returns the first element of this pair.
*
* @return the first element of this pair
diff --git a/opendj-core/src/test/java/com/forgerock/opendj/util/PairTestCase.java b/opendj-core/src/test/java/com/forgerock/opendj/util/PairTestCase.java
new file mode 100644
index 0000000..0e5a5b1
--- /dev/null
+++ b/opendj-core/src/test/java/com/forgerock/opendj/util/PairTestCase.java
@@ -0,0 +1,105 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License, Version 1.0 only
+ * (the "License"). You may not use this file except in compliance
+ * with the License.
+ *
+ * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
+ * or http://forgerock.org/license/CDDLv1.0.html.
+ * See the License for the specific language governing permissions
+ * and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at legal-notices/CDDLv1_0.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information:
+ * Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ *
+ * Copyright 2014 ForgeRock AS
+ */
+package com.forgerock.opendj.util;
+
+import java.math.BigDecimal;
+import java.util.Comparator;
+
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import static com.forgerock.opendj.util.Pair.*;
+
+import static org.fest.assertions.Assertions.*;
+
+/**
+ * Tests the {@link Pair} class.
+ */
+@SuppressWarnings("javadoc")
+public class PairTestCase extends UtilTestCase {
+
+ @Test
+ public void getters() throws Exception {
+ final Pair<BigDecimal, BigDecimal> pair = of(BigDecimal.ONE, BigDecimal.TEN);
+ assertThat(pair.getFirst()).isSameAs(BigDecimal.ONE);
+ assertThat(pair.getSecond()).isSameAs(BigDecimal.TEN);
+ }
+
+ @DataProvider
+ public Object[][] pairsEqualDataProvider() {
+ final Pair<Integer, Integer> p12 = of(1, 2);
+ return new Object[][] {
+ new Object[] { p12, p12 },
+ new Object[] { p12, of(1, 2) },
+ new Object[] { of(null, null), empty() },
+ };
+ }
+
+ @Test(dataProvider = "pairsEqualDataProvider")
+ public void pairsEqual(Pair<Integer, Integer> p1, Pair<Integer, Integer> p2) {
+ assertThat(p1).isEqualTo(p2);
+ assertThat(p1.hashCode()).isEqualTo(p2.hashCode());
+ }
+
+ @DataProvider
+ public Object[][] pairsNotEqualDataProvider() {
+ final Pair<Integer, Integer> p12 = of(1, 2);
+ return new Object[][] {
+ new Object[] { p12, null },
+ new Object[] { p12, empty() },
+ new Object[] { empty(), p12 },
+ new Object[] { of(null, 2), empty() },
+ new Object[] { empty(), of(null, 2) },
+ };
+ }
+
+ @Test(dataProvider = "pairsNotEqualDataProvider")
+ public void pairsNotEqual(Pair<Integer, Integer> p1, Pair<Integer, Integer> p2) throws Exception {
+ assertThat(p1).isNotEqualTo(p2);
+ if (p2 != null) {
+ assertThat(p1.hashCode()).isNotEqualTo(p2.hashCode());
+ }
+ }
+
+ @DataProvider
+ public Object[][] pairComparatorDataProvider() {
+ return new Object[][] {
+ new Object[] { of(2, 3), of(1, 4), 1 },
+ new Object[] { of(1, 4), of(2, 3), -1 },
+ new Object[] { of(1, 3), of(1, 2), 1 },
+ new Object[] { of(1, 2), of(1, 3), -1 },
+ };
+ }
+
+ @Test(dataProvider = "pairComparatorDataProvider")
+ public void pairComparator(
+ Pair<Integer, Integer> p1,
+ Pair<Integer, Integer> p2,
+ int compareResult) {
+ final Comparator<Pair<Integer, Integer>> cmp = getPairComparator();
+ assertThat(cmp.compare(p1, p2)).isEqualTo(compareResult);
+ }
+
+}
--
Gitblit v1.10.0