PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-23 04:42:06 +01:00
Code Issues Releases Wiki Activity

Delete unused NonEmptyList class

Browse source
This commit is contained in:
Paul Schaub 2021-07-03 12:24:08 +02:00
parent 863d443052
commit 9ac4b30ec7
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
2 changed files with 0 additions and 150 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

88
pgpainless-core/src/main/java/org/pgpainless/util/NonEmptyList.java
View file

@ -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 <E> element type
*/
public class NonEmptyList<E> {
private final List<E> 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<E> 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<E> getOthers() {
List<E> 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<E> getAll() {
return elements;
}
}

62
pgpainless-core/src/test/java/org/pgpainless/util/NonEmptyListTest.java
View file

@ -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<String> singleElement = Collections.singletonList("Hello");
NonEmptyList<String> 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<String> nonEmpty = new NonEmptyList<>("Foo");
assertEquals("Foo", nonEmpty.get());
assertTrue(nonEmpty.getOthers().isEmpty());
assertEquals(Collections.singletonList("Foo"), nonEmpty.getAll());
}
@Test
public void testMultipleElements() {
List<String> multipleElements = Arrays.asList("Foo", "Bar", "Baz");
NonEmptyList<String> nonEmpty = new NonEmptyList<>(multipleElements);
assertEquals("Foo", nonEmpty.get());
assertEquals(Arrays.asList("Bar", "Baz"), nonEmpty.getOthers());
assertEquals(multipleElements, nonEmpty.getAll());
}
}