Source for javax.management.ValueExp

   1: /* ValueExp.java -- Represents values that can be passed to queries.
   2:    Copyright (C) 2006 Free Software Foundation, Inc.
   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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package javax.management;
  39: 
  40: import java.io.Serializable;
  41: 
  42: /**
  43:  * Represents values that may be passed as arguments to
  44:  * {@link QueryExp}s.  Strings, numbers and bean attributes
  45:  * are all valid argument types for query expressions, and
  46:  * so should be represented as implementations of this
  47:  * interface.
  48:  *
  49:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  50:  * @since 1.5
  51:  */
  52: public interface ValueExp
  53:   extends Serializable
  54: {
  55: 
  56:   /**
  57:    * Applies the value expression to the specified management bean.
  58:    *
  59:    * @param name the name of the management bean.
  60:    * @return the value expression.
  61:    * @throws BadStringOperationException if an invalid string
  62:    *                                     operation is used by
  63:    *                                     the value expression.
  64:    * @throws BadBinaryOpValueExpException if an invalid expression
  65:    *                                      is used by the value expression.
  66:    * @throws BadAttributeValueExpException if an invalid attribute
  67:    *                                       is used by the value expression.
  68:    * @throws InvalidApplicationException if the value expression is applied
  69:    *                                     to the wrong type of bean.
  70:    */
  71:   ValueExp apply(ObjectName name)
  72:     throws BadStringOperationException, BadBinaryOpValueExpException,
  73:        BadAttributeValueExpException, InvalidApplicationException;
  74: 
  75:   /**
  76:    * Changes the {@link MBeanServer} on which this query is performed.
  77:    *
  78:    * @param server the new server to use.
  79:    * @deprecated This method is superfluous, as the {@link ValueExp}
  80:    *             can access the server using
  81:    *             {@link QueryEval#getMBeanServer()}.
  82:    */
  83:   void setMBeanServer(MBeanServer server);
  84: 
  85: }