1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
|
/*
* $Header: /cvshome/build/org.osgi.framework/src/org/osgi/framework/FrameworkEvent.java,v 1.15 2007/02/20 00:14:12 hargrave Exp $
*
* Copyright (c) OSGi Alliance (2004, 2007). All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.osgi.framework;
import java.util.EventObject;
/**
* A general event from the Framework.
*
* <p>
* <code>FrameworkEvent</code> objects are delivered to
* <code>FrameworkListener</code>s when a general event occurs within the
* OSGi environment. A type code is used to identify the event type for future
* extendability.
*
* <p>
* OSGi Alliance reserves the right to extend the set of event types.
*
* @Immutable
* @see FrameworkListener
* @version $Revision: 1.15 $
*/
public class FrameworkEvent extends EventObject {
static final long serialVersionUID = 207051004521261705L;
/**
* Bundle related to the event.
*/
private final Bundle bundle;
/**
* Exception related to the event.
*/
private final Throwable throwable;
/**
* Type of event.
*/
private final int type;
/**
* The Framework has started.
*
* <p>
* This event is fired when the Framework has started after all installed
* bundles that are marked to be started have been started and the Framework
* has reached the intitial start level.
*
* <p>
* The value of <code>STARTED</code> is 0x00000001.
*
* @see "<code>StartLevel</code>"
*/
public final static int STARTED = 0x00000001;
/**
* An error has occurred.
*
* <p>
* There was an error associated with a bundle.
*
* <p>
* The value of <code>ERROR</code> is 0x00000002.
*/
public final static int ERROR = 0x00000002;
/**
* A PackageAdmin.refreshPackage operation has completed.
*
* <p>
* This event is fired when the Framework has completed the refresh packages
* operation initiated by a call to the PackageAdmin.refreshPackages method.
*
* <p>
* The value of <code>PACKAGES_REFRESHED</code> is 0x00000004.
*
* @since 1.2
* @see "<code>PackageAdmin.refreshPackages</code>"
*/
public final static int PACKAGES_REFRESHED = 0x00000004;
/**
* A StartLevel.setStartLevel operation has completed.
*
* <p>
* This event is fired when the Framework has completed changing the active
* start level initiated by a call to the StartLevel.setStartLevel method.
*
* <p>
* The value of <code>STARTLEVEL_CHANGED</code> is 0x00000008.
*
* @since 1.2
* @see "<code>StartLevel</code>"
*/
public final static int STARTLEVEL_CHANGED = 0x00000008;
/**
* A warning has occurred.
*
* <p>
* There was a warning associated with a bundle.
*
* <p>
* The value of <code>WARNING</code> is 0x00000010.
*
* @since 1.3
*/
public final static int WARNING = 0x00000010;
/**
* An informational event has occurred.
*
* <p>
* There was an informational event associated with a bundle.
*
* <p>
* The value of <code>INFO</code> is 0x00000020.
*
* @since 1.3
*/
public final static int INFO = 0x00000020;
/**
* Creates a Framework event.
*
* @param type The event type.
* @param source The event source object. This may not be <code>null</code>.
* @deprecated As of 1.2. This constructor is deprecated in favor of using
* the other constructor with the System Bundle as the event
* source.
*/
public FrameworkEvent(int type, Object source) {
super(source);
this.type = type;
this.bundle = null;
this.throwable = null;
}
/**
* Creates a Framework event regarding the specified bundle.
*
* @param type The event type.
* @param bundle The event source.
* @param throwable The related exception. This argument may be
* <code>null</code> if there is no related exception.
*/
public FrameworkEvent(int type, Bundle bundle, Throwable throwable) {
super(bundle);
this.type = type;
this.bundle = bundle;
this.throwable = throwable;
}
/**
* Returns the exception related to this event.
*
* @return The related exception or <code>null</code> if none.
*/
public Throwable getThrowable() {
return throwable;
}
/**
* Returns the bundle associated with the event. This bundle is also the
* source of the event.
*
* @return The bundle associated with the event.
*/
public Bundle getBundle() {
return bundle;
}
/**
* Returns the type of framework event.
* <p>
* The type values are:
* <ul>
* <li>{@link #STARTED}
* <li>{@link #ERROR}
* <li>{@link #WARNING}
* <li>{@link #INFO}
* <li>{@link #PACKAGES_REFRESHED}
* <li>{@link #STARTLEVEL_CHANGED}
* </ul>
*
* @return The type of state change.
*/
public int getType() {
return type;
}
}
|