J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 2004 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package sun.jvmstat.monitor.event; |
| 27 | |
| 28 | import java.util.Set; |
| 29 | import sun.jvmstat.monitor.MonitoredHost; |
| 30 | |
| 31 | /** |
| 32 | * Provides a description of a change in status of the Java Virtual Machines |
| 33 | * associated with a MonitoredHost. |
| 34 | * |
| 35 | * @author Brian Doherty |
| 36 | * @since 1.5 |
| 37 | */ |
| 38 | public class VmStatusChangeEvent extends HostEvent { |
| 39 | |
| 40 | /** |
| 41 | * The set of currently active Java Virtual Machines for the MonitoredHost. |
| 42 | * The set contains an Integer object holding the <em>lvmid</em> for each |
| 43 | * active Java Virtual Machine on the MonitoredHost. This Set will only |
| 44 | * contain Integer objects. |
| 45 | */ |
| 46 | protected Set active; |
| 47 | |
| 48 | /** |
| 49 | * The set of Java Virtual Machines started on MonitoredHost since the |
| 50 | * previous event. The set contains an Integer object holding the |
| 51 | * <em>lvmid</em> for each Java Virtual Machine started on the |
| 52 | * MonitoredHost. This Set will only contain Integer objects. |
| 53 | */ |
| 54 | protected Set started; |
| 55 | |
| 56 | /** |
| 57 | * The set of Java Virtual Machines terminated on MonitoredHost since the |
| 58 | * previous event. The set contains an Integer object holding the |
| 59 | * <em>lvmid</em> for each Java Virtual Machine started on the |
| 60 | * MonitoredHost. This Set will only contain Integer objects. |
| 61 | */ |
| 62 | protected Set terminated; |
| 63 | |
| 64 | /** |
| 65 | * Construct a new VmStatusChangeEvent instance. |
| 66 | * |
| 67 | * @param host the MonitoredHost that is the source of the event. |
| 68 | * @param active the set of currently active Java Virtual Machines |
| 69 | * @param started the set of Java Virtual Machines started since the |
| 70 | * last event. |
| 71 | * @param terminated the set of Java Virtual Machines terminated since |
| 72 | * the last event. |
| 73 | */ |
| 74 | public VmStatusChangeEvent(MonitoredHost host, Set active, |
| 75 | Set started, Set terminated) { |
| 76 | super(host); |
| 77 | this.active = active; |
| 78 | this.started = started; |
| 79 | this.terminated = terminated; |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Return the set of currently active Java Virtual Machines. |
| 84 | * The set contains an Integer object holding the <em>lvmid</em> for each |
| 85 | * active Java Virtual Machine on the MonitoredHost. |
| 86 | * |
| 87 | * @return Set - a set of Integer objects containing the <em>lvmid</em> |
| 88 | * of each active Java Virtual Machine on the host. If |
| 89 | * there are no active Java Virtual Machines on the host, |
| 90 | * an empty Set is returned. |
| 91 | */ |
| 92 | public Set getActive() { |
| 93 | return active; |
| 94 | } |
| 95 | |
| 96 | /** |
| 97 | * Return the set of Java Virtual Machines started since the last |
| 98 | * event notification. The set contains an Integer object holding |
| 99 | * the <em>lvmid</em> for each Java Virtual Machine started on the |
| 100 | * MonitoredHost since the last event notification. |
| 101 | * |
| 102 | * @return Set - a set of Integer objects containing the <em>lvmid</em> |
| 103 | * of each Java Virtual Machine started on the host. If |
| 104 | * no Java Virtual Machines were recently started on the |
| 105 | * host, an empty Set is returned. |
| 106 | */ |
| 107 | public Set getStarted() { |
| 108 | return started; |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Return the set of Java Virtual Machines terminated since the last |
| 113 | * event notification. The set contains an Integer object holding |
| 114 | * the <em>lvmid</em> for each Java Virtual Machine terminated on the |
| 115 | * MonitoredHost since the last event notification. |
| 116 | * |
| 117 | * @return Set - a set of Integer objects containing the <em>lvmid</em> |
| 118 | * of each Java Virtual Machine terminated on the host. If |
| 119 | * no Java Virtual Machines were recently terminated on the |
| 120 | * host, an empty Set is returned. |
| 121 | */ |
| 122 | public Set getTerminated() { |
| 123 | return terminated; |
| 124 | } |
| 125 | } |