TargetedNotification.java 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. /* TargetedNotificaton.java -- Wrapper for a notification and identifier pair.
  2. Copyright (C) 2008 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.remote;
  32. import java.io.Serializable;
  33. import javax.management.Notification;
  34. /**
  35. * Wraps a notification with an identifier that specifies
  36. * the listener which received it.
  37. *
  38. * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  39. * @since 1.5
  40. */
  41. public class TargetedNotification
  42. implements Serializable
  43. {
  44. /**
  45. * Compatible with JDK 1.6
  46. */
  47. private static final long serialVersionUID = 7676132089779300926L;
  48. /**
  49. * The notification that was recieved by the listener.
  50. */
  51. private Notification notif;
  52. /**
  53. * The identifier for the listener that received the notification;
  54. */
  55. private Integer id;
  56. /**
  57. * Constructs a new {@link TargetedNotification} which connects
  58. * the supplied notification with the specified identifier. The
  59. * identifier matches one of those returned by a previous call
  60. * to add a new notification listener.
  61. *
  62. * @param notif the notification.
  63. * @param id the identifier of the listener that received the
  64. * notification.
  65. * @throws IllegalArgumentException if either argument is
  66. * <code>null</code>.
  67. */
  68. public TargetedNotification(Notification notif, Integer id)
  69. {
  70. if (notif == null)
  71. throw new IllegalArgumentException("The notification is null.");
  72. if (id == null)
  73. throw new IllegalArgumentException("The identifier is null.");
  74. this.notif = notif;
  75. this.id = id;
  76. }
  77. /**
  78. * Returns the notification.
  79. *
  80. * @return the notification.
  81. */
  82. public Notification getNotification()
  83. {
  84. return notif;
  85. }
  86. /**
  87. * Returns the identifier for the listener
  88. * which received the notification.
  89. *
  90. * @return the identifier.
  91. */
  92. public Integer getListenerID()
  93. {
  94. return id;
  95. }
  96. /**
  97. * Returns a textual representation of the object.
  98. *
  99. * @return a textual representation.
  100. */
  101. public String toString()
  102. {
  103. return getClass().getName() +
  104. "[notif=" + notif +
  105. ",id=" + id +
  106. "]";
  107. }
  108. }