01: /*
02: * Copyright (c) 1998-2007 Caucho Technology -- all rights reserved
03: *
04: * This file is part of Resin(R) Open Source
05: *
06: * Each copy or derived work must preserve the copyright notice and this
07: * notice unmodified.
08: *
09: * Resin Open Source is free software; you can redistribute it and/or modify
10: * it under the terms of the GNU General Public License as published by
11: * the Free Software Foundation; either version 2 of the License, or
12: * (at your option) any later version.
13: *
14: * Resin Open Source is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17: * of NON-INFRINGEMENT. See the GNU General Public License for more
18: * details.
19: *
20: * You should have received a copy of the GNU General Public License
21: * along with Resin Open Source; if not, write to the
22: *
23: * Free Software Foundation, Inc.
24: * 59 Temple Place, Suite 330
25: * Boston, MA 02111-1307 USA
26: *
27: * @author Sam
28: */
29:
30: package com.caucho.quercus.lib.spl;
31:
32: import com.caucho.quercus.env.Value;
33: import com.caucho.quercus.annotation.Delegates;
34:
35: @Delegates(IteratorDelegate.class)
36: public interface Iterator extends Traversable {
37: /**
38: * Returns the current value.
39: */
40: public Value current();
41:
42: /**
43: * Returns the current key.
44: */
45: public Value key();
46:
47: /**
48: * Advances to the next row.
49: */
50: public void next();
51:
52: /**
53: * Rewinds the iterator so it is at the first row.
54: */
55: public void rewind();
56:
57: /**
58: * Returns true if the iterator currently points to a valid row.
59: */
60: public boolean valid();
61: }
|