libjava/gnu/classpath/jdwp/processor/CommandSet.java

   1 /* CommandSet.java -- An interface defining JDWP Command Sets
   2    Copyright (C) 2005 Free Software Foundation
   3
   4 This file is part of GNU Classpath.
   5
   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.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  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.
  25
  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. */
  38
  39
  40 package gnu.classpath.jdwp.processor;
  41
  42 import gnu.classpath.jdwp.exception.JdwpException;
  43
  44 import java.io.DataOutputStream;
  45 import java.nio.ByteBuffer;
  46
  47 /**
  48  * A class representing a JDWP Command Set. This class serves as a generic
  49  * interface for all Command Sets types used by JDWP.
  50  *
  51  * @author Aaron Luchko <aluchko@redhat.com>
  52  */
  53 public interface CommandSet
  54 {
  55   /**
  56    * Runs the given command with the data in distr and writes the data for the
  57    * reply packet to ostr.
  58    *
  59    * @param bb holds the data portion of the Command Packet
  60    * @param os data portion of the Reply Packet will be written here
  61    * @param command the command field of the Command Packet
  62    * @return true if the JDWP layer should shut down in response to this packet
  63    * @throws JdwpException command wasn't carried out successfully
  64    */
  65   public boolean runCommand(ByteBuffer bb, DataOutputStream os,
  66                             byte command)
  67     throws JdwpException;
  68 }