Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: d561fa1b5aa425da581848095d835a7d11adc910 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*******************************************************************************
 * Copyright (c) 2009, 2012 Oracle. All rights reserved.
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0, which accompanies this distribution
 * and is available at https://www.eclipse.org/legal/epl-2.0/.
 * 
 * Contributors:
 *     Oracle - initial API and implementation
 ******************************************************************************/
package org.eclipse.jpt.common.utility.internal.iterable;

import java.util.Iterator;
import org.eclipse.jpt.common.utility.internal.iterator.SingleElementIterator;

/**
 * A <code>SingleElementIterable</code> returns an {@link Iterator}
 * that holds a single element
 * and returns it with the first call to {@link Iterator#next()}, at
 * which point it will return <code>false</code> to any subsequent
 * call to {@link Iterator#hasNext()}.
 * <p>
 * A <code>SingleElementIterable</code> is equivalent to the
 * {@link Iterable} returned by:
 * 	{@link java.util.Collections#singleton(Object)}.
 * 
 * @param <E> the type of elements returned by the iterable's iterator
 * 
 * @see SingleElementIterator
 * @see SingleElementListIterable
 */
public class SingleElementIterable<E>
	implements Iterable<E>
{
	private final E element;

	/**
	 * Construct an iterable that contains only the specified element.
	 */
	public SingleElementIterable(E element) {
		super();
		this.element = element;
	}

	public Iterator<E> iterator() {
		return new SingleElementIterator<E>(this.element);
	}

	@Override
	public String toString() {
		return "[" + this.element + "]"; //$NON-NLS-1$ //$NON-NLS-2$
	}
}

Back to the top