| 
 | MIDP3.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.microedition.event.EventData
public final class EventData
The EventData class provides methods to create events and
 to retrieve information from events. The predefined system events are also
 defined in this class.
Each event has a name, a typed value, a source and may have a message and
 an information object. The source of the event is either system or another application.
 The typed value must be one of long, double, boolean, or String.
 Events can be constructed from any primitive type but are converted to
 one of the types above using the normal Java Language Specification
 rules for type conversions (see [JLS] Chapter 5,
 Conversions and Promotions).
 The methods getInt, getLong,
 getFloat, getDouble,
 getBoolean, getString return the
 value by converting the value to the type requested as defined in each method.
 The method getValue returns the value as an Object.
 
 The information object supports a limited set of types
 to keep the implementation simple.
 The valid types allowed for the info object is restricted to:
 java.lang.String, java.lang.Boolean, java.lang.Double,
 java.lang.Long, and byte[].
 
The EventData class and EventManager implementations
 MUST support passing the event name, value, message and info object totaling at
 least 1024 bytes. Each character of the String objects, including event
 name, value, and message is counted as two bytes. The number of bytes counted for the
 primitive value types are:  boolean: 1, double: 8, and long: 8.
 The info object size is counted as the array length if it is a byte array;
 for all other info object types, it is considered to be
 exactly the same size as its corresponding primitive data type.
 The implementation overhead exceeding the previously defined sizes
 for a particular field MUST NOT be counted towards the 1024 byte requirement.
Some system properties have values that may change at runtime. If
 notification of changes to system properties is desired then the
 specification of each such system property must define the associated event
 of the same name. The system property event values are String objects
 and will return the current value of the system property as the value of the event.
 The implementation MUST ensure that when the system property is set that the
 corresponding event is posted. The event name for each such system property
 MUST be returned from the
 EventManager.getSystemEvents method.
| Field Summary | |
|---|---|
| static java.lang.String | APPLICATION_RELAUNCH_PREFIXPrefix of system event names that indicate an attempt was made to relaunch a target MIDlet that is already running. | 
| static java.lang.String | AUDIO_MUTEIndicates whether all audio output devices under the control of the implementation are muted. | 
| static java.lang.String | BACKLIGHTIndicates the backlight illumination level. | 
| static int | BACKLIGHT_DIMIndicates the backlight is dim. | 
| static int | BACKLIGHT_OFFIndicates the backlight is off. | 
| static int | BACKLIGHT_ONIndicates the backlight is on. | 
| static java.lang.String | BATTERY_CHARGINGIndicates whether the battery is currently charging. | 
| static java.lang.String | BATTERY_LEVELIndicates the amount of charge remaining in the battery as a percent represented by intvalues of 0 to 100
 inclusive. | 
| static java.lang.String | BATTERY_LOWIndicates if the battery is low. | 
| static java.lang.String | DATA_NETWORKIndicates the available data networks. | 
| static java.lang.String | EXTERNAL_POWERIndicates whether the device is connected to an external power source. | 
| static java.lang.String | FLIGHT_MODEIndicates that the device is in flight mode. | 
| static java.lang.String | NETWORK_3GPP_CSDData network technology name for circuit switched data (CSD). | 
| static java.lang.String | NETWORK_3GPP_PDData network technology name for packet data in the GSM network. | 
| static java.lang.String | NETWORK_3GPP_PD_3GData network technology name for packet data in the 3G(UMTS) network. | 
| static java.lang.String | NETWORK_3GPP_PD_EDGEData network technology name for packet data in the EDGE network. | 
| static java.lang.String | NETWORK_3GPP_PD_HSDPAData network technology name for high speed download packet data in the 3G network (HSDPA). | 
| static java.lang.String | NETWORK_802DOT11Data network technology name for the 802.11 WiFi family of interfaces. | 
| static java.lang.String | NETWORK_802DOT16Data network technology name for the 802.16 WiMax interface standards. | 
| static java.lang.String | NETWORK_CDMAData network technology name for the CDMA/3GPP2 defined set of radio interface technologies. | 
| static java.lang.String | PROFILE_ACTIVATEDIndicates that a named profile was activated. | 
| static java.lang.String | PROFILE_GENERALConstant for the General profile. | 
| static java.lang.String | PROFILE_MEETINGConstant for the Meeting profile. | 
| static java.lang.String | PROFILE_OFFLINEConstant for the Offline profile (also known as "Flight Mode"). | 
| static java.lang.String | PROFILE_OUTDOORConstant for the Outdoor profile. | 
| static java.lang.String | PROFILE_PAGERConstant for the Pager profile. | 
| static java.lang.String | PROFILE_SILENTConstant for the Silent profile. | 
| static java.lang.String | PROFILE_SYSTEM1Constant for first system-reserved profile. | 
| static java.lang.String | PROFILE_SYSTEM2Constant for second system-reserved profile. | 
| static java.lang.String | PROFILE_SYSTEM3Constant for third system-reserved profile. | 
| static java.lang.String | PROFILE_SYSTEM4Constant for fourth system-reserved profile. | 
| static java.lang.String | PROFILE_USER1Constant for first user-defined profile. | 
| static java.lang.String | PROFILE_USER2Constant for second user-defined profile. | 
| static java.lang.String | PROFILE_USER3Constant for third user-defined profile. | 
| static java.lang.String | PROFILE_USER4Constant for fourth user-defined profile. | 
| static java.lang.String | SCREENSAVER_MODEIndicates the changes in the screen saver execution as a Stringvalue. | 
| static java.lang.String | SCREENSAVER_MODE_ACTIVATEDIndicates the screen saver is being activated. | 
| static java.lang.String | SCREENSAVER_MODE_DEACTIVATEDIndicates the screen saver is being deactivated. | 
| static java.lang.String | SYSTEM_STATEIndicates the system state as a Stringvalue. | 
| static java.lang.String | SYSTEM_STATE_NORMALIndicates the system is running applications normally. | 
| static java.lang.String | SYSTEM_STATE_SHUTDOWNIndicates the system is shutting down. | 
| static java.lang.String | SYSTEM_STATE_STANDBYIndicates the device is entering a potentially low power state in which no applications are running. | 
| static java.lang.String | SYSTEM_STATE_STARTUPIndicates the system is starting up. | 
| static java.lang.String | VOICE_CALLIndicates whether there are voice calls currently active. | 
| Constructor Summary | |
|---|---|
| EventData(java.lang.String event,
          boolean value,
          java.lang.String message,
          java.lang.Object info)Creates a new instance of EventDatawith abooleanvalue. | |
| EventData(java.lang.String event,
          double value,
          java.lang.String message,
          java.lang.Object info)Creates a new instance of EventDatawith adoublevalue. | |
| EventData(java.lang.String event,
          long value,
          java.lang.String message,
          java.lang.Object info)Creates a new instance of EventDatawith alongvalue. | |
| EventData(java.lang.String event,
          java.lang.String value,
          java.lang.String message,
          java.lang.Object info)Creates a new instance of EventDatawith aStringvalue. | |
| Method Summary | |
|---|---|
|  boolean | equals(java.lang.Object object)Checks if another object is "equal" to this one. | 
|  boolean | getBoolean()Gets the value as a boolean. | 
|  double | getDouble()Gets the value as a double. | 
|  float | getFloat()Gets the value as a float. | 
|  java.lang.Object | getInfo()Gets information regarding the event. | 
|  int | getInt()Gets the value as an int. | 
|  long | getLong()Gets the value as an long. | 
|  java.lang.String | getMessage()Gets the message for this event. | 
|  java.lang.String | getName()Gets the name of the event. | 
|  MIDletIdentity | getSourceInfo()Gets the information about the source of this event. | 
|  java.lang.String | getString()Gets the value as a String. | 
|  long | getTimestamp()Gets the time when the event was posted. | 
|  java.lang.Object | getValue()Gets the value as a java.lang.Object. | 
|  int | hashCode()Gets the hash code value for this object. | 
|  java.lang.String | toString()Gets the value as a String. | 
| Methods inherited from class java.lang.Object | 
|---|
| getClass, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
public static final java.lang.String BATTERY_LEVEL
int values of 0 to 100
 inclusive.
 Implementations SHOULD map the native battery levels to an
 aggregate percentile of all batteries in the device.
 Only changes in battery level detectable by the implementation must
 be reported.
public static final java.lang.String BATTERY_LOW
boolean, if true the battery
 is low, otherwise the battery is ok.
 If true MIDlets should save their work and conserve power.
public static final java.lang.String BATTERY_CHARGING
boolean value of true indicates that the
 battery is charging and is false otherwise.
public static final java.lang.String EXTERNAL_POWER
boolean value of true
 indicates that the device is connected, otherwise the value is
 false.
public static final java.lang.String FLIGHT_MODE
boolean, true indicates that
 flight mode is active; otherwise false.
public static final java.lang.String SYSTEM_STATE
Indicates the system state as a String value.
 Valid values are
 SYSTEM_STATE_STARTUP,
 SYSTEM_STATE_NORMAL,
 SYSTEM_STATE_SHUTDOWN, and
 SYSTEM_STATE_STANDBY.
Events for each system state are delivered when the
 system enters the state. The current system state can
 be queried with EventManager.getCurrent.
 When the system is initialized the STARTUP state is entered
 and startup applications are automatically launched.
 When the system is ready to begin running MIDlets under
 user control or resuming from the standby state the NORMAL state is entered.
 When the system is in a low power or standby state the
 STANDBY state is entered.
 When the system is shutting down applications the SHUTDOWN
 state is entered.
public static final java.lang.String SYSTEM_STATE_NORMAL
SYSTEM_STATE, 
Constant Field Valuespublic static final java.lang.String SYSTEM_STATE_STARTUP
SYSTEM_STATE, 
Constant Field Valuespublic static final java.lang.String SYSTEM_STATE_SHUTDOWN
SYSTEM_STATE, 
Constant Field Valuespublic static final java.lang.String SYSTEM_STATE_STANDBY
SYSTEM_STATE, 
Constant Field Valuespublic static final java.lang.String VOICE_CALL
boolean value of true indicates that there
 are voice calls active while a value of false indicates
 that no voice calls are active.
public static final java.lang.String BACKLIGHT
Display.flashBacklight(int).
 The value SHOULD NOT be changed due to any programmatic
 flashing of the backlight through any other API.
 The value is an integer with values:
 BACKLIGHT_ON, BACKLIGHT_OFF, or
 BACKLIGHT_DIM.
public static final int BACKLIGHT_OFF
BACKLIGHT, 
Constant Field Valuespublic static final int BACKLIGHT_ON
BACKLIGHT, 
Constant Field Valuespublic static final int BACKLIGHT_DIM
BACKLIGHT, 
Constant Field Valuespublic static final java.lang.String AUDIO_MUTE
boolean value of true indicates all audio
 output devices are muted and false otherwise.
public static final java.lang.String SCREENSAVER_MODE
String value. Valid values are:
 SCREENSAVER_MODE_ACTIVATED -
      The screen saver is activated.SCREENSAVER_MODE_DEACTIVATED -
      The screen saver is deactivated.
public static final java.lang.String SCREENSAVER_MODE_ACTIVATED
SCREENSAVER_MODE, 
Constant Field Valuespublic static final java.lang.String SCREENSAVER_MODE_DEACTIVATED
SCREENSAVER_MODE, 
Constant Field Valuespublic static final java.lang.String APPLICATION_RELAUNCH_PREFIX
APPLICATION_RELAUNCH_PREFIX + target.getMIDletIdentity().toString()
 where target is an placeholder for the target MIDlet.
 The type of the value is boolean and the value is always true.
 
 To be notified of relaunch attempts the
 MIDlet should concatenate this prefix with the string returned
 from MIDletIdentity.toString() and register to listen for the event.
 
public static final java.lang.String PROFILE_ACTIVATED
String. The event
 String value MUST be one of the following:
 PROFILE_GENERALPROFILE_SILENTPROFILE_MEETINGPROFILE_OUTDOORPROFILE_PAGERPROFILE_OFFLINEPROFILE_USER1PROFILE_USER2PROFILE_USER3PROFILE_USER4PROFILE_SYSTEM1PROFILE_SYSTEM2PROFILE_SYSTEM3PROFILE_SYSTEM4USER1...4 and SYSTEM1...4
 are placeholders for user-defined profiles and existing
 system profiles that do not fit the defined semantics.
 As event information, the implementation SHOULD set a String
 containing the display name of the activated profile, if any.
 Applications MUST NOT be able to post PROFILE_ACTIVATED
 events to other applications or the system.
public static final java.lang.String PROFILE_GENERAL
public static final java.lang.String PROFILE_SILENT
public static final java.lang.String PROFILE_MEETING
public static final java.lang.String PROFILE_OUTDOOR
public static final java.lang.String PROFILE_PAGER
public static final java.lang.String PROFILE_OFFLINE
public static final java.lang.String PROFILE_USER1
public static final java.lang.String PROFILE_USER2
public static final java.lang.String PROFILE_USER3
public static final java.lang.String PROFILE_USER4
public static final java.lang.String PROFILE_SYSTEM1
public static final java.lang.String PROFILE_SYSTEM2
public static final java.lang.String PROFILE_SYSTEM3
public static final java.lang.String PROFILE_SYSTEM4
public static final java.lang.String DATA_NETWORK
EventData value field.
 The data network technology names MUST be the following:
 NETWORK_3GPP_CSDNETWORK_3GPP_PDNETWORK_3GPP_PD_EDGENETWORK_3GPP_PD_3GNETWORK_3GPP_PD_HSDPANETWORK_802DOT11NETWORK_802DOT16NETWORK_CDMA
public static final java.lang.String NETWORK_3GPP_CSD
public static final java.lang.String NETWORK_3GPP_PD
public static final java.lang.String NETWORK_3GPP_PD_3G
public static final java.lang.String NETWORK_3GPP_PD_EDGE
public static final java.lang.String NETWORK_3GPP_PD_HSDPA
public static final java.lang.String NETWORK_802DOT11
public static final java.lang.String NETWORK_802DOT16
public static final java.lang.String NETWORK_CDMA
| Constructor Detail | 
|---|
public EventData(java.lang.String event,
                 java.lang.String value,
                 java.lang.String message,
                 java.lang.Object info)
EventData with a String
 value. The event name may be either a custom application specific event
 name or one of the predefined system events.
event - The name of the event.value - The String value for this eventmessage - The message text explaining the current event, or null
            if this event has no message.info - Additional information about this event, or null
            for no information.
java.lang.NullPointerException - If event or value parameter is
            null.
java.lang.IllegalArgumentException - If the Java type of info is not one of
            the valid types.
public EventData(java.lang.String event,
                 long value,
                 java.lang.String message,
                 java.lang.Object info)
EventData with a long
 value. The event name may be either a custom application specific event
 name or one of the predefined system events.
event - The name of the event.value - The value for this event;
            the full range of long values MUST be stored.message - The message text explaining the current event, or null
            if this event has no message.info - Additional information about this event,
            as an Object or null for no information.
java.lang.NullPointerException - If event parameter is null
java.lang.IllegalArgumentException - If the Java type of info is not one of
            the valid types.getLong(), 
getInt()
public EventData(java.lang.String event,
                 double value,
                 java.lang.String message,
                 java.lang.Object info)
EventData with a double
 value. The event name may be either a custom application specific event
 name or one of the predefined system events.
event - The name of the event.value - The value for this event;
            the full range of double values MUST be stored.message - The message text explaining the current event, or null
            if this event has no message.info - Additional information about this event,
            as an Object or null for no information.
java.lang.NullPointerException - If the event parameter is null.
java.lang.IllegalArgumentException - If the Java type of info is not one of
            the valid types.
public EventData(java.lang.String event,
                 boolean value,
                 java.lang.String message,
                 java.lang.Object info)
EventData with a boolean
 value. The event name may be either a custom application specific event
 name or one of the predefined system events.
event - The name of the event.value - The boolean value for this event.message - The message text explaining the current event, or null
            if this event has no message.info - Additional information about this event,
            as an Object or null for no information.
java.lang.NullPointerException - If the event parameter is null.
java.lang.IllegalArgumentException - If the Java type of info is not one of
            the valid types.| Method Detail | 
|---|
public java.lang.String getName()
public int hashCode()
java.lang.Object.hashcode.
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object object)
java.lang.Object.equals.
equals in class java.lang.Objectobject - an object to compare
true if the object is an instance of the same class
      and the event name, event typed value, and the message are all equal.public java.lang.String getMessage()
null
         if this event has no message.public java.lang.Object getInfo()
instanceof operator or the object's Class
 may be used to determine the type of the value.
null if there
         is no further information about this event.
public float getFloat()
               throws java.lang.NumberFormatException
float.
 | Value | Convert to float | 
|---|---|
| long | (float)value | 
| double | (float)value | 
| boolean | (value ? 1.0f : 0.0f) | 
| String | java.lang.Float.parseFloat(value) | 
float.
java.lang.NumberFormatException - If the value is a boolean or can not be parsed as a
             float value.
public double getDouble()
                 throws java.lang.NumberFormatException
double.
 | Value | Convert to float | 
|---|---|
| long | (double)value | 
| double | value | 
| boolean | (value ? 1.0d : 0.0d) | 
| String | java.lang.Double.parseDouble(value) | 
double.
java.lang.NumberFormatException - If the value can not be parsed as a double value.
public int getInt()
           throws java.lang.NumberFormatException
int.
 | Value | Convert to int | 
|---|---|
| long | (int)value | 
| double | (int)value | 
| boolean | (value ? 1 : 0) | 
| String | java.lang.Integer.parseInt(value) | 
int.
java.lang.NumberFormatException - If the value can not be parsed as an int.
public long getLong()
             throws java.lang.NumberFormatException
long.
 | Value | Convert to int | 
|---|---|
| long | value | 
| double | (long)value | 
| boolean | (value ? 1L : 0L) | 
| String | java.lang.Long.parseLong(value) | 
int.
java.lang.NumberFormatException - If the value can not be parsed as an long.public boolean getBoolean()
boolean.
 | Value | Convert to boolean | 
|---|---|
| long | (value == 0 ? false : true) | 
| double | (value == 0.0f ? false : true | 
| boolean | value | 
| String | value.equals("true") | 
boolean.public java.lang.Object getValue()
java.lang.Object.
 The value of the event is converted to an Object depending
 on the type of the value:
 | Value | Convert to Object | 
|---|---|
| long | new java.lang.Long(value) | 
| double | new java.lang.Double(value) | 
| boolean | new java.lang.Boolean(value) | 
| String | new java.lang.String(value) | 
Object.public java.lang.String getString()
String.
 The value of the event is converted to a String depending
 on the type of the value:
 | Value | Convert to String | 
|---|---|
| long | java.lang.Long.toString() | 
| double | java.lang.Double.toString() | 
| boolean | java.lang.Boolean.toString() | 
| String | value | 
String.public java.lang.String toString()
String.
 The value of the event is using getString.
toString in class java.lang.ObjectString.public MIDletIdentity getSourceInfo()
null is returned.
null if this
         EventData was not posted by a MIDlet.MIDletIdentitypublic long getTimestamp()
java.lang.System.currentTimeMillis.
| 
 | MIDP3.0 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||