org.eclipse.persistence.jpa.jpql.tools.utility.iterable.SingleElementListIterable Maven / Gradle / Ivy
Show all versions of eclipselink Show documentation
/*
* Copyright (c) 2009, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation
//
package org.eclipse.persistence.jpa.jpql.tools.utility.iterable;
import java.util.ListIterator;
import org.eclipse.persistence.jpa.jpql.tools.utility.iterator.SingleElementListIterator;
import org.eclipse.persistence.jpa.jpql.utility.iterable.ListIterable;
/**
* A SingleElementListIterable returns a {@link ListIterator}
* that holds a single element
* and returns it with the first call to {@link ListIterator#next()}, at
* which point it will return false to any subsequent
* call to {@link ListIterator#hasNext()}. Likewise, it will return false
* to a call to {@link ListIterator#hasPrevious()} until a call to {@link ListIterator#next()},
* at which point a call to {@link ListIterator#previous()} will return the
* single element.
*
* A SingleElementListIterable is equivalent to the
* {@link Iterable} returned by:
* {@link java.util.Collections#singletonList(Object)}.
*
* @param the type of elements returned by the list iterable's list iterator
*
* @see SingleElementListIterator
* @see SingleElementListIterable
*/
@SuppressWarnings("nls")
public class SingleElementListIterable implements ListIterable {
private final E element;
/**
* Construct a list iterable that contains only the specified element.
*/
public SingleElementListIterable(E element) {
super();
this.element = element;
}
/**
* {@inheritDoc}
*/
public ListIterator iterator() {
return new SingleElementListIterator(this.element);
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return "[" + this.element + "]";
}
}