FaceFactory.java

/*
 * This file is part of the Trickl Open Source Libraries.
 *
 * Trickl Open Source Libraries - http://open.trickl.com/
 *
 * Copyright (C) 2011 Tim Gee.
 *
 * Trickl Open Source Libraries are free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Trickl Open Source Libraries are 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this project.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.trickl.graph.planar;

public interface FaceFactory<V, F> {
   /**
    * Create a face object to be associated with the planar graph face.
    * Note that the parameters passed into the constructor may be invalidated
    * due to later manipulations of the graph. As such, it's normally unwise
    * to store this information with the face. However, the context can be useful
    * for some algorithms (like copying other graphs with existing faces).
    * @return The new face object to be asssociated with the graph face.
    */
   F createFace(V source, V target, boolean isBoundary);
}