QueryExp.java 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. /* QueryExp.java -- Represents a query expression.
  2. Copyright (C) 2006 Free Software Foundation, Inc.
  3. This file is part of GNU Classpath.
  4. GNU Classpath is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 2, or (at your option)
  7. any later version.
  8. GNU Classpath is distributed in the hope that it will be useful, but
  9. WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with GNU Classpath; see the file COPYING. If not, write to the
  14. Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  15. 02110-1301 USA.
  16. Linking this library statically or dynamically with other modules is
  17. making a combined work based on this library. Thus, the terms and
  18. conditions of the GNU General Public License cover the whole
  19. combination.
  20. As a special exception, the copyright holders of this library give you
  21. permission to link this library with independent modules to produce an
  22. executable, regardless of the license terms of these independent
  23. modules, and to copy and distribute the resulting executable under
  24. terms of your choice, provided that you also meet, for each linked
  25. independent module, the terms and conditions of the license of that
  26. module. An independent module is a module which is not derived from
  27. or based on this library. If you modify this library, you may extend
  28. this exception to your version of the library, but you are not
  29. obligated to do so. If you do not wish to do so, delete this
  30. exception statement from your version. */
  31. package javax.management;
  32. import java.io.Serializable;
  33. /**
  34. * Applies the type of relational constraints seen in the
  35. * <code>where</code> clauses of databases to an
  36. * {@link ObjectName}. Instances of this class are usually
  37. * returned by the static methods of the {@link Query} classes.
  38. * If a custom implementation is required, it is better to
  39. * extend the {@link QueryEval} class, rather than simply
  40. * implementing this interface, in order to ensure that
  41. * the {@link #setMBeanServer(MBeanServer)} method functions
  42. * correctly.
  43. *
  44. * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  45. * @since 1.5
  46. */
  47. public interface QueryExp
  48. extends Serializable
  49. {
  50. /**
  51. * Applies the query to the specified management bean.
  52. *
  53. * @param name the name of the management bean.
  54. * @return true if the query was applied successfully.
  55. * @throws BadStringOperationException if an invalid string
  56. * operation is used by
  57. * the query.
  58. * @throws BadBinaryOpValueExpException if an invalid expression
  59. * is used by the query.
  60. * @throws BadAttributeValueExpException if an invalid attribute
  61. * is used by the query.
  62. * @throws InvalidApplicationException if the query is applied
  63. * to the wrong type of bean.
  64. */
  65. boolean apply(ObjectName name)
  66. throws BadStringOperationException, BadBinaryOpValueExpException,
  67. BadAttributeValueExpException, InvalidApplicationException;
  68. /**
  69. * Changes the {@link MBeanServer} on which this query is performed.
  70. *
  71. * @param server the new server to use.
  72. */
  73. void setMBeanServer(MBeanServer server);
  74. }