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.tap.hadoop.io;
023
024import java.io.IOException;
025
026import cascading.util.SingleValueCloseableIterator;
027import org.apache.hadoop.mapred.RecordReader;
028
029/**
030 * RecordReaderIterator is a utility class for handing off a single {@link RecordReader} instance
031 * via the {@link java.util.Iterator}.
032 * <p>
033 * This class is frequently used with the {@link cascading.tuple.TupleEntrySchemeIterator} where there is only
034 * one RecordReader to iterate values over.
035 */
036public class RecordReaderIterator extends SingleValueCloseableIterator<RecordReader>
037  {
038  public RecordReaderIterator( RecordReader reader )
039    {
040    super( reader );
041    }
042
043  @Override
044  public void close() throws IOException
045    {
046    getCloseableInput().close();
047    }
048  }