1 /*
   2  * Copyright 2000-2008 Sun Microsystems, Inc.  All Rights Reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *  
  23  */
  24 
  25 package sun.jvm.hotspot.oops;
  26 
  27 // An OopVisitor can be used to inspect all fields within an object.
  28 // Fields include vm fields, java fields, indexable fields.
  29 
  30 public interface OopVisitor {
  31   // Called before visiting an object
  32   public void prologue();
  33 
  34   // Called after visiting an object
  35   public void epilogue();
  36 
  37   public void setObj(Oop obj);
  38 
  39   // Returns the object being visited
  40   public Oop getObj();
  41 
  42   // Callback methods for each field type in an object
  43   public void doOop(OopField field, boolean isVMField);
  44   public void doOop(NarrowOopField field, boolean isVMField);
  45   public void doByte(ByteField field, boolean isVMField);
  46   public void doChar(CharField field, boolean isVMField);
  47   public void doBoolean(BooleanField field, boolean isVMField);
  48   public void doShort(ShortField field, boolean isVMField);
  49   public void doInt(IntField field, boolean isVMField);
  50   public void doLong(LongField field, boolean isVMField);
  51   public void doFloat(FloatField field, boolean isVMField);
  52   public void doDouble(DoubleField field, boolean isVMField);
  53   public void doCInt(CIntField field, boolean isVMField);
  54 };