GpIdSupport.java

/*
 * $Id$
 *
 * Copyright (c) 2008 by Brent Easton
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License (LGPL) as published by the Free Software Foundation.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, copies are available
 * at http://www.opensource.org.
 */

package VASSAL.build;

/**
 * GameModule and ModuleExtension are the top-level components and must
 * provide some Namespace services for generated GamePiece Identifiers.
 *
 * Each Extension must have a unique Namespace String. Each PieceSlot is
 * allocated a unique number in a series maintained for each top level
 * component.
 *
 * Each GampePiece generated is tied to it's originating PieceSlot by the
 * NameSpace Id and the PieceSlot Id.
 */
public interface GpIdSupport {

  /**
   * Generate a new PieceSlot Id, unique to this top-level component.
   *
   * @return PieceSlot Id
   */
  public String generateGpId();

  /**
   * Accessors to check and update the next GpId if necessary.
   */
  public int getNextGpId();
  public void setNextGpId(int id);

}