001/*
002 * Copyright (c) 2007-2017 Xplenty, Inc. All Rights Reserved.
003 *
004 * Project and contact information: http://www.cascading.org/
005 *
006 * This file is part of the Cascading project.
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *     http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020
021package cascading.util;
022
023import java.io.IOException;
024
025/**
026 * SingleValueIterator is a utility class used for quickly presenting a single value to a consumer
027 * expecting both a {@link java.io.Closeable} and an {@link java.util.Iterator} interface. After returning the Value
028 * value via {@link #next}, {@link #hasNext()} will return {@code false}.
029 * <p/>
030 * This class is especially useful if you do not wish to create a {@link java.util.Collection} to hold a single value
031 * in which to create an Iterator.
032 *
033 * @param <Value>
034 */
035public abstract class SingleValueCloseableIterator<Value> extends SingleValueIterator<Value> implements CloseableIterator<Value>
036  {
037
038  public SingleValueCloseableIterator( Value value )
039    {
040    super( value );
041    }
042
043  protected Value getCloseableInput()
044    {
045    return value;
046    }
047
048  @Override
049  public abstract void close() throws IOException;
050  }