• Home
• com.googlecode.sarasvati
• sarasvati-core
• 2.0.2
• source code
• JoinStrategy.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.googlecode.sarasvati.JoinStrategy Maven / Gradle / Ivy

/*
    This file is part of Sarasvati.

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

    Sarasvati 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with Sarasvati.  If not, see .

    Copyright 2009 Paul Lorenz
*/
package com.googlecode.sarasvati;


/**
 * Encapsulates a strategy for determining if a node is ready to execute. A JoinStrategy
 * will be executed whenever an {@link ArcToken} is processed. The join strategy will
 * determine if a NodeToken will be created or if the ArcToken will be added to the list
 * of active arc tokens.
 *
 * @author Paul Lorenz
 */
public interface JoinStrategy
{
  /**
   * Called on every {@link ArcToken} when processed.
   *
   * @param engine The engine executing the given process.
   * @param token  The arc token being processed.
   *
   * @return A {@link JoinResult} which contains a boolean indicating whether or not
   *         the join is complete and the set of arc tokens participating in the join.
   */
  JoinResult performJoin (Engine engine, ArcToken token);
}