Add checks to not give a result if a thread is not suspended.
[SquirrelJME.git] / scope.mkd
blobd18c9b9bcb313a4b7a1b4fb2e88c0c6168154021
1 # The Scope of SquirrelJME
3 This document defines the scope of SquirrelJME, classes which are to be
4 supported and ones which are not to be supported. All of the listed
5 specifications are either planned to be implemented, considering, or out
6 of scope for the project.
8 # To Implement
10 These are specifications which are to be implemented to provide the base
11 functionality for SquirrelJME.
13 ## Specifications
15 All of these listed specifications are not obsolete or implemented by other
16 specifications.
18  * **JSR184** -- Mobile 3D Graphics API for J2ME
19    * Needed by a number of games.
20  * **JSR211** -- Content Handler API
21    * Content handling, essentially say you install a JAR that is a media
22      player for MIDI files. Effectively if you "launch" a MIDI, that given JAR
23      will open to view the given content.
24  * **JSR226** -- Scalable 2D Vector Graphics API for J2ME 1.1
25    * SVG Tiny Support.
26    * Relies on LCDUI.
27    * Some classes can just forward calls to MIDP 3.
28  * **JSR238** -- Mobile Internationalization API
29    * Internationalization of text.
30  * **JSR239** -- Java Binding for the OpenGL ES API
31    * Required for some games.
32    * Can be more easily bridged to native OpenGL implementations compared to
33      M3G.
34  * **JSR256** -- Mobile Sensor API 1.2
35    * Sensors are useful.
36  * **JSR271** -- Mobile Information Device Profile 3
37    * Enhances support for MIDlets by adding more features.
38    * MIDP 3.0
39  * **JSR360** -- Connected Limited Device Configuration 8
40    * This is SquirrelJME's target.
41  * **JSR361** -- Java ME Embedded Profile
42    * MEEP 8.
43    * This is SquirrelJME's target.
45 ## Obsolete
47 These specifications are obsolete and are implemented by newer specifications.
49  * **JSR30**/**JSR030** -- J2ME Connected, Limited Device Configuration.
50    * _Implemented by newer JSR_.
51    * CLDC 1.0.
52  * **JSR37**/**JSR037** -- Mobile Information Device Profile for the J2ME Platform.
53    * _Implemented by newer JSR_.
54    * MIDP 1.0.
55    * Contains the Limited Capability Device User Interface (LCDUI).
56  * **JSR75**/**JSR075** -- PDA Optional Packages for the J2ME Platform
57    * _Implemented by newer JSR_.
58    * Contains file related `javax.microedition.io` classes.
59  * **JSR118** -- Mobile Information Device Profile 2.0
60    * _Implemented by newer JSR_.
61    * MIDP 2.0.
62  * **JSR135** -- Mobile Media API
63    * _Implemented by newer JSR_.
64    * Multimedia.
65    * Implemented by MIDP 3.
66  * **JSR139** -- Connected Limited Device Configuration 1.1
67    * _Implemented by newer JSR_.
68  * **JSR195** -- Information Module Profile Documentation
69    * _Implemented by newer JSR_.
70    * Essentially `HTTPConnection` and MEEP-8's _rms_.
71    * CLDC 1.1.
72  * **JSR228** -- Information Module Profile - Next Generation (IMP-NG)
73    * _Implemented by newer JSR_.
74    * An early ancestor to MIDP 3 and MEEP.
75  * **JSR234** -- Advanced Multimedia Supplements.
76    * _Implemented by newer JSR_.
77    * Included by MIDP 3.
78  * **JSR246** -- Device Management API
79    * _Implemented by newer JSR_.
80    * Included by Java ME 8.
82 # Considering
84 Specifications that may be considered for inclusion.
86 ## Specifications
88  * **JSR120** -- Java(TM) Wireless Messaging API Specification 1.1
89    * Supports SMS, USSD, and CBS.
90    * Uses GCF.
91  * **JSR179** -- Location API for J2ME.
92    * Locating of users via GPS and other such things.
93  * **JSR230** -- Data Sync API 0.9
94    * Similar to Palm OS's HotSync.
95  * **JSR257** -- Contactless Communication API
96    * Can be used for RFID and such.
97    * May also include NFC.
99 # Out of Scope
101 These specifications will be not be implement at all. Note however, that
102 although these specifications are out of scope may potentially be provided by
103 third parties libraries.
105 ## Specifications
107  * **JSR062** -- Personal Profile Specification.
108    * Effectively Java SE Embedded.
109  * **JSR066** -- RMI Optional Package Specification Version 1.0.
110    * Requires CDC.
111  * **JSR068** -- J2ME Platform Specification
112    * Withdrawn.
113    * Based on the description it uses "building blocks" which could also be
114      known as profiles. SquirrelJME already has such things in the project
115      system.
116  * **JSR129** -- Personal Basis Profile Specification
117    * Effectively Java SE Embedded.
118  * **JSR169** -- JDBC Optional Package for CDC/Foundation Profile
119    * Requires CDC.
120  * **JSR172** -- J2ME Web Services 1.1
121    * XML is nasty.
122    * Designed for both CLDC and CDC.
123  * **JSR177** -- Security and Trust Services API for J2ME
124    * Some classes are partially handled by other implemented JSRs.
125  * **JSR178** -- Mobile Game API
126    * Withdrawn.
127    * Based on the description it would essentially be a game library with
128      multiplayer APIs, collisions, vector graphics, and a physics engine.
129  * **JSR180** -- SIP API for J2ME.
130    * Voice calls.
131    * Uses GCF.
132    * This is really handled best by third party providers.
133  * **JSR197** -- Generic Connection Framework Optional Package for J2SE.
134    * Not J2ME related, however it is included to reduce confusion.
135    * Makes it so Java SE can use GCF.
136  * **JSR209** -- Advanced Graphics and User Interface.
137    * Effectively Java SE Embedded.
138  * **JSR213** -- Micro WSCI Framework for J2ME.
139    * Rejected.
140    * More nasty XML.
141    * Requires CDC.
142  * **JSR214** -- Micro BPSS for J2ME Devices.
143    * Rejected.
144  * **JSR217** -- Personal Basis Profile 1.1.2
145    * Effectively Java SE Embedded.
146  * **JSR216** -- Personal Profile.
147    * Effectively Java SE Embedded.
148  * **JSR218** -- Connected Device Configuration (CDC) 1.1
149    * CDC.
150  * **JSR219** -- Foundation Profile 1.1.2
151    * Effectively Java SE with Java ME bits.
152  * **JSR229** -- Payment API
153    * Used for monetary transactions.
154  * **JSR232** -- Mobile Operational Management
155    * CDC.
156  * **JSR242** -- Digital Set Top Box Profile - "On Ramp to OCAP"
157    * Effectively java SE.
158    * Has TV stuff.
159  * **JSR272** -- Mobile Broadcast Service API for Handheld Terminals 1.0
160    * This is for broadcast services, which is completley out of scope.
161  * **JSR302** -- Safety Critical Java Technology
162    * Essentially JSR001 for J2ME.
163    * Real time does not always mean safe.
164  * **JSR324** -- On Screen MIDlet API for Java ME
165    * Rejected.
166    * Essentially stuff related to the idle screen, likely similar to MIDP 3.
167  * **JSR325** -- IMS Communication Enablers
168    * Essentially VoIP.
169  * **JSR332** -- Email Client API for Java ME
170    * E-mail.
171  * **JSR927** -- Java TV API 1.1
172    * Depends upon _JSR127_ (Personal Basis Profile).
173    * Precedes _BD-J_.
174    * Includes `javax.tv.xlet`.
175  * **BD-J** -- Blu-ray Disc Java (Blu-ray Disc Association)
176    * Extends on Java TV (includes the Personal Basis Profile).
177    * Not a JSR, standardized by the specified association.
179 # Unknown
181 These are specifications which the understanding of them is not enough to
182 evaluate them completely for inclusion or exclusion.
184 ## Specifications
186  * **JSR190** -- Event Tracking API for J2ME
187    * IPDR/SP? Internet Protocol Detail Record.
188    * Not sure if this is for events that happen (say temperature changes) or
189      if something bad happens to hardware.