EventObject.java 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /* EventObject.java -- represents an event on an object
  2. Copyright (C) 1999, 2000, 2002, 2005 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 java.util;
  32. import java.io.Serializable;
  33. /**
  34. * Represents Events fired by Objects.
  35. *
  36. * @author Eric Blake (ebb9@email.byu.edu)
  37. * @see EventListener
  38. * @since 1.1
  39. * @status updated to 1.4
  40. */
  41. public class EventObject implements Serializable
  42. {
  43. /**
  44. * Compatible with JDK 1.1+.
  45. */
  46. private static final long serialVersionUID = 5516075349620653480L;
  47. /**
  48. * The source object; in other words, the object which this event takes
  49. * place on.
  50. */
  51. protected transient Object source;
  52. /**
  53. * Constructs an EventObject with the specified source.
  54. *
  55. * @param source the source of the event
  56. * @throws IllegalArgumentException if source is null (This is not
  57. * specified, but matches the behavior of the JDK)
  58. */
  59. public EventObject(Object source)
  60. {
  61. // This check for null is stupid, if you ask me, since source is
  62. // protected and non-final, so a subclass can set it to null later on.
  63. if (source == null)
  64. throw new IllegalArgumentException();
  65. this.source = source;
  66. }
  67. /**
  68. * Returns the source of the event.
  69. *
  70. * @return the event source
  71. */
  72. public Object getSource()
  73. {
  74. return source;
  75. }
  76. /**
  77. * Converts the event to a String. The format is not specified, but by
  78. * observation, the JDK uses:
  79. * <code>getClass().getName() + "[source=" + source + "]";</code>.
  80. *
  81. * @return String representation of the Event
  82. */
  83. public String toString()
  84. {
  85. return getClass().getName() + "[source=" + source + "]";
  86. }
  87. } // class EventObject