From 9ac4b30ec72166f48a85f6faf25d695344c05314 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Sat, 3 Jul 2021 12:24:08 +0200 Subject: [PATCH] Delete unused NonEmptyList class --- .../org/pgpainless/util/NonEmptyList.java | 88 ------------------- .../org/pgpainless/util/NonEmptyListTest.java | 62 ------------- 2 files changed, 150 deletions(-) delete mode 100644 pgpainless-core/src/main/java/org/pgpainless/util/NonEmptyList.java delete mode 100644 pgpainless-core/src/test/java/org/pgpainless/util/NonEmptyListTest.java diff --git a/pgpainless-core/src/main/java/org/pgpainless/util/NonEmptyList.java b/pgpainless-core/src/main/java/org/pgpainless/util/NonEmptyList.java deleted file mode 100644 index cc56baed..00000000 --- a/pgpainless-core/src/main/java/org/pgpainless/util/NonEmptyList.java +++ /dev/null @@ -1,88 +0,0 @@ -/* - * Copyright 2021 Paul Schaub. - * - * Licensed 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.pgpainless.util; - -import java.util.Collections; -import java.util.LinkedList; -import java.util.List; -import javax.annotation.Nonnull; - -/** - * Utility class of an immutable list which cannot be empty. - * The first element can be accessed via {@link #get()} which is guaranteed to return a non-null value. - * The rest of the list can be accessed via {@link #getOthers()}, which is guaranteed to return a non-null list which is possibly empty. - * Lastly, the whole list can be accessed via {@link #getAll()}, which is guaranteed to return a non-empty list. - * - * @param element type - */ -public class NonEmptyList { - - private final List elements; - - /** - * Create a singleton list from the given element. - * - * @param element element - */ - public NonEmptyList(E element) { - if (element == null) { - throw new IllegalArgumentException("Singleton element cannot be null."); - } - this.elements = Collections.singletonList(element); - } - - /** - * Create a non-empty list from the given list of elements. - * - * @param elements elements - * @throws IllegalArgumentException if the provided list of elements is empty. - */ - public NonEmptyList(List elements) { - if (elements.isEmpty()) { - throw new IllegalArgumentException("Underlying list cannot be empty."); - } - this.elements = Collections.unmodifiableList(elements); - } - - /** - * Return the first element of the list. - * - * @return first - */ - public @Nonnull E get() { - return elements.get(0); - } - - /** - * Return a list of all elements of the list except the first. - * - * @return list of all but the first element - */ - public @Nonnull List getOthers() { - List others = new LinkedList<>(elements); - others.remove(0); - return Collections.unmodifiableList(others); - } - - /** - * Return a non-empty list of all elements of this list. - * - * @return all elements - */ - public List getAll() { - return elements; - } -} diff --git a/pgpainless-core/src/test/java/org/pgpainless/util/NonEmptyListTest.java b/pgpainless-core/src/test/java/org/pgpainless/util/NonEmptyListTest.java deleted file mode 100644 index 1280f72e..00000000 --- a/pgpainless-core/src/test/java/org/pgpainless/util/NonEmptyListTest.java +++ /dev/null @@ -1,62 +0,0 @@ -/* - * Copyright 2021 Paul Schaub. - * - * Licensed 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.pgpainless.util; - -import static org.junit.jupiter.api.Assertions.assertEquals; -import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertTrue; - -import java.util.Arrays; -import java.util.Collections; -import java.util.List; - -import org.junit.jupiter.api.Test; - -public class NonEmptyListTest { - - @Test - public void testEmptyListThrows() { - assertThrows(IllegalArgumentException.class, () -> new NonEmptyList<>(Collections.emptyList())); - } - - @Test - public void testSingleElementList() { - List singleElement = Collections.singletonList("Hello"); - NonEmptyList nonEmpty = new NonEmptyList<>(singleElement); - assertEquals("Hello", nonEmpty.get()); - assertTrue(nonEmpty.getOthers().isEmpty()); - assertEquals(1, nonEmpty.getAll().size()); - assertTrue(nonEmpty.getAll().contains("Hello")); - } - - @Test - public void testSingletonElement() { - assertThrows(IllegalArgumentException.class, () -> new NonEmptyList<>((String) null)); - NonEmptyList nonEmpty = new NonEmptyList<>("Foo"); - assertEquals("Foo", nonEmpty.get()); - assertTrue(nonEmpty.getOthers().isEmpty()); - assertEquals(Collections.singletonList("Foo"), nonEmpty.getAll()); - } - - @Test - public void testMultipleElements() { - List multipleElements = Arrays.asList("Foo", "Bar", "Baz"); - NonEmptyList nonEmpty = new NonEmptyList<>(multipleElements); - assertEquals("Foo", nonEmpty.get()); - assertEquals(Arrays.asList("Bar", "Baz"), nonEmpty.getOthers()); - assertEquals(multipleElements, nonEmpty.getAll()); - } -}