diff options
Diffstat (limited to 'common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/iterables/SingleElementIterable.java')
-rw-r--r-- | common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/iterables/SingleElementIterable.java | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/iterables/SingleElementIterable.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/iterables/SingleElementIterable.java new file mode 100644 index 0000000000..34ea3a7e24 --- /dev/null +++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/iterables/SingleElementIterable.java @@ -0,0 +1,55 @@ +/******************************************************************************* + * Copyright (c) 2009 Oracle. All rights reserved. + * This program and the accompanying materials are made available under the + * terms of the Eclipse Public License v1.0, which accompanies this distribution + * and is available at http://www.eclipse.org/legal/epl-v10.html. + * + * Contributors: + * Oracle - initial API and implementation + ******************************************************************************/ +package org.eclipse.jpt.common.utility.internal.iterables; + +import java.util.Iterator; + +import org.eclipse.jpt.common.utility.internal.StringTools; +import org.eclipse.jpt.common.utility.internal.iterators.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 StringTools.buildToStringFor(this, this.element); + } + +} |