Behold, Nenya, Ring of Water and repository for our media and animation related

goodies, both Java 2D and LWJGL/JME 3D. git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@1 ed5b42cb-e716-0410-a449-f6a68f950b19
2006-06-23 18:07:28 +00:00
commit c2117ee86d
570 changed files with 61913 additions and 0 deletions
@@ -0,0 +1,86 @@
+//
+// $Id: TileSetRepository.java 4191 2006-06-13 22:42:20Z ray $
+//
+// Narya library - tools for developing networked games
+// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
+// http://www.threerings.net/code/narya/
+//
+// This library 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 2.1 of the License, or
+// (at your option) any later version.
+//
+// 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
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+package com.threerings.media.tile;
+
+import java.util.Iterator;
+
+import com.samskivert.io.PersistenceException;
+
+/**
+ * The tileset repository interface should be implemented by classes that
+ * provide access to tilesets keyed on a unique tileset identifier. The
+ * tileset id space is up to the repository implementation, which may or
+ * may not desire to use a {@link TileSetIDBroker} to manage the space.
+ */
+public interface TileSetRepository
+{
+    /**
+     * Returns an iterator over the identifiers of all {@link TileSet}
+     * objects available.
+     */
+    public Iterator enumerateTileSetIds ()
+        throws PersistenceException;
+
+    /**
+     * Returns an iterator over all {@link TileSet} objects available.
+     */
+    public Iterator enumerateTileSets ()
+        throws PersistenceException;
+
+    /**
+     * Returns the {@link TileSet} with the specified tile set
+     * identifier. The repository is responsible for configuring the tile
+     * set with an image provider.
+     *
+     * @exception NoSuchTileSetException thrown if no tileset exists with
+     * the specified identifier.
+     * @exception PersistenceException thrown if an error occurs
+     * communicating with the underlying persistence mechanism.
+     */
+    public TileSet getTileSet (int tileSetId)
+        throws NoSuchTileSetException, PersistenceException;
+
+    /**
+     * Returns the unique identifier of the {@link TileSet} with the
+     * specified tile set name.
+     *
+     * @exception NoSuchTileSetException thrown if no tileset exists with
+     * the specified name.
+     * @exception PersistenceException thrown if an error occurs
+     * communicating with the underlying persistence mechanism.
+     */
+    public int getTileSetId (String setName)
+        throws NoSuchTileSetException, PersistenceException;
+
+    /**
+     * Returns the {@link TileSet} with the specified tile set name. The
+     * repository is responsible for configuring the tile set with an
+     * image provider.
+     *
+     * @exception NoSuchTileSetException thrown if no tileset exists with
+     * the specified name.
+     * @exception PersistenceException thrown if an error occurs
+     * communicating with the underlying persistence mechanism.
+     */
+    public TileSet getTileSet (String setName)
+        throws NoSuchTileSetException, PersistenceException;
+}