summaryrefslogtreecommitdiff
path: root/src/de/lmu/ifi/dbs/elki/utilities/iterator/OneItemIterator.java
blob: f6b00242b36ba47f15fb8e38bc3ac8edbbd10e45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
package de.lmu.ifi.dbs.elki.utilities.iterator;

/*
 This file is part of ELKI:
 Environment for Developing KDD-Applications Supported by Index-Structures

 Copyright (C) 2012
 Ludwig-Maximilians-Universität München
 Lehr- und Forschungseinheit für Datenbanksysteme
 ELKI Development Team

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import java.util.Iterator;

/**
 * Dummy iterator/iterable that returns a single object, once.
 * 
 * Note: a "null" object is not supported.
 * 
 * @author Erich Schubert
 *
 * @param <T> Object type to return
 */
public class OneItemIterator<T> implements Iterator<T> {
  /**
   * Object to return.
   */
  private T object = null;
  
  /**
   * Constructor.
   * 
   * @param object Object to return once.
   */
  public OneItemIterator(T object) {
    super();
    this.object = object;
  }

  @Override
  public boolean hasNext() {
    return (object != null);
  }

  @Override
  public T next() {
    T ret = object;
    object = null;
    return ret;
  }

  @Override
  public void remove() {
    throw new UnsupportedOperationException();
  }
}