Merge branch 'release/3.1'

CHANGELOG.md

@@ -1,6 +1,13 @@
 ## Change log
 ----------------------
 
+Version 3.1
+-------------
+
+ADDED:
+
+- new enum CompareOrder created that encapsulates the possible return values of the compare method
+
 Version 3
 -------------
 

README.md

@@ -55,7 +55,7 @@ Than you can add the dependency to your dependencies:
 	<properties>
 			...
 		<!-- JOBJ-COMPARE version -->
-		<jobj-compare.version>3</jobj-compare.version>
+		<jobj-compare.version>3.1</jobj-compare.version>
 			...
 	</properties>
 			...

pom.xml

@@ -12,7 +12,7 @@
 
 	<artifactId>jobj-compare</artifactId>
 
-	<version>3</version>
+	<version>3.1</version>
 
 	<properties>
 		<!-- TEST-OBJECTS version -->

src/main/java/de/alpharogroup/comparators/CompareOrder.java

@@ -0,0 +1,47 @@
+/**
+ * The MIT License
+ *
+ * Copyright (C) 2015 Asterios Raptis
+ *
+ * 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 de.alpharogroup.comparators;
+
+import java.util.Comparator;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.FieldDefaults;
+
+/**
+ * The enum {@link CompareOrder} that encapsulates the possible return values of the method
+ * {@link Comparator#compare(Object, Object)}
+ */
+@RequiredArgsConstructor
+@FieldDefaults(makeFinal = true)
+public enum CompareOrder
+{
+	/** The order to sort an object after. */
+	AFTER(1),
+	/** The order to sort an object before. */
+	BEFORE(-1),
+	/** The order to sort an object as equal. */
+	EQUAL(0);
+
+	/** The order. */
+	@Getter
+	int order;
+}

src/main/java/de/alpharogroup/lombok.config

@@ -0,0 +1,3 @@
+config.stopBubbling = true
+lombok.fieldDefaults.defaultPrivate = true
+lombok.accessors.chain=true

src/test/java/de/alpharogroup/comparators/CompareOrderTest.java

@@ -0,0 +1,71 @@
+/**
+ * The MIT License
+ *
+ * Copyright (C) 2015 Asterios Raptis
+ *
+ * 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 de.alpharogroup.comparators;
+
+import static org.testng.Assert.assertEquals;
+
+import java.lang.reflect.InvocationTargetException;
+
+import org.meanbean.test.BeanTestException;
+import org.meanbean.test.BeanTester;
+import org.testng.annotations.Test;
+
+/**
+ * The unit test class for the enum class {@link CompareOrder}.
+ */
+public class CompareOrderTest
+{
+
+	/**
+	 * Test method for {@link CompareOrder#getOrder()}
+	 */
+	@Test
+	public void testGetOrder()
+	{
+		int expected;
+		int actual;
+		actual = CompareOrder.AFTER.getOrder();
+		expected = 1;
+		assertEquals(actual, expected);
+		actual = CompareOrder.BEFORE.getOrder();
+		expected = -1;
+		assertEquals(actual, expected);
+		actual = CompareOrder.EQUAL.getOrder();
+		expected = 0;
+		assertEquals(actual, expected);
+	}
+
+	/**
+	 * Test method for {@link CompareOrder}
+	 */
+	@Test(expectedExceptions = { BeanTestException.class, InvocationTargetException.class,
+			UnsupportedOperationException.class })
+	public void testWithBeanTester()
+	{
+		final BeanTester beanTester = new BeanTester();
+		beanTester.testBean(CompareOrder.class);
+	}
+
+}