javascalautils.SingleItemContainer Maven / Gradle / Ivy
/**
* Copyright 2015 Peter Nerg
*
* 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 javascalautils;
import java.util.Iterator;
import java.util.stream.Stream;
/**
* Represents an {@link Iterable} containing exactly one item.
* Used by containers representing single item collections.
*
* @author Peter Nerg
* @since 1.4
*/
abstract class SingleItemContainer implements Iterable {
/**
* Returns an iterator containing the single value of this instance.
*
* @return An iterator containing the single value
* @since 1.0
*/
@Override
public final Iterator iterator() {
return stream().iterator();
}
/**
* Returns a stream of size one containing the value of this instance.
*
* @return A stream containing the single value
* @since 1.0
*/
public final Stream stream() {
return Stream.of(get());
}
/**
* Get the value this instance represents.
*
* @return The single value of this instance
*/
abstract T get();
}