Skip to content

Commit 0c7ad0d

Browse files
Update Javadoc for libcobj/call (#789)
* doc: update Javadoc for libcobj/call * doc: update Javadoc for CobolResolve.isActive() * doc: apply Claude review
1 parent 2c2ca16 commit 0c7ad0d

3 files changed

Lines changed: 181 additions & 168 deletions

File tree

libcobj/app/src/main/java/jp/osscons/opensourcecobol/libcobj/call/CobolResolve.java

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,8 @@ private static void setPackagePath(String path) {
317317
* @param runner CobolRunnableを実装したクラス。nullでもよい。
318318
* @return runnerがnullでない場合はrunnerを返し、そうでないときはクラス名とパッケージ名を元に検索処理を実施する。
319319
* 検索して動的にクラスの読み込みに成功したら、それを返す。検索に失敗したら nullを返す。
320-
* @throws CobolRuntimeException TODO: 準備中
320+
* @throws CobolRuntimeException runnerがnullの場合に、委譲先の {@link #resolve(String, String)}
321+
* で指定されたプログラム名に対応するクラスが見つからない場合にスローされる
321322
*/
322323
public static CobolRunnable resolve(
323324
String packageName, AbstractCobolField cobolField, CobolRunnable runner)
@@ -341,7 +342,8 @@ public static CobolRunnable resolve(
341342
* @param runner CobolRunnableを実装したクラス。nullでもよい。
342343
* @return runnerがnullでない場合はrunnerを返し、そうでないときはクラス名とパッケージ名を元に検索処理を実施する。
343344
* 検索して動的にクラスの読み込みに成功したら、それを返す。検索に失敗したら nullを返す。
344-
* @throws CobolRuntimeException TODO: 準備中
345+
* @throws CobolRuntimeException runnerがnullの場合に、委譲先の {@link #resolve(String, String)}
346+
* で指定されたプログラム名に対応するクラスが見つからない場合にスローされる
345347
*/
346348
public static CobolRunnable resolve(String packageName, String name, CobolRunnable runner)
347349
throws CobolRuntimeException {
@@ -362,7 +364,7 @@ public static CobolRunnable resolve(String packageName, String name, CobolRunnab
362364
* @param packageName パッケージ名
363365
* @param cobolField 読み込むクラスの名前
364366
* @return クラス名とパッケージ名を元に検索処理を実施する。 検索して動的にクラスの読み込みに成功したら、それを返す。検索に失敗したら nullを返す。
365-
* @throws CobolRuntimeException TODO: 準備中
367+
* @throws CobolRuntimeException 指定されたプログラム名に対応するクラスが見つからない場合にスローされる
366368
*/
367369
public static CobolRunnable resolve(String packageName, AbstractCobolField cobolField)
368370
throws CobolRuntimeException {
@@ -379,7 +381,7 @@ public static CobolRunnable resolve(String packageName, AbstractCobolField cobol
379381
* @param packageName パッケージ名
380382
* @param name 読み込むクラスの名前
381383
* @return クラス名とパッケージ名を元に検索処理を実施する。 検索して動的にクラスの読み込みに成功したら、それを返す。検索に失敗したら nullを返す。
382-
* @throws CobolRuntimeException TODO: 準備中
384+
* @throws CobolRuntimeException 指定されたプログラム名に対応するクラスが見つからない場合にスローされる
383385
*/
384386
public static CobolRunnable resolve(String packageName, String name)
385387
throws CobolRuntimeException {
@@ -464,6 +466,7 @@ private static CobolRunnable getInstance(String name) {
464466
* 引数で与えられたプログラム名に対応するCobolRunnableのインスタンスの cancelメソッドを呼び出す
465467
*
466468
* @param cobolField プログラム名を示すCOBOL変数
469+
* @throws CobolRuntimeException 委譲先の {@link #cancel(String)} でプログラム名がnullの場合にスローされる
467470
*/
468471
public static void cancel(AbstractCobolField cobolField) {
469472
cancel(cobolField.getString());
@@ -473,6 +476,7 @@ public static void cancel(AbstractCobolField cobolField) {
473476
* 引数で与えられたプログラム名に対応するCobolRunnableのインスタンスの cancelメソッドを呼び出す
474477
*
475478
* @param name プログラム名
479+
* @throws CobolRuntimeException プログラム名がnullの場合にスローされる
476480
*/
477481
public static void cancel(String name) {
478482
if (name == null) {
@@ -491,7 +495,7 @@ public static void cancel(String name) {
491495
* 指定のプログラムのcancelメソッドを呼び出す
492496
*
493497
* @param f cancelを呼び出すプログラム名を示すCOBOL変数
494-
* @throws CobolStopRunException TODO: 準備中
498+
* @throws CobolStopRunException プログラム名がnullまたは空文字列の場合にスローされる
495499
*/
496500
public static void fieldCancel(AbstractCobolField f) throws CobolStopRunException {
497501
CobolResolve.cobCancel(f.fieldToString());
@@ -501,7 +505,7 @@ public static void fieldCancel(AbstractCobolField f) throws CobolStopRunExceptio
501505
* 指定のプログラムのcancelメソッドを呼び出す
502506
*
503507
* @param name プログラム名
504-
* @throws CobolStopRunException TODO: 準備中
508+
* @throws CobolStopRunException プログラム名がnullまたは空文字列の場合にスローされる
505509
*/
506510
public static void cobCancel(String name) throws CobolStopRunException {
507511
if (name == null || name.equals("")) {

libcobj/app/src/main/java/jp/osscons/opensourcecobol/libcobj/call/CobolRunnable.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,10 @@ public interface CobolRunnable {
3434
void cancel();
3535

3636
/**
37-
* 取り扱いについては準備中
37+
* プログラムがCANCEL可能でない状態かどうかを返す。 {@link CobolResolve#cancel(String)}
38+
* から呼び出され、falseの場合にCANCEL処理が実行される。
3839
*
39-
* @return 準備中
40+
* @return プログラムが実行中などでCANCELできない場合はtrue、CANCEL可能な場合はfalse
4041
*/
4142
boolean isActive();
4243
}

0 commit comments

Comments
 (0)