チェンジセット 637

差分発生行の前後
無視リスト:
コミット日時:
2008/06/14 11:49:01 (5 ヶ月前)
コミッタ:
yossy
ログメッセージ:

Thread(soumen): どきゅどきゅどっきゅん☆ASDoc 完遂

ファイル:

凡例:

変更無し
追加
削除
更新
コピー
移動

  • as3/Thread/branches/soumen/Thread.as3proj

    r632 r637  
    6969  <!-- Class files to compile (other referenced classes will automatically be included) --> 
    7070  <compileTargets> 
    71     <compile path="tests\RunTests.as" /> 
     71    <compile path="samples\progress\Sample.as" /> 
    7272  </compileTargets> 
    7373  <!-- Paths to exclude from the Project Explorer tree --> 

  • as3/Thread/branches/soumen/src/org/libspark/thread/EnterFrameThreadExecutor.as

    r535 r637  
    3232         
    3333        /** 
     34         * EnterFrameThreadExecutor クラスは IThreadExecutor インターフェイスの実装クラスで、 
     35         * フレーム実行のタイミングでスレッドを実行します. 
     36         *  
    3437         * @author      yossy:beinteractive 
    3538         */ 
    3639        public class EnterFrameThreadExecutor implements IThreadExecutor 
    3740        { 
     41                /** 
     42                 * 新しい EnterFrameThreadExecutor クラスのインスタンスを作成します 
     43                 */ 
    3844                public function EnterFrameThreadExecutor()  
    3945                { 
    …… 
    4248                private var _clip:MovieClip; 
    4349                 
     50                /** 
     51                 * @inheritDoc 
     52                 */ 
    4453                public function start():void 
    4554                { 
    …… 
    5261                } 
    5362                 
     63                /** 
     64                 * @inheritDoc 
     65                 */ 
    5466                public function stop():void 
    5567                { 
    …… 
    6274                } 
    6375                 
     76                /** 
     77                 * フレーム実行ハンドラ 
     78                 *  
     79                 * @param       e       イベント 
     80                 * @private 
     81                 */ 
    6482                private function enterFrameHandler(e:Event):void 
    6583                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/IMonitor.as

    r535 r637  
    2929{ 
    3030        /** 
     31         * IMonitor インターフェイスは、スレッドのモニタ機構に関するメソッドを提供します. 
     32         *  
     33         * <p>モニタ機構は、スレッドを協調動作させるために使用します。たとえば、あるリソースが利用可能になるまで、 
     34         * そのリソースを利用する必要があるスレッドを待機させる、といったことが出来ます。</p> 
     35         *  
    3136         * @author      yossy:beinteractive 
    3237         */ 
    …… 
    3439        { 
    3540                /** 
    36                  * 別のスレッドがこのモニターの notify() メソッドまたは notifyAll() メソッドを呼び出すか、指定された時間が経過するまで、現在のスレッドを待機させます。 
     41                 * 別のスレッドがこのモニターの notify メソッドまたは notifyAll メソッドを呼び出すか、指定された時間が経過するまで、現在のスレッドを待機させます. 
    3742                 *  
    38                  * 待機時間に 0 を指定すると、永遠に待ち続けます。 
    39                  *  
    40                  * @param      timeout 待機時間(ミリ秒) 
     43                 * @param      timeout 待機させる時間 (ミリ秒)。 0 を指定した場合、永遠に待ち続けます 
     44                 * @see        #notify() 
     45                 * @see        #notifyAll() 
    4146                 */ 
    4247                function wait(timeout:uint = 0):void; 
    4348                 
    4449                /** 
    45                  * このモニターで待機中のスレッドを 1 つ再開します。 
     50                 * このモニターで待機中のスレッドを 1 つ再開します. 
     51                 *  
     52                 * @see #wait() 
    4653                 */ 
    4754                function notify():void; 
    4855                 
    4956                /** 
    50                  * このモニターで待機中のすべてのスレッドを再開します。 
     57                 * このモニターで待機中のすべてのスレッドを再開します. 
     58                 *  
     59                 * @see #wait() 
    5160                 */ 
    5261                function notifyAll():void; 
    5362                 
    5463                /** 
    55                  * 待機中に例外が発生した等の理由で、指定されたスレッドがこのモニタの待機セットから抜けることを伝えます。 
    56                  * 通常、このメソッドは内部的にのみ使用され、ユーザーが呼び出す必要はありません。 
     64                 * 待機中に例外が発生した等の理由で、指定されたスレッドがこのモニタの待機セットから抜けることを伝えます. 
     65                 *  
     66                 * <p>通常、このメソッドは内部的にのみ使用され、ユーザーが呼び出す必要はありません。</p> 
    5767                 *  
    5868                 * @param       thread  待機セットから抜けるスレッド 

  • as3/Thread/branches/soumen/src/org/libspark/thread/IThreadExecutor.as

    r535 r637  
    2929{ 
    3030        /** 
     31         * IThreadExecutor インターフェイスはスレッドの実行タイミングを制御する役割を持ちます. 
     32         *  
     33         * <p>IThreadExecutor インターフェイスの実装クラスは、 Thread#executeAllThreads メソッドを呼び出して、 
     34         * スレッドを実行する必要があります。この動作は、何らかの条件に基づいて、 start メソッドが呼び出されてから、 
     35         * stop メソッドが呼び出されるまで、断続的に行う必要があります。</p> 
     36         *  
    3137         * @author      yossy:beinteractive 
     38         * @see Thread#executeAllThreads() 
    3239         */ 
    3340        public interface IThreadExecutor  
    3441        { 
     42                /** 
     43                 * IThreadExecutor の実行を開始します. 
     44                 *  
     45                 * <p>このメソッドが呼び出された後は、何らかの条件に基づいて、 stop メソッドが呼び出されるまで、 
     46                 * Thread#executeAllThreads メソッドを断続的に呼び出すことが求められます。</p> 
     47                 */ 
    3548                function start():void; 
     49                 
     50                /** 
     51                 * IThreadExecutor の実行を終了します. 
     52                 */ 
    3653                function stop():void; 
    3754        } 

  • as3/Thread/branches/soumen/src/org/libspark/thread/IntervalThreadExecutor.as

    r628 r637  
    3232         
    3333        /** 
    34          * IntervalThreadExecutor は IThreadExecutor インターフェイスの実装クラスで、 
     34         * IntervalThreadExecutor クラスは IThreadExecutor インターフェイスの実装クラスで、 
    3535         * 指定された時間の間隔でスレッドを実行します. 
    3636         *  

  • as3/Thread/branches/soumen/src/org/libspark/thread/Monitor.as

    r535 r637  
    3333 
    3434        /** 
     35         * Monitor クラスは IMonitor インターフェイスの実装クラスで、モニタ機構の最も一般的な実装を提供します. 
     36         *  
    3537         * @author      yossy:beinteractive 
    3638         */ 
    3739        public class Monitor implements IMonitor 
    3840        { 
     41                /** 
     42                 * 新しい Monitor クラスのインスタンスを生成します. 
     43                 */ 
    3944                public function Monitor() 
    4045                { 
    …… 
    4449                private var _timeoutList:Dictionary; 
    4550                 
     51                /** 
     52                 * ウェイトセットを返します. 
     53                 *  
     54                 * @return      ウェイトセット 
     55                 * @private 
     56                 */ 
    4657                private function getWaitors():Array 
    4758                { 
    …… 
    4960                } 
    5061                 
     62                /** 
     63                 * タイムアウトを設定します. 
     64                 *  
     65                 * @param       thread  設定するスレッド 
     66                 * @param       timeout タイムアウトするまでの時間 
     67                 * @private 
     68                 */ 
    5169                private function registerTimeout(thread:Thread, timeout:uint):void 
    5270                { 
    …… 
    6078                } 
    6179                 
     80                /** 
     81                 * タイムアウトを解除します. 
     82                 *  
     83                 * @param       thread  解除するスレッド 
     84                 * @private 
     85                 */ 
    6286                private function unregisterTimeout(thread:Thread):void 
    6387                { 
    …… 
    77101                } 
    78102                 
     103                /** 
     104                 * @inheritDoc 
     105                 */ 
    79106                public function wait(timeout:uint = 0):void 
    80107                { 
    …… 
    94121                } 
    95122                 
     123                /** 
     124                 * @inheritDoc 
     125                 */ 
    96126                public function notify():void 
    97127                { 
    …… 
    111141                } 
    112142                 
     143                /** 
     144                 * @inheritDoc 
     145                 */ 
    113146                public function notifyAll():void 
    114147                { 
    …… 
    148181                } 
    149182                 
     183                /** 
     184                 * タイムアウトした際に実行されるハンドラです. 
     185                 *  
     186                 * @param       thread  タイムアウトしたスレッド 
     187                 * @private 
     188                 */ 
    150189                private function timeoutHandler(thread:Thread):void 
    151190                { 
    …… 
    170209                } 
    171210                 
     211                /** 
     212                 * @inheritDoc 
     213                 */ 
    172214                public function leave(thread:Thread):void 
    173215                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/Thread.as

    r633 r637  
    167167                 
    168168                /** 
    169                  * initialize メソッドの呼び出しによって IThreadExecutor が設定され、スレッドが実行可能な状態かどうかを返します. 
    170                  *  
    171                  * @return      スレッドが実行可能な状態であれば true、そうでなければ false 
     169                 * initialize メソッドの呼び出しによって IThreadExecutor が設定され、スレッドが実行可能な状態であれば true、そうでなければ false を返します. 
     170                 *  
    172171                 * @see #initialize() 
    173172                 */ 

  • as3/Thread/branches/soumen/src/org/libspark/thread/ThreadState.as

    r535 r637  
    2929{ 
    3030        /** 
    31          * スレッドの状態です。スレッドは特定の時点でひとつの状態しか取れません。 
     31         * ThreadState クラスは、スレッドの状態を表す定数を定義します. 
     32         *  
     33         * <p>スレッドの状態は state プロパティで知ることができます。スレッドは特定の時点でひとつの状態しか取れません。</p> 
    3234         *  
    3335         * @author      yossy:beinteractive 
     36         * @see Thread#state 
    3437         */ 
    3538        public class ThreadState 
    …… 
    4144                 
    4245                /** 
    43                  * 実行可能なスレッドの状態(実行フェーズ)です 
     46                 * 実行可能なスレッド (実行フェーズ) の状態です 
    4447                 */ 
    4548                public static const RUNNABLE:uint      = 1; 
    …… 
    5659                 
    5760                /** 
    58                  * 終了処理中のスレッドの状態(終了フェーズ)です 
     61                 * 終了処理中のスレッド (終了フェーズ) の状態です 
    5962                 */ 
    6063                public static const TERMINATING:uint   = 4; 

  • as3/Thread/branches/soumen/src/org/libspark/thread/errors/CurrentThreadNotFoundError.as

    r535 r637  
    2929{ 
    3030        /** 
     31         * CurrentThreadNotFoundError 例外は、カレントスレッドが必要とされる場面でカレントスレッドが見つからない (null の場合) にスローされます. 
     32         *  
    3133         * @author      yossy:beinteractive 
    3234         */ 
    3335        public class CurrentThreadNotFoundError extends Error 
    3436        { 
     37                /** 
     38                 * 新しい CurrentThreadNotFoundError クラスのインスタンスを作成します. 
     39                 *  
     40                 * @param       message エラーメッセージ 
     41                 * @param       id      エラー識別子 
     42                 */ 
    3543                public function CurrentThreadNotFoundError(message:String = '', id:int = 0) 
    3644                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/errors/IllegalThreadStateError.as

    r535 r637  
    2929{ 
    3030        /** 
     31         * IllegalThreadStateError 例外は、スレッドの状態が不正な場合にスローされます. 
     32         *  
    3133         * @author      yossy:beinteractive 
    3234         */ 
    3335        public class IllegalThreadStateError extends Error 
    3436        { 
     37                /** 
     38                 * 新しい IllegalThreadStateError クラスのインスタンスを作成します. 
     39                 *  
     40                 * @param       message エラーメッセージ 
     41                 * @param       id      エラー識別子 
     42                 */ 
    3543                public function IllegalThreadStateError(message:String = '', id:int = 0) 
    3644                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/errors/InterruptedError.as

    r535 r637  
    1 /* 
     1/* 
    22 * ActionScript Thread Library 
    33 *  
    …… 
    2929{ 
    3030        /** 
     31         * InterruptedError 例外は、スレッドが待機中に割り込まれ、かつ割り込みハンドラが設定されていない場合にスローされます. 
     32         *  
    3133         * @author      yossy:beinteractive 
    3234         */ 
    3335        public class InterruptedError extends Error 
    3436        { 
     37                /** 
     38                 * 新しい InterruptedError クラスのインスタンスを作成します. 
     39                 *  
     40                 * @param       message エラーメッセージ 
     41                 * @param       id      エラー識別子 
     42                 */ 
    3543                public function InterruptedError(message:String = '', id:int = 0) 
    3644                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/errors/ThreadLibraryNotInitializedError.as

    r632 r637  
    2929{ 
    3030        /** 
     31         * ThreadLibraryNotInitializedError 例外は、 Thread Library が初期化されていない状態でスレッドを実行しようするとスローされます. 
     32         *  
    3133         * @author      yossy:beinteractive 
    3234         */ 
    3335        public class ThreadLibraryNotInitializedError extends Error 
    3436        { 
     37                /** 
     38                 * 新しい ThreadLibraryNotInitializedError クラスのインスタンスを作成します. 
     39                 *  
     40                 * @param       message エラーメッセージ 
     41                 * @param       id      エラー識別子 
     42                 */ 
    3543                public function ThreadLibraryNotInitializedError(message:String = '', id:int = 0) 
    3644                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/threads/display/LoaderThread.as

    r548 r637  
    4242 
    4343        /** 
    44          * Loader を用いてファイルを読み込むためのスレッドです 
    45          * </p> 
    46          * このスレッドを start すると、与えられた URLRequest と LoaderContext を用いてロード処理を開始し、 
    47          * ロードが完了 （Event.COMPLETE） するとスレッドが終了します。 
    48          * </p> 
    49          * join メソッドを用いると、簡単にロード待ちをすることが出来ます。 
    50          * </p> 
    51          * ロード中にエラーが発生した場合は、以下の例外がスローされます。 
    52          * これからの例外は、このスレッドを start したスレッド （親スレッド） で捕捉することができます。 
    53          * </p> 
    54          * flash.events.IOErrorEvent.IO_ERROR: flash.errors.IOError 
     44         * Loader を用いてファイルを読み込むためのスレッドです. 
     45         *  
     46         * <p>このスレッドを start すると、与えられた URLRequest と LoaderContext を用いてロード処理を開始し、 
     47         * ロードが完了 （Event.COMPLETE） するとスレッドが終了します。</p> 
     48         *  
     49         * <p>join メソッドを用いると、簡単にロード待ちをすることが出来ます。</p> 
     50         *  
     51         * <p>ロード中にエラーが発生した場合は、以下の例外がスローされます。 
     52         * これからの例外は、このスレッドを start したスレッド （親スレッド） で捕捉することができます。</p> 
     53         *  
     54         * <ul> 
     55         * <li>flash.events.IOErrorEvent.IO_ERROR: flash.errors.IOError</li> 
     56         * </ul> 
    5557         *  
    5658         * @author      yossy:beinteractive 
    …… 
    5961        { 
    6062                /** 
    61                  * 新しい LoaderThread クラスのインスタンスを生成します 
     63                 * 新しい LoaderThread クラスのインスタンスを生成します. 
    6264                 *  
    6365                 * @param request ロード対象となる URLRequest 
    …… 
    7981                 
    8082                /** 
    81                  * ロード対象となる URLRequest を返します 
    82                  *  
    83                  * @return ロード対象となる URLRequest 
     83                 * ロード対象となる URLRequest を返します. 
    8484                 */ 
    8585                public function get request():URLRequest 
    …… 
    8989                 
    9090                /** 
    91                  * ロードに用いる LoaderContext を返します 
    92                  * 
    93                  * @return ロードに用いる LoaderContext 
     91                 * ロードに用いる LoaderContext を返します. 
    9492                 */ 
    9593                public function get context():LoaderContext 
    …… 
    9997                 
    10098                /** 
    101                  * ロードに使用する Loader を返します 
    102                  * </p> 
    103                  * ロード完了 （スレッド終了） 後に、ロードしたファイル （Loader.content） を取得したい場合などに 
    104                  * このプロパティを使用します。 
    105                  * 
    106                  * @return ロードに使用する Loader 
     99                 * ロードに使用する Loader を返します. 
     100                 *  
     101                 * <p>ロード完了 （スレッド終了） 後に、ロードしたファイル （Loader.content） を取得したい場合などに 
     102                 * このプロパティを使用します。</p> 
    107103                 */ 
    108104                public function get loader():Loader 
    …… 
    120116                 
    121117                /** 
    122                  * 実行 
    123                  *  
    124118                 * @throws SecurityError 
     119                 * @private 
    125120                 */ 
    126121                override protected function run():void  
    …… 
    163158                /** 
    164159                 * ProgressEvent.PROGRESS ハンドラ 
     160                 *  
     161                 * @private 
    165162                 */ 
    166163                private function progressHandler(e:ProgressEvent):void 
    …… 
    181178                /** 
    182179                 * Event.COMPLETE ハンドラ 
     180                 *  
     181                 * @private 
    183182                 */ 
    184183                private function completeHandler(e:Event):void 
    …… 
    195194                /** 
    196195                 * IOErrorEvent.IO_ERROR ハンドラ 
     196                 *  
     197                 * @private 
    197198                 */ 
    198199                private function ioErrorHandler(e:IOErrorEvent):void 
    …… 
    210211                /** 
    211212                 * 割り込みハンドラ 
     213                 *  
     214                 * @private 
    212215                 */ 
    213216                private function interruptedHandler():void 

  • as3/Thread/branches/soumen/src/org/libspark/thread/threads/frocessing/Frocessing2DThread.as

    r621 r637  
    3434 
    3535        /** 
    36          * Forcessing を実行するためのスレッドです 
     36         * Forcessing を実行するためのスレッドです. 
     37         *  
     38         * <p>描画には F5Graphics2D クラスが使用されます。</p> 
    3739         *  
    3840         * @author      yossy:beinteractive 
    …… 
    4042        public class Frocessing2DThread extends Thread 
    4143        { 
     44                /** 
     45                 * 新しい Frocessing2DThread クラスのインスタンスを作成します. 
     46                 *  
     47                 * @param       target  描画先となる Graphics 
     48                 */ 
    4249                public function Frocessing2DThread(target:Graphics) 
    4350                { 
    …… 
    4754                private var _fg:F5Graphics2D; 
    4855                 
     56                /** 
     57                 * 描画をするための F5Graphics2D 
     58                 */ 
    4959                protected function get fg():F5Graphics2D 
    5060                { 
    …… 
    5262                } 
    5363                 
     64                /** 
     65                 * @private 
     66                 */ 
    5467                override protected function run():void 
    5568                { 
    …… 
    5871                } 
    5972                 
     73                /** 
     74                 * @private 
     75                 */ 
    6076                private function doDraw():void 
    6177                { 
    …… 
    6783                } 
    6884                 
     85                /** 
     86                 * このメソッドをオーバーライドして初期化処理を記述します. 
     87                 */ 
    6988                protected function setup():void 
    7089                { 
    …… 
    7291                } 
    7392                 
     93                /** 
     94                 * このメソッドをオーバーライドして描画処理を記述します. 
     95                 */ 
    7496                protected function draw():void 
    7597                { 

  • as3/Thread/branches/soumen/src/org/libspark/thread/threads/frocessing/Frocessing3DThread.as

    r601 r637  
    3434 
    3535        /** 
    36          * Forcessing を実行するためのスレッドです 
     36         * Forcessing を実行するためのスレッドです. 
     37         *  
     38         * <p>描画には F5Graphics3D クラスが使用されます。</p> 
    3739         *  
    3840         * @author      yossy:beinteractive 
    …… 
    4042        public class Frocessing3DThread extends Thread 
    4143        { 
     44                /** 
     45                 * 新しい Frocessing3DThread クラスのインスタンスを作成します. 
     46                 *  
     47                 * @param       target  描画先となる Graphics 
     48                 */ 
    4249                public function Frocessing3DThread(target:Graphics) 
    4350                { 
    …… 
    4754                private var _fg:F5Graphics3D; 
    4855                 
     56                /** 
     57                 * 描画をするための F5Graphics3D 
     58                 */ 
    4959                protected function get fg():F5Graphics3D 
    5060                { 
    …… 
    5262                } 
    5363                 
    &nb