modules/cldc-compact/src/main/java/cc/squirreljme/jvm/pack/TableOfContents.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // Multi-Phasic Applications: SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.jvm.pack;
  11
  12 /**
  13  * This represents a table of contents which is used to provide a mapping
  14  * of repeating keys to values, for each various entry.
  15  *
  16  * @since 2021/02/22
  17  */
  18 public interface TableOfContents
  19 {
  20         /**
  21          * Returns the number of entries in the table.
  22          *
  23          * @return The number of entries in the table.
  24          * @since 2021/02/22
  25          */
  26         int count();
  27
  28         /**
  29          * Gets the given table of contents entry for the given index.
  30          *
  31          * @param __dx The index to get.
  32          * @param __prop The property to get.
  33          * @return The value of the given index.
  34          * @throws IndexOutOfBoundsException If the index and/or property are not
  35          * in range.
  36          * @since 2021/02/22
  37          */
  38         int get(int __dx, int __prop)
  39                 throws IndexOutOfBoundsException;
  40 }