kilim.Generator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kilim Show documentation

Coroutines, continuations, fibers, actors and message passing for the JVM

There is a newer version: 2.0.2-jdk7

/* Copyright (c) 2006, Sriram Srinivasan
 *
 * You may distribute this software under the terms of the license 
 * specified in the file "License"
 */

package kilim;

import java.util.Iterator;
import java.util.NoSuchElementException;

/**
 * A Generator, from the caller's perspective, looks like a normal iterator 
 * that produces values.  Because a standard iterator's next() method 
 * must return every time, the programmer is forced to manage the stack 
 * explicitly. The Generator class instead allows one to write a
 * task with an automatically managed stack and couple it to an 
 * iterator interface. 
 *  
 * For example:
 * 
 *  * class StringGenerator extends Generator{
 *   public void execute() throws Pausable {
 *       while (!done) {
 *           String s = getNextWord(); // this can pause
 *           yield(s);  
 *       }
 *   }
 *   private String getNextWord() throws Pausable {
 *   }
 * }
 * 
 * 
 * 
 *  @see kilim.examples.Fib, kilim.examples.Tree
 */

public class Generator extends Continuation implements Iterator, Iterable {
    T nextVal;
    boolean done = false;

    public boolean hasNext() {
        if (nextVal == null) {
            if (done)
                return false;
            done = run();
            return nextVal != null;
        } else {
            return true;
        }
    }

    public T next() {
        T ret;
        if (nextVal != null) {
            ret = nextVal;
            nextVal = null;
            return ret;
        }
        if (done) {
            throw new NoSuchElementException();
        }
        done = run();
        ret = nextVal;
        nextVal = null;
        return ret;
    }

    public void remove() {
        throw new AssertionError("Not Supported");
    }

    public Iterator iterator() {
        return this;
    }

    public void yield(T val) throws Pausable {
        nextVal = val;
        Fiber.yield();
    }
}