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