01: /*
02: * Janino - An embedded Java[TM] compiler
03: *
04: * Copyright (c) 2006, Arno Unkrig
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions
09: * are met:
10: *
11: * 1. Redistributions of source code must retain the above copyright
12: * notice, this list of conditions and the following disclaimer.
13: * 2. Redistributions in binary form must reproduce the above
14: * copyright notice, this list of conditions and the following
15: * disclaimer in the documentation and/or other materials
16: * provided with the distribution.
17: * 3. The name of the author may not be used to endorse or promote
18: * products derived from this software without specific prior
19: * written permission.
20: *
21: * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22: * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23: * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24: * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
25: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
29: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
31: * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32: */
33:
34: package org.codehaus.janino.util;
35:
36: /**
37: * An object that produces some {@link java.lang.Object} each time the
38: * {@link #produce()} method is invoked. This behavior is similar to the
39: * {@link java.util.Iterator}, but is represented by one single
40: * {@link #produce()} method as opposed to {@link java.util.Iterator}'s
41: * two methods {@link java.util.Iterator#hasNext()} and
42: * {@link java.util.Iterator#next()}. This simplifies the implementation of
43: * certain complex iterations.
44: *
45: * @see org.codehaus.janino.util.iterator.DirectoryIterator
46: * @see org.codehaus.janino.util.iterator.ProducerIterator
47: */
48: public interface Producer {
49:
50: /**
51: * Produce the next object.
52: *
53: * @return the next object or <code>null</code> to indicate that no more objects can be produced
54: */
55: Object produce();
56: }
|