Source for gnu.classpath.jdwp.processor.CommandSet

   1: /* -- An interface defining JDWP Command Sets
   2:    Copyright (C) 2005 Free Software Foundation
   4: This file is part of GNU Classpath.
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  14: General Public License for more details.
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: terms of your choice, provided that you also meet, for each linked
  32: independent module, the terms and conditions of the license of that
  33: module.  An independent module is a module which is not derived from
  34: or based on this library.  If you modify this library, you may extend
  35: this exception to your version of the library, but you are not
  36: obligated to do so.  If you do not wish to do so, delete this
  37: exception statement from your version. */
  40: package gnu.classpath.jdwp.processor;
  42: import gnu.classpath.jdwp.exception.JdwpException;
  43: import gnu.classpath.jdwp.VMIdManager;
  45: import;
  46: import java.nio.ByteBuffer;
  48: /**
  49:  * A class representing a JDWP Command Set. This class serves as a generic
  50:  * interface for all Command Sets types used by JDWP.
  51:  *
  52:  * @author Aaron Luchko <>
  53:  */
  54: public abstract class CommandSet
  55: {
  56:   /**
  57:    * The VM's ID manager
  58:    */
  59:   protected final VMIdManager idMan = VMIdManager.getDefault ();
  61:   /**
  62:    * Runs the given command with the data in distr and writes the data for the
  63:    * reply packet to ostr.
  64:    *
  65:    * @param bb holds the data portion of the Command Packet
  66:    * @param os data portion of the Reply Packet will be written here
  67:    * @param command the command field of the Command Packet
  68:    * @return true if the JDWP layer should shut down in response to this packet
  69:    * @throws JdwpException command wasn't carried out successfully
  70:    */
  71:   public abstract boolean runCommand(ByteBuffer bb, DataOutputStream os,
  72:                                      byte command)
  73:     throws JdwpException;
  74: }