modules/debug-jdwp/src/main/java/cc/squirreljme/jdwp/views/JDWPViewObject.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // 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.jdwp.views;
  11
  12 import cc.squirreljme.jdwp.JDWPValue;
  13 import cc.squirreljme.runtime.cldc.annotation.Exported;
  14
  15 /**
  16  * An object viewer.
  17  *
  18  * @since 2021/04/10
  19  */
  20 public interface JDWPViewObject
  21         extends JDWPViewValidObject
  22 {
  23         /**
  24          * Returns the array length.
  25          *
  26          * @param __which The object to get the length of.
  27          * @return The array length, negative for objects that are not arrays.
  28          * @since 2021/04/11
  29          */
  30         int arrayLength(Object __which);
  31
  32         /**
  33          * Is this a null object?
  34          *
  35          * @param __value The object to check.
  36          * @return If it is {@code null} or not.
  37          * @since 2022/09/21
  38          */
  39         boolean isNullObject(Object __value);
  40
  41         /**
  42          * Reads the value of an array index within the object.
  43          *
  44          * @param __which What is being read from?
  45          * @param __index The index of the array to read from.
  46          * @param __out Where the value is to be stored.
  47          * @return {@code true} if this is a valid value.
  48          * @since 2021/04/10
  49          */
  50         boolean readArray(Object __which, int __index, JDWPValue __out);
  51
  52         /**
  53          * Reads the value of an instance field within the object.
  54          *
  55          * @param __which What is being read from?
  56          * @param __index The index of the field to read from the object.
  57          * @param __out Where the value is to be stored.
  58          * @return {@code true} if this is a valid value.
  59          * @since 2021/04/10
  60          */
  61         boolean readValue(Object __which, int __index, JDWPValue __out);
  62
  63         /**
  64          * Returns the object type.
  65          *
  66          * @param __which Which object to get the type of.
  67          * @return The type of the given object.
  68          * @since 2021/04/11
  69          */
  70         Object type(Object __which);
  71 }