1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.apache.giraph.utils;
20
21 import java.util.Iterator;
22 import org.apache.hadoop.io.Writable;
23
24 /**
25 * The objects provided by the iterators generated from this object have
26 * lifetimes only until next() is called. In that sense, the object
27 * provided is only a representative object.
28 *
29 * @param <T> Type that extends Writable that will be iterated
30 */
31 public abstract class RepresentativeByteStructIterable<T extends Writable>
32 extends ByteStructIterable<T> {
33 /**
34 * Constructor
35 *
36 * @param dataInputFactory Factory for data inputs
37 */
38 public RepresentativeByteStructIterable(
39 Factory<? extends ExtendedDataInput> dataInputFactory) {
40 super(dataInputFactory);
41 }
42
43 @Override
44 public Iterator<T> iterator() {
45 return new RepresentativeByteStructIterator<T>(dataInputFactory.create()) {
46 @Override
47 protected T createWritable() {
48 return RepresentativeByteStructIterable.this.createWritable();
49 }
50 };
51 }
52 }