Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

[r8583]: docs / trunk / rexxref / en-US / utilityclasses.xml Maximize Restore History

Download this file

utilityclasses.xml    6872 lines (6139 with data), 253.4 kB

   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
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "rexxref.ent">
%BOOK_ENTITIES;
]>
<!--#########################################################################
#
# Description: Open Object Rexx: Reference XML File
#
# Copyright (c) 2005-2012, Rexx Language Association. All rights reserved.
# Portions Copyright (c) 2004, IBM Corporation. All rights reserved.
#
# This program and the accompanying materials are made available under
# the terms of the Common Public License v1.0 which accompanies this
# distribution. A copy is also available at the following address:
# http://www.oorexx.org/license.html
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the distribution.
#
# Neither the name of Rexx Language Association nor the names
# of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
# TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
#########################################################################
-->
<section id="miscclasses"><title>The Utility Classes</title>
<para>This section describes the Rexx utility classes.</para>
<section id="clsDateTime"><title>The DateTime Class</title>
<indexterm><primary>DateTime class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>DateTime class</secondary></indexterm>
<para>A DateTime object represents a point in between 1 January 0001 at 00:00.000000
and 31 December 9999 at 23:59:59.999999. A DateTime object has methods to allow
formatting a date or time in various formats, as well as allowing arithmetic operations between
dates.
</para>
<figure><title>The DateTime class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxDateTimeClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The DateTime class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparable class (<xref linkend="clsComparable" />.</para>
<itemizedlist>
<listitem><para>compareTo (<xref linkend="mthComparableCompareTo" />)</para></listitem>
</itemizedlist>
<para>Methods inherited from the
Orderable class (<xref linkend="clsObject" />).</para>
<xi:include href="orderableclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthDateTimeMinDate"><title>minDate (Class Method)</title>
<indexterm><primary>minDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>minDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-minDate-----------------------------------------------------><
]]>
</programlisting>
<para>Returns a DateTime instance representing the minimum supported Rexx date,
1 January 0001 at 00:00:00.000000.
</para>
</section>
<section id="mthDateTimeMaxDate"><title>maxDate (Class Method)</title>
<indexterm><primary>maxDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>maxDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-maxDate-----------------------------------------------------><
]]>
</programlisting>
<para>Returns a DateTime instance representing the maximum supported Rexx date,
31 December 9999 at 23:59:59.999999.
</para>
</section>
<section id="mthDateTimeToday"><title>today (Class Method)</title>
<indexterm><primary>today method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>today method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-today-------------------------------------------------------><
]]>
</programlisting>
<para>Returns a DateTime instance for the current day, with a time value of 00:00:00.000000.
</para>
</section>
<section id="mthDateTimeFromNormalDate"><title>fromNormalDate (Class Method)</title>
<indexterm><primary>fromNormalDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromNormalDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromNormalDate(-date-+------------------------------+-)-------------><
+-,-+-----------+--+---------+-+
+-separator-+ +-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Normal option
of the Date() (<xref linkend="bifDate" />) built-in function.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the string. The separator must be a single character
or the null string (""). A blank (" ") is the default separator.</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromEuropeanDate"><title>fromEuropeanDate (Class Method)</title>
<indexterm><primary>fromEuropeanDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromEuropeanDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromEuropeanDate(-date-+------------------------------+--)------------><
+-,-+-----------+--+---------+-+
+-separator-+ +-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the European option
of the Date() (<xref linkend="bifDate" />) built-in function.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the string. The separator must be a single character
or the null string (""). A slash ("/") is the default separator.
The time component will be set to the beginning of the input day (00:00:00.000000).
</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromOrderedDate"><title>fromOrderedDate (Class Method)</title>
<indexterm><primary>fromOrderedDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromOrderedDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromOrderedDate(-date-+------------------------------+--)------------><
+-,-+-----------+--+---------+-+
+-separator-+ +-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Ordered option
of the Date() (<xref linkend="bifDate" />) built-in function.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the string. The separator must be a single character
or the null string (""). A slash ("/") is the default separator.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromStandardDate"><title>fromStandardDate (Class Method)</title>
<indexterm><primary>fromStandardDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromStandardDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromStandardDate(-date-+------------------------------+--)------------><
+-,-+-----------+--+---------+-+
+-separator-+ +-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Standard option
of the Date() (<xref linkend="bifDate" />) built-in function.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the string. The separator must be a single character
or the null string (""). A null string ("") is the default separator.</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromUsaDate"><title>fromUsaDate (Class Method)</title>
<indexterm><primary>fromUsaDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromUsaDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromUsaDate(-date-+------------------------------+--)------------><
+-,-+-----------+--+---------+-+
+-separator-+ +-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Usa option
of the Date() (<xref linkend="bifDate" />) built-in function.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the string. The separator must be a single character
or the null string (""). A slash ("/") is the default separator.</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromNormalTime"><title>fromNormalTime (Class Method)</title>
<indexterm><primary>fromNormalTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromNormalTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromNormalTime(time--+---------+-)------------------------><
+-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Normal option
of the Time() (<xref linkend="bifTime" /> built-in function.
The date component will be set to 1 January 0001.</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromCivilTime"><title>fromCivilTime (Class Method)</title>
<indexterm><primary>fromCivilTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromCivilTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromCivilTime(time--+---------+-)------------------------><
+-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Civil option
of the Time() (<xref linkend="bifTime" />) built-in function.
The date component will be set to 1 January 0001.</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromLongTime"><title>fromLongTime (Class Method)</title>
<indexterm><primary>fromLongTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromLongTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromLongTime(time--+---------+-)------------------------><
+-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Long option
of the Time() (<xref linkend="bifTime" />) built-in function.
The date component will be set to 1 January 0001.</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromBaseDate"><title>fromBaseDate (Class Method)</title>
<indexterm><primary>fromBaseDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromBaseDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromBaseDate(date--+---------+-)-------------------------------><
+-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Basedate option
of the Date() (<xref linkend="bifDate" />) built-in function.
The time component will be set to the beginning of the input day (00:00:00.000000).</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromTicks"><title>fromTicks (Class Method)</title>
<indexterm><primary>fromTicks method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromTicks method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromTicks(time--+---------+-)--------------------------><
+-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string returned by the Ticks option
of the Date() (<xref linkend="bifDate" />) or
Time() (<xref linkend="bifTime" />) built-in functions.
</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromIsoDate"><title>fromIsoDate (Class Method)</title>
<indexterm><primary>fromIsoDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromIsoDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromIsoDate(date--+---------+-)------------------------><
+-,offset-+
]]>
</programlisting>
<para>Creates a DateTime object from a string in ISO date format
(yyyy-mm-ddThh:mm:ss.uuuuuu). The DateTime string method returns
the ISO format as the string form of a DateTime object.
</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
</section>
<section id="mthDateTimeFromUTCIsoDate"><title>fromUTCIsoDate (Class Method)</title>
<indexterm><primary>fromUTCIsoDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromUTCIsoDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromUTCIsoDate(date)--------------------------------------><
]]>
</programlisting>
<para>Creates a DateTime object from a string in ISO timezone qualified date
format (yyyy-mm-ddThh:mm:ss.uuuuuu+hhmm). The DateTime string method returns
the ISO format as the string form of a DateTime object.
</para>
</section>
<section id="mthDateTimeInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init--------------------------------------------------------><
>>-init(fullDate--+---------+-)-------------------------------><
+-,offset-+
>>-init(year,month,day-+---------+--------------------------------)----><
+-,offset-+
>>-init(year,month,day,hours,minutes,seconds--+--------------------------------+-)-><
+-,-+--------------+-+---------+-+
+-microseconds-+ +-,offset-+
]]>
</programlisting>
<para>Initializes a new DateTime instance. If no arguments are specified,
the DateTime instance is set to the current date and time. If the single
<emphasis role="italic">fullDate</emphasis> argument is used, the DateTime
argument is initialized to the date and time calculated by adding
<emphasis role="italic">fullDate</emphasis> microseconds to 0001-01-01T00:00:00.000000.
If the
<emphasis role="italic">year</emphasis>,
<emphasis role="italic">month</emphasis>, <emphasis role="italic">day</emphasis>,
form is used, the DateTime instance is initialized to 00:00:00.000000 on the
indicated date. Otherwise, the DateTime instance is initialized to the
<emphasis role="italic">year</emphasis>,
<emphasis role="italic">month</emphasis>, <emphasis role="italic">day</emphasis>,
<emphasis role="italic">hours</emphasis>, <emphasis role="italic">minutes</emphasis>,
<emphasis role="italic">seconds</emphasis>, and <emphasis role="italic">microseconds</emphasis>
components. Each of these components must be a valid whole number within the acceptable range for the given
component. For example, <emphasis role="italic">year</emphasis> must be in the range 1-9999, while
<emphasis role="italic">minutes</emphasis> must be in the range 0-59.
</para>
<para>
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> is the current system offset timezone offset.
</para>
<example>
<title>Class DATETIME</title>
<programlisting>
<![CDATA[
today = .DateTime~new -- initializes to current date and time
-- initializes to 9 Sep 2007 at 00:00:00.000000
day = .DateTime~new(date('F', "20070930", "S"))
-- also initializes to 9 Sep 2007 at 00:00:00.000000
day = .DateTime~new(2007, 9, 30)
-- initializes to 9 Sep 2007 at 10:33:00.000000
day = .DateTime~new(2007, 9, 30, 10, 33, 00)
]]>
</programlisting>
</example>
</section>
<section id="mthDateTimeArithmeticMethods"><title>Arithmetic Methods</title>
<indexterm><primary>method</primary>
<secondary>arithmetic methods</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-arithmetic_operator(argument)-------------------------------><
]]>
</programlisting>
<note><title>Note</title>
<para>For the prefix + operators, omit the parentheses
and <emphasis role="italic">argument</emphasis>.</para></note>
<para>Returns the result of performing the specified arithmetic operation on
the receiver DateTime object. Depending on the operation, the
<emphasis role="italic">argument</emphasis> be either a TimeSpan object or a DateTime
object. See the description of the individual operations for details.
The
<emphasis role="italic">arithmetic_operator</emphasis> can be:
</para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>+
<indexterm><primary>+ method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>+</secondary></indexterm>
</entry>
<entry><para>Addition. Adds a TimeSpan to the DateTime object, returning a new DateTime
instance. The receiver DateTime object is not changed. The TimeSpan may be either positive or negative.
</para></entry></row>
<row><entry>-
<indexterm><primary>- method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>-</secondary></indexterm>
</entry>
<entry><para>Subtraction. If <emphasis role="italic">argument</emphasis> is a DateTime
object, the two times are subtracted, and a TimeSpan object representing the interval between the
two times is returned. If the receiver DateTime is less than the <emphasis role="italic">argument</emphasis>
argument DateTime, a negative TimeSpan interval is returned. The receiver DateTime object is not changed.</para>
<para>If <emphasis role="italic">argument</emphasis> is a TimeSpan object, subtracts the TimeSpan
from the DateTime object, returning a new DateTime
instance. The receiver DateTime object is not changed. The TimeSpan may be either positive or negative.
</para></entry></row>
<row><entry>Prefix -
<indexterm><primary>method</primary>
<secondary>prefix -</secondary></indexterm>
</entry>
<entry><para>A prefix - operation on a DateTime object will raise a SYNTAX error condition.
</para></entry></row>
<row><entry>Prefix +
<indexterm><primary>method</primary>
<secondary>prefix +</secondary></indexterm>
</entry>
<entry><para>Returns a new instance of the DateTime object with the same time value.
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
<indexterm><primary>examples</primary>
<secondary>arithmetic methods of DateTime class</secondary></indexterm>
<example>
<title>Class DATETIME - arithmetic</title>
<programlisting>
<![CDATA[
t = .dateTime~new~timeOfDay -- returns TimeSpan for current time.
say t -- displays "11:27:12.437000", perhaps
d = .dateTime~new(2010, 4, 11) -- creates new date
future = d + t -- adds timespan to d
say future -- displays "2010-04-11T11:27:12.437000"
-- "real" start of next century
nextCentury = .dateTime~new(2101, 1, 1)
-- displays "34060.12:25:49.922000", perhaps
say "The next century starts in" (nextCentury - .dateTime~new)
]]>
</programlisting>
</example>
</section>
<section id="mthDateTimeCompareTo"><title>compareTo</title>
<indexterm><primary>compareTo method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compareTo method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compareTo(other)------------------------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">other</emphasis> is larger than the receiving
object, "0" if the two objects are equal, and "1" if <emphasis role="italic">other</emphasis> is
smaller than the receiving object.</para>
</section>
<section id="mthDateTimeYear"><title>year</title>
<indexterm><primary>year method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>year method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-year------------------------------------------------><
]]>
</programlisting>
<para>
Returns the year represented by this DateTime instance.
</para>
</section>
<section id="mthDateTimeMonth"><title>month</title>
<indexterm><primary>month method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>month method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-month------------------------------------------------><
]]>
</programlisting>
<para>
Returns the month represented by this DateTime instance.
</para>
</section>
<section id="mthDateTimeDay"><title>day</title>
<indexterm><primary>day method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>day method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-day------------------------------------------------><
]]>
</programlisting>
<para>
Returns the day represented by this DateTime instance.
</para>
</section>
<section id="mthDateTimeHours"><title>hours</title>
<indexterm><primary>hours method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>hours method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-hours----------------------------------------------><
]]>
</programlisting>
<para>
Returns number of whole hours since midnight.
</para>
</section>
<section id="mthDateTimeMinutes"><title>minutes</title>
<indexterm><primary>minutes method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>minutes method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-minutes--------------------------------------------><
]]>
</programlisting>
<para>
Returns minutes portion of the timestamp time-of-day.
</para>
</section>
<section id="mthDateTimeSeconds"><title>seconds</title>
<indexterm><primary>seconds method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>seconds method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-seconds--------------------------------------------><
]]>
</programlisting>
<para>
Returns seconds portion of the timestamp time-of-day.
</para>
</section>
<section id="mthDateTimeMicroseconds"><title>microseconds</title>
<indexterm><primary>microseconds method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>microseconds method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-microseconds-----------------------------------------><
]]>
</programlisting>
<para>
Returns microseconds portion of the timestamp time-of-day.
</para>
</section>
<section id="mthDateTimeDayMinutes"><title>dayMinutes</title>
<indexterm><primary>dayMinutes method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>dayMinutes method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-dayMinutes-------------------------------------------><
]]>
</programlisting>
<para>
Returns the number of minutes since midnight in the time-of-day.
</para>
</section>
<section id="mthDateTimeDaySeconds"><title>daySeconds</title>
<indexterm><primary>daySeconds method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>daySeconds method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-daySeconds-------------------------------------------><
]]>
</programlisting>
<para>
Returns the number of seconds since midnight in the time-of-day.
</para>
</section>
<section id="mthDateTimeDayMicroseconds"><title>dayMicroseconds</title>
<indexterm><primary>dayMicroseconds method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>dayMicroseconds method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-dayMicroseconds-------------------------------------------><
]]>
</programlisting>
<para>
Returns the number of microseconds since midnight in the time-of-day.
</para>
</section>
<section id="mthDateTimeHashCode"><title>hashCode</title>
<indexterm><primary>hashCode method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>hashCode method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-hashCode---------------------------------------------------><
]]>
</programlisting>
<para>Returns a string value that is used as a hash value for a MapCollection
such as Table, Relation, Set, Bag, and Directory.
</para>
</section>
<section id="mthDateTimeAddYears"><title>addYears</title>
<indexterm><primary>addYears method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addYears method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addYears(years)--------------------------------------------><
]]>
</programlisting>
<para>Add a number of years to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">years</emphasis> value must be a valid whole number. Negative values
result in years being subtracted from the DateTime value.
</para>
<para>The addYears method will take leap years into account. If the addition result would fall on February 29th of
a non-leap year, the day will be rolled back to the 28th.
</para>
<example>
<title>Class DATETIME - addYears method</title>
<programlisting>
<![CDATA[
date = .DateTime~new(2008, 2, 29)
say date -- Displays "2008-02-29T00:00:00.000000"
say date~addYears(1) -- Displays "2009-02-29T00:00:00.000000"
]]>
</programlisting>
</example>
</section>
<section id="mthDateTimeAddWeeks"><title>addWeeks</title>
<indexterm><primary>addWeeks method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addWeeks method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addWeeks(weeks)------------------------------------------><
]]>
</programlisting>
<para>Adds weeks to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">weeks</emphasis> value must be a valid number, including
fractional values.
Negative values
result in week being subtracted from the DateTime value.
</para>
</section>
<section id="mthDateTimeAddDays"><title>addDays</title>
<indexterm><primary>addDays method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addDays method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addDays(days)--------------------------------------------><
]]>
</programlisting>
<para>Adds days to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">days</emphasis> value must be a valid number, including
fractional values.
Negative values
result in days being subtracted from the DateTime value.
</para>
<example>
<title>Class DATETIME - addDays method</title>
<programlisting>
<![CDATA[
date = .DateTime~new(2008, 2, 29)
say date -- Displays "2008-02-29T00:00:00.000000"
say date~addDays(1.5) -- Displays "2008-03-01T12:00:00.000000"
]]>
</programlisting>
</example>
</section>
<section id="mthDateTimeAddHours"><title>addHours</title>
<indexterm><primary>addHours method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addHours method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addHours(hours)------------------------------------------><
]]>
</programlisting>
<para>Adds hours to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">hours</emphasis> value must be a valid number, including
fractional values.
Negative values
result in hours being subtracted from the DateTime value.
</para>
</section>
<section id="mthDateTimeAddMinutes"><title>addMinutes</title>
<indexterm><primary>addMinutes method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addMinutes method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addMinutes(minutes)--------------------------------------><
]]>
</programlisting>
<para>Adds minutes to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">minutes</emphasis> value must be a valid number, including
fractional values.
Negative values
result in minutes being subtracted from the DateTime value.
</para>
</section>
<section id="mthDateTimeAddSeconds"><title>addSeconds</title>
<indexterm><primary>addSeconds method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addSeconds method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addSeconds(seconds)--------------------------------------><
]]>
</programlisting>
<para>Adds seconds to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">seconds</emphasis> value must be a valid number, including
fractional values.
Negative values
result in seconds being subtracted from the DateTime value.
</para>
</section>
<section id="mthDateTimeAddMicroseconds"><title>addMicroseconds</title>
<indexterm><primary>addMicroseconds method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addMicroseconds method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addMicroseconds(microseconds)----------------------------><
]]>
</programlisting>
<para>Adds microseconds to the DateTime object, returning a new DateTime instance.
The receiver DateTime object is unchanged.
The <emphasis role="italic">microseconds</emphasis> value must be a valid whole number.
Negative values
result in microseconds being subtracted from the DateTime value.
</para>
</section>
<section id="mthDateTimeIsoDate"><title>isoDate</title>
<indexterm><primary>isoDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isoDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isoDate--------------------------------------------------><
]]>
</programlisting>
<para>Returns a String formatted into ISO date format, yyyy-mm-ddThh:mm:ss.uuuuuu.
</para>
</section>
<section id="mthDateTimeUTCIsoDate"><title>utcIsoDate</title>
<indexterm><primary>utcIsoDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>utcIsoDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-utcIsoDate-----------------------------------------------><
]]>
</programlisting>
<para>Returns a String formatted into a fully qualified ISO date format. If the
timezone offiset is 0, the format is yyyy-mm-ddThh:mm:ss.uuuuuuZ. If the offset
is positive, the date is formatted as yyyy-mm-ddThh:mm:ss.uuuuuu+hhmm. If the
offset is negative, the result will be in the format
yyyy-mm-ddThh:mm:ss.uuuuuu-hhmm.
</para>
</section>
<section id="mthDateTimeBaseDate"><title>baseDate</title>
<indexterm><primary>baseDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>baseDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-baseDate-------------------------------------------------><
]]>
</programlisting>
<para>
Returns the number of complete days (that is, not including the
current day) since and including the base date, 1 January 0001, in the format:
<emphasis role="italic">dddddd</emphasis> (no leading zeros or whitespace
characters).
</para>
<para>The base date of 1 January 0001 is determined
by extending the current Gregorian calendar backward (365 days each year,
with an extra day every year that is divisible by 4 except century years that
are not divisible by 400. It does not take into account any errors in the calendar
system that created the Gregorian calendar originally.</para>
</section>
<section id="mthDateTimeYearDay"><title>yearDay</title>
<indexterm><primary>yearDay method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>yearDay method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-yearDay--------------------------------------------------><
]]>
</programlisting>
<para>Returns the number of days, including the current day, that have passed
in the DateTime year in the format <emphasis role="italic">ddd</emphasis>
(no leading zeros or blanks).
</para>
</section>
<section id="mthDateTimeWeekDay"><title>weekDay</title>
<indexterm><primary>weekDay method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>weekDay method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-weekDay--------------------------------------------------><
]]>
</programlisting>
<para>Returns the day of the week, as an integer. The values returned use the
ISO convention for day numbering. Monday is "1", Tuesday is "2", running
through "7" for Sunday.
</para>
</section>
<section id="mthDateTimeEuropeanDate"><title>europeanDate</title>
<indexterm><primary>europeanDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>europeanDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-europeanDate(-+-----------+-)-------------------------------><
+-separator-+
]]>
</programlisting>
<para>Returns the date in the format <emphasis role="italic">dd/mm/yy</emphasis>.
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the returned date.
The separator must be a single character
or the null string (""). A slash ("/") is the default separator.
</para>
</section>
<section id="mthDateTimeLanguageDate"><title>languageDate</title>
<indexterm><primary>languageDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>languageDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-languageDate---------------------------------------------><
]]>
</programlisting>
<para>Returns the date in an implementation- and language-dependent, or local,
date format. The format is <emphasis role="italic">dd month yyyy</emphasis>.
The name of the month is according to the national language installed on the
system. If no local date format is available, the default format is returned.
<note><title>Note</title>
<para>This
format is intended to be used as a whole; Rexx programs must not make any
assumptions about the form or content of the returned string.</para></note>
</para>
</section>
<section id="mthDateTimeMonthName"><title>monthName</title>
<indexterm><primary>monthName method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>monthName method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-monthName------------------------------------------------><
]]>
</programlisting>
<para>
Returns the name of the DateTime month, in English.
</para>
</section>
<section id="mthDateTimeDayName"><title>dayName</title>
<indexterm><primary>dayName method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>dayName method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-dayName------------------------------------------------><
]]>
</programlisting>
<para>
Returns the name of the DateTime day, in English.
</para>
</section>
<section id="mthDateTimeNormalDate"><title>normalDate</title>
<indexterm><primary>normalDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>normalDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-normalDate(-+-----------+-)-------------------------------><
+-separator-+
]]>
</programlisting>
<para>Returns the date in the format <emphasis role="italic">dd mon yyyy</emphasis>.
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the returned date.
The separator must be a single character
or the null string (""). A blank (" ") is the default separator.
</para>
</section>
<section id="mthDateTimeOrderedDate"><title>orderedDate</title>
<indexterm><primary>orderedDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>orderedDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-orderedDate(-+-----------+-)-------------------------------><
+-separator-+
]]>
</programlisting>
<para>Returns the date in the format <emphasis role="italic">yy/mm/dd</emphasis>.
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the returned date.
The separator must be a single character
or the null string (""). A slash ("/") is the default separator.
</para>
</section>
<section id="mthDateTimeStandardDate"><title>standardDate</title>
<indexterm><primary>standardDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>standardDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-standardDate(-+-----------+-)-------------------------------><
+-separator-+
]]>
</programlisting>
<para>Returns the date in the format <emphasis role="italic">yyyymmdd</emphasis>.
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the returned date.
The separator must be a single character
or the null string (""). A null string ("") is the default separator.
</para>
</section>
<section id="mthDateTimeUsaDate"><title>usaDate</title>
<indexterm><primary>usaDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>usaDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-usaDate(-+-----------+-)-------------------------------><
+-separator-+
]]>
</programlisting>
<para>Returns the date in the format <emphasis role="italic">mm/dd/yy</emphasis>.
If specified, <emphasis role="italic">separator</emphasis>
identifies the field separator character used in the returned date.
The separator must be a single character
or the null string (""). A slash ("/") is the default separator.
</para>
</section>
<section id="mthDateTimeCivilTime"><title>civilTime</title>
<indexterm><primary>civilTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>civilTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-civilTime-----------------------------------------------><
]]>
</programlisting>
<para>Returns the time in Civil format <emphasis role="italic">hh:mmxx</emphasis>.
The hours can take
the values <computeroutput>1</computeroutput> through
<computeroutput>12</computeroutput>, and the minutes the values
<computeroutput>00</computeroutput> through <computeroutput>59</computeroutput>.
The minutes are followed immediately by the letters
<computeroutput>am</computeroutput> or <computeroutput>pm</computeroutput>.
This distinguishes times in the morning (12 midnight through 11:59
a.m.--appearing as <computeroutput>12:00am</computeroutput> through
<computeroutput>11:59am</computeroutput>) from noon and afternoon (12 noon
through 11:59 p.m.--appearing as <computeroutput>12:00pm</computeroutput>
through <computeroutput>11:59pm</computeroutput>). The hour has no leading
zero. The minute field shows the current minute (rather than the nearest
minute) for consistency with other TIME results.
</para>
</section>
<section id="mthDateTimeNormalTime"><title>normalTime</title>
<indexterm><primary>normalTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>normalTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-normalTime-----------------------------------------------><
]]>
</programlisting>
<para>Returns the time in the default format <emphasis role="italic">hh:mm:ss</emphasis>.
The hours
can have the values <computeroutput>00</computeroutput> through
<computeroutput>23</computeroutput>, and minutes and seconds,
<computeroutput>00</computeroutput> through <computeroutput>59</computeroutput>.
There are always two digits. Any fractions
of seconds are ignored (times are never rounded). This is the default.
</para>
</section>
<section id="mthDateTimeLongTime"><title>longTime</title>
<indexterm><primary>longTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>longTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-longTime-----------------------------------------------><
]]>
</programlisting>
<para>Returns time in the format <emphasis role="italic">hh:mm:ss.uuuuuu</emphasis>
(where <emphasis role="italic">uuuuuu</emphasis> are microseconds).
</para>
</section>
<section id="mthDateTimeFullDate"><title>fullDate</title>
<indexterm><primary>fullDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fullDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fullDate-----------------------------------------------><
]]>
</programlisting>
<para>Returns the number of microseconds
since 00:00:00.000000 on 1 January 0001, in the format:
<emphasis role="italic">dddddddddddddddddd</emphasis> (no leading zeros or blanks).
</para>
</section>
<section id="mthDateTimeUtcDate"><title>utcDate</title>
<indexterm><primary>utcDate method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>utcDate method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-utcDate-----------------------------------------------><
]]>
</programlisting>
<para>Returns the date converted to UTC time as the number of microseconds
since 00:00:00.000000 on 1 January 0001, in the format:
<emphasis role="italic">dddddddddddddddddd</emphasis> (no leading zeros or blanks).
</para>
</section>
<section id="mthDateTimeToLocalTime"><title>toLocalTime</title>
<indexterm><primary>toLocalTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>toLocalTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-toLocalTime-------------------------------------------><
]]>
</programlisting>
<para>Returns a new DateTime object representing the time for the local timezone.
</para>
</section>
<section id="mthDateTimeToUtcTime"><title>toUtcTime</title>
<indexterm><primary>toUtcTime method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>toUtcTime method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-toUtcTime-------------------------------------------><
]]>
</programlisting>
<para>Returns a new DateTime object representing the time for the UTC timezone (offset 0).
</para>
</section>
<section id="mthDateTimeToTimeZone"><title>toTimeZone</title>
<indexterm><primary>toTimeZone method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>toTimeZone method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-toTimeZone(-+--------+-)------------------------------><
+-offset-+
]]>
</programlisting>
<para>Returns a new DateTime object representing the time for the timezone
indicated by <emphasis role="italic">offset</emphasis>.
If specified, <emphasis role="italic">offset</emphasis> is the offset from UTC,
in minutes. The <emphasis role="italic">offset</emphasis> must be valid whole
number value. The default <emphasis role="italic">offset</emphasis> 0, which
creates a DateTime object for UTC.
</para>
</section>
<section id="mthDateTimeTicks"><title>ticks</title>
<indexterm><primary>ticks method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>ticks method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-ticks--------------------------------------------------><
]]>
</programlisting>
<para>returns the number of seconds
since 00:00:00.000000 on 1 January 1970, in the format:
<emphasis role="italic">dddddddddddd</emphasis> (no leading zeros or blanks).
Times prior to 1 January 1970 are returned as a negative value.
</para>
</section>
<section id="mthDateTimeOffset"><title>offset</title>
<indexterm><primary>offset method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>offset method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-offset-------------------------------------------------><
]]>
</programlisting>
<para>Returns the timezone for the DateTime instance as the offset in minutes
from UTC. Timezones east of UTC will return a positive offset. Timezones west
of UTC will return a negative offset.
</para>
</section>
<section id="mthDateTimeDate"><title>date</title>
<indexterm><primary>date method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>date method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-date---------------------------------------------------><
]]>
</programlisting>
<para>Returns a new DateTime object instance for the current date, with
the time component set to 00:00:00.000000.
</para>
</section>
<section id="mthDateTimeTimeOfDay"><title>timeOfDay</title>
<indexterm><primary>timeOfDay method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>timeOfDay method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-timeOfDay-----------------------------------------------><
]]>
</programlisting>
<para>Returns the interval since 00:00:00.000000 of the current day
as a TimeSpan object.
</para>
</section>
<section id="mthDateTimeElapsed"><title>elapsed</title>
<indexterm><primary>elapsed method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>elapsed method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-elapsed-------------------------------------------------><
]]>
</programlisting>
<para>Returns the difference between current time and the receiver DateTime
as a TimeSpan object. The TimeSpan will be negative if the receiver DateTime
represents a time in the future.
</para>
</section>
<section id="mthDateTimeIsLeapyear"><title>isLeapyear</title>
<indexterm><primary>isLeapyear method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isLeapyear method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isLeapyear---------------------------------------------><
]]>
</programlisting>
<para>Returns true ("1") if the current year is leap year. Returns false
("0") if the current year is not a leap year.
</para>
</section>
<section id="mthDateTimeDaysInMonth"><title>daysInMonth</title>
<indexterm><primary>daysInMonth method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>daysInMonth method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-daysInMonth--------------------------------------------><
]]>
</programlisting>
<para>Returns the number of days in the current month. For example, for dates in
January, 31 is returned. The daysInMonth method takes leap years into account, returning
28 days for February in non-leap years, and 29 days for leap years.
</para>
</section>
<section id="mthDateTimeDaysInYear"><title>daysInYear</title>
<indexterm><primary>daysInYear method</primary>
<secondary>of DateTime class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>daysInYear method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-daysInYear---------------------------------------------><
]]>
</programlisting>
<para>Returns the number of days in the current year. For leap years, 366 is returned.
For non-leap years, this returns 365.
</para>
</section>
<section id="mthDateTimeString"><title>string</title>
<indexterm><primary>string method</primary>
<secondary>of daysInMonth class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>string method</secondary>
<tertiary>of DateTime class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-string-------------------------------------------------><
]]>
</programlisting>
<para>Returns DateTime formatted as a string. The string value is returned in ISO format.
</para>
</section>
</section>
<section id="clsAlarm"><title>The Alarm Class</title>
<indexterm><primary>Alarm class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Alarm class</secondary></indexterm>
<para>An alarm object provides timing and
notification capability by supplying a facility to send any message to any
object at a given time. You can cancel an alarm before it sends its message.
</para>
<figure><title>The Alarm class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxAlarmClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The Alarm class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthAlarmCancel"><title>cancel</title>
<indexterm><primary>cancel method</primary>
<secondary>of Alarm class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>cancel method</secondary>
<tertiary>of Alarm class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-cancel------------------------------------------------------><
]]>
</programlisting>
<para>Cancels the pending alarm request represented by the receiver. This method
takes no action if the specified time has already been reached.</para>
</section>
<section id="mthAlarmInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of Alarm class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of Alarm class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(atime,message)-----------------------------------------><
]]>
</programlisting>
<para>Sets up an alarm for a future time
<emphasis role="italic">atime</emphasis>. At this time, the alarm
object sends the message that <emphasis role="italic">message</emphasis>,
a message object, specifies. (See <xref linkend="clsMessage" />.)
The <emphasis role="italic">atime</emphasis> can a String, DateTime object, or TimeSpan object.
</para>
<para>If <emphasis role="italic">atime</emphasis> is a DateTime object, the DateTime specifies a
time when the alarm will be triggered. The DateTime must be greater than the current time.</para>
<para>If <emphasis role="italic">atime</emphasis> is a TimeSpan, the Alarm will be set to the current
time plus the TimeSpan. The TimeSpan must not be a negative interval.</para>
<para>If <emphasis role="italic">atime</emphasis> is a String,
you can specify
this as a date and time (<computeroutput>&apos;hh:mm:ss&apos;</computeroutput>) or as
a number of seconds
starting at the present time. If you use the date and time format, you can specify
a date in the default format (<computeroutput>&apos;dd Mmm yyyy&apos;</computeroutput>)
after the time with a single blank separating the time and date. Leading and
trailing whitespace characters are not allowed in the
<emphasis role="italic">atime</emphasis>. If you do not
specify a date, the Alarm uses the first future occurrence of the
specified time. You can use the cancel()
method to cancel a pending alarm. See
<xref linkend="creo" /> for more information.</para>
<para>The following code sets up an alarm at 5:10 p.m. on December 15, 2007.
(Assume today's date/time is prior to December 15, 2007.) </para>
<indexterm><primary>examples</primary>
<secondary>of Alarm class</secondary></indexterm>
<example>
<title>Class ALARM</title>
<programlisting>
/* Alarm Examples */
PersonalMessage=.MyMessageClass~new("Call the Bank")
msg=.message~new(PersonalMessage,"RemindMe")
time = .DateTime~fromIsoDate("2007-12-15T17:10:00.000000")
a=.alarm~new(time, msg)
exit
::class MyMessageClass public
::method init
expose inmsg
use arg inmsg
::method RemindMe
expose inmsg
say "It is now" "TIME"("C")".Please "inmsg
/* On the specified data and time, displays the following message: */
/* "It is now 5:10pm. Please Call the Bank" */
</programlisting>
</example>
<para>For the following example, the user uses the same code as in the
preceding example to define <computeroutput>msg</computeroutput>,
a message object to run at the specified time. The following code sets up
an alarm to run the <computeroutput>msg</computeroutput> message
object in 30 seconds from the current time: </para>
<example>
<title>Class ALARM</title>
<programlisting>
a=.alarm~new(30,msg)
</programlisting>
</example>
</section>
</section>
<section id="clsTimeSpan"><title>The TimeSpan Class</title>
<indexterm><primary>TimeSpan class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>TimeSpan class</secondary></indexterm>
<para>A TimeSpan object represents a point in between 1 January 0001 at 00:00.000000
and 31 December 9999 at 23:59:59.999999. A TimeSpan object has methods to allow
formatting a date or time in various formats, as well as allowing arithmetic operations between
dates.
</para>
<figure><title>The TimeSpan class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxTimeSpanClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The TimeSpan class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparable class (<xref linkend="clsComparable" />).</para>
<itemizedlist>
<listitem><para>compareTo (<xref linkend="mthComparableCompareTo" />)</para></listitem>
</itemizedlist>
<para>Methods inherited from the
Orderable class (<xref linkend="clsObject" />).</para>
<xi:include href="orderableclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthTimeSpanFromDays"><title>fromDays (Class Method)</title>
<indexterm><primary>fromDays method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromDays method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromDays(days)--------------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a number of days.
The <emphasis role="italic">days</emphasis> argument must be a valid Rexx number.
</para>
</section>
<section id="mthTimeSpanFromHours"><title>fromHours (Class Method)</title>
<indexterm><primary>fromHours method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromHours method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromHours(hours)------------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a number of hours.
The <emphasis role="italic">hours</emphasis> argument must be a valid Rexx number.
</para>
</section>
<section id="mthTimeSpanFromMinutes"><title>fromMinutes (Class Method)</title>
<indexterm><primary>fromMinutes method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromMinutes method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromMinutes(minutes)--------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a number of minutes.
The <emphasis role="italic">minutes</emphasis> argument must be a valid Rexx number.
</para>
</section>
<section id="mthTimeSpanFromSeconds"><title>fromSeconds (Class Method)</title>
<indexterm><primary>fromSeconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromSeconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromSeconds(seconds)--------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a number of seconds.
The <emphasis role="italic">seconds</emphasis> argument must be a valid Rexx number.
</para>
</section>
<section id="mthTimeSpanFromMicroseconds"><title>fromMicroseconds (Class Method)</title>
<indexterm><primary>fromMicroseconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromMicroseconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromMicroseconds(microseconds)---------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a number of microseconds.
The <emphasis role="italic">microseconds</emphasis> argument must be a valid Rexx number.
</para>
</section>
<section id="mthTimeSpanFromNormalTime"><title>fromNormalTime (Class Method)</title>
<indexterm><primary>fromNormalTime method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromNormalTime method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromNormalTime(time)----------------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a string returned by the Normal option
of the Time() (<xref linkend="bifTime" />) built-in function.
The TimeSpan will contain an interval equal to the time of day represented by the string.
</para>
</section>
<section id="mthTimeSpanFromCivilTime"><title>fromCivilTime (Class Method)</title>
<indexterm><primary>fromCivilTime method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromCivilTime method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromCivilTime(time)----------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a string returned by the Civil option
of the Time() (<xref linkend="bifTime" />) built-in function.
The TimeSpan will contain an interval equal to the time of day represented by the string.
</para>
</section>
<section id="mthTimeSpanFromLongTime"><title>fromLongTime (Class Method)</title>
<indexterm><primary>fromLongTime method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromLongTime method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromLongTime(time)----------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a string returned by the Long option
of the Time() (<xref linkend="bifTime" />) built-in function.
The TimeSpan will contain an interval equal to the time of day represented by the string.
</para>
</section>
<section id="mthTimeSpanFromStringFormat"><title>fromStringFormat (Class Method)</title>
<indexterm><primary>fromStringFormat method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fromStringFormat method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fromStringFormat(time)------------------------------------><
]]>
</programlisting>
<para>Creates a TimeSpan object from a string in the format returned by the TimeSpan string method.
</para>
</section>
<section id="mthTimeSpanInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(fullDate)---------------------------------------------><
>>-init(hours, minutes, seconds)------------------------------><
>>-init(day, hours, minutes, second, microseconds)------------><
]]>
</programlisting>
<para>Initializes a new TimeSpan instance.
If the single
<emphasis role="italic">fullDate</emphasis> argument is used, the TimeSpan
argument is initialized to the time span
<emphasis role="italic">fullDate</emphasis> microseconds.
Otherwise, the TimeSpan instance is initialized to either the <emphasis role="italic">hours</emphasis>,
<emphasis role="italic">minutes</emphasis>, and <emphasis role="italic">seconds</emphasis> or the
<emphasis role="italic">days</emphasis>, <emphasis role="italic">hours</emphasis>,
<emphasis role="italic">minutes</emphasis>,
<emphasis role="italic">seconds</emphasis>, and <emphasis role="italic">microseconds</emphasis>
components. Each of these components must be a valid whole number within the acceptable range for the given
component. For example, <emphasis role="italic">hours</emphasis> must be in the range 0-23, while
<emphasis role="italic">minutes</emphasis> must be in the range 0-59.
</para>
<example>
<title>Class TIMESPAN</title>
<programlisting>
<![CDATA[
-- initializes to 15 hours, 37 minutes and 30 seconds
-- (15:37:30.000000)
span = .TimeSpan~new(time('F', "15:37:30", "N))
-- also initializes to 15:37:30.000000
span = .TimeSpan~new(15, 37, 30)
-- initializes to 6.04:33:15.000100
span = .TimeSpan~new(6, 4, 33, 15, 100)
]]>
</programlisting>
</example>
</section>
<section id="mthTimeSpanArithmeticMethods"><title>Arithmetic Methods</title>
<indexterm><primary>method</primary>
<secondary>arithmetic methods</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-arithmetic_operator(argument)-------------------------------><
]]>
</programlisting>
<note><title>Note</title>
<para>For the prefix + operators, omit the parentheses
and <emphasis role="italic">argument</emphasis>.</para></note>
<para>Returns the result of performing the specified arithmetic operation on
the receiver TimeSpan object. Depending on the operation, the
<emphasis role="italic">argument</emphasis> be either a TimeSpan object, a DateTime
object, or a number. See the description of the individual operations for details.
The
<emphasis role="italic">arithmetic_operator</emphasis> can be:
</para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>+
<indexterm><primary>+ method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>+</secondary></indexterm>
</entry>
<entry><para>Addition.
If <emphasis role="italic">argument</emphasis> is a DateTime object, the TimeSpan
is added to the DateTime object, returning a new DateTime
instance.
Neither the receiver TimeSpan or the argument DateTime object is altered
by this operation.
The TimeSpan may be either positive or negative.</para>
<para>If <emphasis role="italic">argument</emphasis> is a TimeSpan object, the
two TimeSpans are added together, and a new TimeSpan instance is returned.
Neither the TimeSpan object is altered
by this operation.
</para></entry></row>
<row><entry>-
<indexterm><primary>- method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>-</secondary></indexterm>
</entry>
<entry><para>Subtraction.
The <emphasis role="italic">argument</emphasis> must be a TimeSpan object. The
<emphasis role="italic">argument</emphasis> TimeSpan is subtracted from the receiver
TimeSpan and a new TimeSpan instance is returned.
Neither the TimeSpan object is altered
by this operation.
</para></entry></row>
<row><entry>*
<indexterm><primary>* method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>*</secondary></indexterm>
</entry>
<entry><para>Multiplication.
The <emphasis role="italic">argument</emphasis> must be a valid Rexx number. The
TimeSpan is multiplied by the
<emphasis role="italic">argument</emphasis> value,
and a new TimeSpan instance is returned.
The receiver TimeSpan object is not altered
by this operation.
</para></entry></row>
<row><entry>/
<indexterm><primary>/ method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>/</secondary></indexterm>
</entry>
<entry><para>Division.
The <emphasis role="italic">argument</emphasis> must be a valid Rexx number. The
TimeSpan is divided by the
<emphasis role="italic">argument</emphasis> value,
and a new TimeSpan instance is returned.
The receiver TimeSpan object is not altered
by this operation. The / operator and % produce the same result.
</para></entry></row>
<row><entry>%
<indexterm><primary>% method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>%</secondary></indexterm>
</entry>
<entry><para>Integer Division.
The <emphasis role="italic">argument</emphasis> must be a valid Rexx number. The
TimeSpan is divided by the
<emphasis role="italic">argument</emphasis> value,
and a new TimeSpan instance is returned.
The receiver TimeSpan object is not altered
by this operation. The / operator and % produce the same result.
</para></entry></row>
<row><entry>//
<indexterm><primary>// method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>//</secondary></indexterm>
</entry>
<entry><para>Remainder Division.
The <emphasis role="italic">argument</emphasis> must be a valid Rexx number. The
TimeSpan is divided by the
<emphasis role="italic">argument</emphasis> value and the division remainder is
returned as a new TimeSpan instance.
The receiver TimeSpan object is not altered
by this operation.
</para></entry></row>
<row><entry>Prefix -
<indexterm><primary>method</primary>
<secondary>prefix -</secondary></indexterm>
</entry>
<entry><para>The TimeSpan is negated, returning a new TimeSpan instance. The receiver TimeSpan
is not altered by this operation.
</para></entry></row>
<row><entry>Prefix +
<indexterm><primary>method</primary>
<secondary>prefix +</secondary></indexterm>
</entry>
<entry><para>Returns a new instance of the TimeSpan object with the same time value.
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
<indexterm><primary>examples</primary>
<secondary>arithmetic methods of DateTime class</secondary></indexterm>
<example>
<title>Class TIMESPAN</title>
<programlisting>
<![CDATA[
t1 = .timespan~fromHours(1)
t2 = t1 * 2
-- displays "01:00:00.000000 02:00:00.000000 03:00:00.000000"
say t1 t2 (t1 + t2)
]]>
</programlisting>
</example>
</section>
<section id="mthTimeSpanCompareTo"><title>compareTo</title>
<indexterm><primary>compareTo method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compareTo method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compareTo(other)------------------------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">other</emphasis> is larger than the receiving
object, "0" if the two objects are equal, and "1" if <emphasis role="italic">other</emphasis> is
smaller than the receiving object.</para>
</section>
<section id="mthTimeSpanDuration"><title>duration</title>
<indexterm><primary>duration method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>duration method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-duration--------------------------------------------------------><
]]>
</programlisting>
<para>Returns a new TimeSpan object containing the absolute value of the receiver TimeSpan object.
</para>
</section>
<section id="mthTimeSpanDays"><title>days</title>
<indexterm><primary>days method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>days method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-days------------------------------------------------------------><
]]>
</programlisting>
<para>Returns the number of whole days in the TimeSpan, as a positive number.
</para>
</section>
<section id="mthTimeSpanHours"><title>hours</title>
<indexterm><primary>hours method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>hours method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-hours-----------------------------------------------------------><
]]>
</programlisting>
<para>Returns the hours component of the TimeSpan, as a positive number.
</para>
</section>
<section id="mthTimeSpanMinutes"><title>minutes</title>
<indexterm><primary>minutes method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>minutes method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-minutes---------------------------------------------------------><
]]>
</programlisting>
<para>Returns the minutes component of the TimeSpan, as a positive number.
</para>
</section>
<section id="mthTimeSpanSeconds"><title>seconds</title>
<indexterm><primary>seconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>seconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-seconds---------------------------------------------------------><
]]>
</programlisting>
<para>Returns the seconds component of the TimeSpan, as a positive number.
</para>
</section>
<section id="mthTimeSpanMicroseconds"><title>microseconds</title>
<indexterm><primary>microseconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>microseconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-microseconds--------------------------------------------------><
]]>
</programlisting>
<para>Returns the microseconds component of the TimeSpan, as a positive number.
</para>
</section>
<section id="mthTimeSpanTotalDays"><title>totalDays</title>
<indexterm><primary>totalDays method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>totalDays method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-totalDays-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the time span expressed as a number of days. The result includes any
fractional part and retains the sign of the receiver TimeSpan.
</para>
</section>
<section id="mthTimeSpanTotalHours"><title>totalHours</title>
<indexterm><primary>totalHours method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>totalHours method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-totalHours------------------------------------------------------><
]]>
</programlisting>
<para>Returns the time span expressed as a number of hours. The result includes any
fractional part and retains the sign of the receiver TimeSpan.
</para>
</section>
<section id="mthTimeSpanTotalMinutes"><title>totalMinutes</title>
<indexterm><primary>totalMinutes method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>totalMinutes method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-totalMinutes----------------------------------------------------><
]]>
</programlisting>
<para>Returns the time span expressed as a number of minutes. The result includes any
fractional part and retains the sign of the receiver TimeSpan.
</para>
</section>
<section id="mthTimeSpanTotalSeconds"><title>totalSeconds</title>
<indexterm><primary>totalSeconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>totalSeconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-totalSeconds----------------------------------------------------><
]]>
</programlisting>
<para>Returns the time span expressed as a number of seconds. The result includes any
fractional part and retains the sign of the receiver TimeSpan.
</para>
</section>
<section id="mthTimeSpanTotalMicroseconds"><title>totalMicroseconds</title>
<indexterm><primary>totalMicroseconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>totalMicroseconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-totalMicroseconds-----------------------------------------------><
]]>
</programlisting>
<para>Returns the time span expressed as a number of microseconds. The result
retains the sign of the receiver TimeSpan.
</para>
</section>
<section id="mthTimeSpanHashCode"><title>hashCode</title>
<indexterm><primary>hashCode method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>hashCode method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-hashCode---------------------------------------------------><
]]>
</programlisting>
<para>Returns a string value that is used as a hash value for MapCollection
such as Table, Relation, Set, Bag, and Directory.
</para>
</section>
<section id="mthTimeSpanAddWeeks"><title>addWeeks</title>
<indexterm><primary>addWeeks method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addWeeks method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addWeeks(weeks)------------------------------------------><
]]>
</programlisting>
<para>Adds weeks to the TimeSpan object, returning a new TimeSpan instance.
The receiver TimeSpan object is unchanged.
The <emphasis role="italic">weeks</emphasis> value must be a valid number, including
fractional values.
Negative values
result in week being subtracted from the TimeSpan value.
</para>
</section>
<section id="mthTimeSpanAddDays"><title>addDays</title>
<indexterm><primary>addDays method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addDays method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addDays(days)--------------------------------------------><
]]>
</programlisting>
<para>Adds days to the TimeSpan object, returning a new TimeSpan instance.
The receiver TimeSpan object is unchanged.
The <emphasis role="italic">days</emphasis> value must be a valid number, including
fractional values.
Negative values
result in days being subtracted from the TimeSpan value.
</para>
</section>
<section id="mthTimeSpanAddHours"><title>addHours</title>
<indexterm><primary>addHours method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addHours method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addHours(hours)------------------------------------------><
]]>
</programlisting>
<para>Adds hours to the TimeSpan object, returning a new TimeSpan instance.
The receiver TimeSpan object is unchanged.
The <emphasis role="italic">hours</emphasis> value must be a valid number, including
fractional values.
Negative values
result in hours being subtracted from the TimeSpan value.
</para>
</section>
<section id="mthTimeSpanAddMinutes"><title>addMinutes</title>
<indexterm><primary>addMinutes method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addMinutes method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addMinutes(minutes)--------------------------------------><
]]>
</programlisting>
<para>Adds minutes to the TimeSpan object, returning a new TimeSpan instance.
The receiver TimeSpan object is unchanged.
The <emphasis role="italic">minutes</emphasis> value must be a valid number, including
fractional values.
Negative values
result in minutes being subtracted from the TimeSpan value.
</para>
</section>
<section id="mthTimeSpanAddSeconds"><title>addSeconds</title>
<indexterm><primary>addSeconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addSeconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addSeconds(seconds)--------------------------------------><
]]>
</programlisting>
<para>Adds seconds to the TimeSpan object, returning a new TimeSpan instance.
The receiver TimeSpan object is unchanged.
The <emphasis role="italic">seconds</emphasis> value must be a valid number, including
fractional values.
Negative values
result in seconds being subtracted from the TimeSpan value.
</para>
</section>
<section id="mthTimeSpanAddMicroseconds"><title>addMicroseconds</title>
<indexterm><primary>addMicroseconds method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>addMicroseconds method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-addMicroseconds(microseconds)----------------------------><
]]>
</programlisting>
<para>Adds microseconds to the TimeSpan object, returning a new TimeSpan instance.
The receiver TimeSpan object is unchanged.
The <emphasis role="italic">microseconds</emphasis> value must be a valid whole number.
Negative values
result in microseconds being subtracted from the TimeSpan value.
</para>
</section>
<section id="mthTimeSpanSign"><title>sign</title>
<indexterm><primary>sign method</primary>
<secondary>of TimeSpan class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>sign method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-sign-----------------------------------------------------><
]]>
</programlisting>
<para>Returns "-1" if the TimeSpan is negative, "1" if the TimeSpan is positive, and "0" if the
TimeSpan duration is zero.
</para>
</section>
<section id="mthTimeSpanString"><title>string</title>
<indexterm><primary>string method</primary>
<secondary>of daysInMonth class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>string method</secondary>
<tertiary>of TimeSpan class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-string-------------------------------------------------><
]]>
</programlisting>
<para>Returns TimeSpan formatted as a string. The string value is in the format
"-dddddddd.hh:mm:ss.uuuuuu". If the TimeSpan is positive or zero, the sign is omitted.
The days field will be formatted without leading zeros or blanks. If the TimeSpan duration
is less than a day, the days field and the period separator will be omitted.
</para>
</section>
</section>
<section id="clsComparable"><title>The Comparable Class</title>
<indexterm><primary>Comparable class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Comparable class</secondary></indexterm>
<para>This class is defined as a mixin class.</para>
<figure><title>The Comparable class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxComparableClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The Comparable class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthComparableCompareTo"><title>compareTo</title>
<indexterm><primary>compareTo method</primary>
<secondary>of Comparable class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compareTo method</secondary>
<tertiary>of Comparable class</tertiary></indexterm>
<para>This method compares the receiving object to the object supplied in the
<emphasis role="itakic">comparable</emphasis> argument.</para>
<programlisting>
<![CDATA[
>>-compareTo(other)---------------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">other</emphasis> is larger than the receiving
object, "0" if the two objects are equal, and "1" if <emphasis role="italic">other</emphasis> is
smaller than the receiving object.</para>
</section>
</section>
<section id="clsOrderable"><title>The Orderable Class</title>
<indexterm><primary>Orderable class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Orderable class</secondary></indexterm>
<para>The Orderable class can be inherited by classes which wish to provide
each of the comparison operator methods without needing to implement each of
the individual methods. The inheriting class need only implement the
Comparable compareTo() method (<xref linkend="mthComparableCompareTo" />).
This class is defined as a mixin class.
</para>
<figure><title>The Orderable class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxOrderableClass.png" />
</imageobject>
</mediaobject>
</figure>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthOrderableComparisonMethods"><title>Comparison Methods</title>
<indexterm><primary>method</primary>
<secondary>comparison methods</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-comparison_operator(argument)-------------------------------><
]]>
</programlisting>
<para>Returns <computeroutput>1</computeroutput> (true) or
<computeroutput>0</computeroutput> (false), the result of performing
the specified comparison operation. The receiver object and the
<emphasis role="italic">argument</emphasis> are the terms compared.
</para>
<para>The comparison operators you can use in a message are: </para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>=
<indexterm><primary>= method</primary>
<secondary>of Orderable class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>=</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
</entry>
<entry><para>True if the terms are equal
</para></entry></row>
<row><entry>\=, &gt;&lt;, &lt;&gt;
<indexterm><primary>>&lt; method</primary>
<secondary>of Orderable class</secondary></indexterm>
<indexterm><primary>&gt;&lt; method</primary>
<secondary>of Orderable class</secondary></indexterm>
<indexterm><primary>&lt;&gt; method</primary>
<secondary>of Orderable class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>\=</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
<indexterm><primary>method</primary>
<secondary>>&lt;</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
<indexterm><primary>method</primary>
<secondary>&lt;&gt;</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
</entry>
<entry><para>True if the terms are not equal (inverse of =)
</para></entry></row>
<row><entry>&gt;
<indexterm><primary>&gt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>></secondary></indexterm>
</entry>
<entry><para>Greater than
</para></entry></row>
<row><entry>&lt;
<indexterm><primary>&lt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>&lt;</secondary></indexterm>
</entry>
<entry><para>Less than
</para></entry></row>
<row><entry>&gt;=
<indexterm><primary>&gt;= method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>&gt;=</secondary></indexterm>
</entry>
<entry><para>Greater than or equal to
</para></entry></row>
<row><entry>\&lt;
<indexterm><primary>\&lt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>\&lt;</secondary></indexterm>
</entry>
<entry><para>Not less than
</para></entry></row>
<row><entry>&lt;=
<indexterm><primary>&lt;= method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>&lt;=</secondary></indexterm>
</entry>
<entry><para>Less than or equal to
</para></entry></row>
<row><entry>\&gt;
<indexterm><primary>\&gt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>\&gt;</secondary></indexterm>
</entry>
<entry><para>Not greater than
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
<para>All strict comparison operations have one of the characters doubled that
define the operator. The Orderable strict comparison operators produce the same
results as the non-strict comparisons.
</para>
<para>The strict comparison operators you can use in a message are: </para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>==
<indexterm><primary>== method</primary>
<secondary>of Orderable class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>==</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
</entry>
<entry><para>True if terms are strictly equal
</para></entry></row>
<row><entry>\==
<indexterm><primary>\== method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>\==</secondary>
<tertiary>of Orderable class</tertiary></indexterm>
</entry>
<entry><para>True if the terms are NOT strictly equal (inverse of ==)
</para></entry></row>
<row><entry>&gt;&gt;
<indexterm><primary>&gt;&gt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>>></secondary></indexterm>
</entry>
<entry><para>Strictly greater than
</para></entry></row>
<row><entry>&lt;&lt;
<indexterm><primary>&lt;&lt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>&lt;&lt;</secondary></indexterm>
</entry>
<entry><para>Strictly less than
</para></entry></row>
<row><entry>&gt;&gt;=
<indexterm><primary>&gt;&gt;= method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>&gt;&gt;=</secondary></indexterm>
</entry>
<entry><para>Strictly greater than or equal to
</para></entry></row>
<row><entry>\&lt;&lt;
<indexterm><primary>\&lt;&lt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>\&lt;&lt;</secondary></indexterm>
</entry>
<entry><para>Strictly NOT less than
</para></entry></row>
<row><entry>&lt;&lt;=
<indexterm><primary>&lt;&lt;= method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>&lt;&lt;=</secondary></indexterm>
</entry>
<entry><para>Strictly less than or equal to
</para></entry></row>
<row><entry>\&gt;&gt;
<indexterm><primary>\&gt;&gt; method</primary></indexterm>
<indexterm><primary>method</primary>
<secondary>\&gt;&gt;</secondary></indexterm>
</entry>
<entry><para>Strictly NOT greater than
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</section>
</section>
<section id="clsComparator"><title>The Comparator Class</title>
<indexterm><primary>Comparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Comparator class</secondary></indexterm>
<para>The Comparator class is the base class for implementing Comparator objects
that can be used with the Array sortWith() (<xref linkend="mthArraySortWith" />)
or stableSortWith() method (<xref linkend="mthArrayStableSortWith" />).
The compare() method implements some form of comparison that determines the relative ordering
of two objects. Many Comparator implementations are specific to particular object types.
</para>
<figure><title>The Comparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The Comparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of Comparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of Comparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis> .</para>
<para>The default Comparator compare() method assumes that <emphasis role="italic">first</emphasis>
is an object that implements the Comparable compareTo method (<xref linkend="mthComparableCompareTo" />.
Subclasses may override this to implement more specific comparisons.
</para>
</section>
</section>
<section id="clsCaselessComparator"><title>The CaselessComparator Class</title>
<indexterm><primary>CaselessComparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>CaselessComparator class</secondary></indexterm>
<para>The CaselessComparator class performs caseless orderings of String objects.</para>
<figure><title>The CaselessComparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxCaselessComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The CaselessComparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparator class (<xref linkend="clsComparator" />).</para>
<simplelist type="vert" columns="3">
<member>compare (<xref linkend="mthComparatorCompare" />)</member>
</simplelist>
</section>
<section id="mthCaselessComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of CaselessComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of CaselessComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis>. The two strings are compared using a caseless comparison.
</para>
</section>
</section>
<section id="clsColumnComparator"><title>The ColumnComparator Class</title>
<indexterm><primary>ColumnComparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>ColumnComparator class</secondary></indexterm>
<para>The ColumnComparator class performs orderings based on specific substrings of String objects.</para>
<figure><title>The ColumnComparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxColumnComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The ColumnComparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparator class (<xref linkend="clsComparator" />).</para>
<simplelist type="vert" columns="3">
<member>compare (<xref linkend="mthComparatorCompare" />)</member>
</simplelist>
</section>
<section id="mthColumnComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of ColumnComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of ColumnComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis>. Only the defined columns of the strings are compared.
</para>
</section>
<section id="mthColumnComparatorInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of ColumnComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of ColumnComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(start, length)----------------------------------><
]]>
</programlisting>
<para>Initializes a comparator to sort strings starting at position <emphasis role="italic">start</emphasis> for
<emphasis role="italic">length</emphasis> characters.
</para>
</section>
</section>
<section id="clsCaselessColumnComparator"><title>The CaselessColumnComparator Class</title>
<indexterm><primary>CaselessColumnComparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>CaselessColumnComparator class</secondary></indexterm>
<para>The CaselessColumnComparator class performs caseless orderings of specific substrings of String objects.</para>
<figure><title>The CaselessColumnComparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxCaselessColumnComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The CaselessColumnComparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparator class (<xref linkend="clsComparator" />).</para>
<simplelist type="vert" columns="3">
<member>compare (<xref linkend="mthComparatorCompare" />)</member>
</simplelist>
</section>
<section id="mthCaselessColumnComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of CaselessColumnComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of CaselessColumnComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "-1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis>. Only the defined columns of the strings are compared,
using a caseless comparison.</para>
</section>
<section id="mthCaselessColumnComparatorInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of CaselessColumnComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of CaselessColumnComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(start, length)----------------------------------><
]]>
</programlisting>
<para>Initializes a comparator to sort strings starting at position <emphasis role="italic">start</emphasis> for
<emphasis role="italic">length</emphasis> characters.
</para>
</section>
</section>
<section id="clsDescendingComparator"><title>The DescendingComparator Class</title>
<indexterm><primary>DescendingComparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>DescendingComparator class</secondary></indexterm>
<para>The DescendingComparator class performs sort orderings in descending order. This is the inverse of
a Comparator (<xref linkend="clsComparator" />) sort order.
</para>
<para>This class is defined as a mixin class. It must be used
by inheriting from it as a mixin.</para>
<figure><title>The DescendingComparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxDescendingComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The DescendingComparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparator class (<xref linkend="clsComparator" />).</para>
<simplelist type="vert" columns="3">
<member>compare (<xref linkend="mthComparatorCompare" />)</member>
</simplelist>
</section>
<section id="mthDescendingComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of DescendingComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of DescendingComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "-1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis>, resulting in a descending sort sequence.
The DescendingComparator assumes the <emphasis role="italic">first</emphasis> object implements
the Comparable compareTo method (<xref linkend="mthComparableCompareTo" />.
</para>
</section>
</section>
<section id="clsCaselessDescendingComparator"><title>The CaselessDescendingComparator Class</title>
<indexterm><primary>CaselessDescendingComparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>CaselessDescendingComparator class</secondary></indexterm>
<para>The CaselessDescendingComparator class performs caseless string sort orderings in descending order. This is the inverse of
a CaselessComparator (<xref linkend="clsCaselessComparator" />) sort order.
</para>
<figure><title>The CaselessDescendingComparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxCaselessDescendingComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The CaselessDescendingComparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparator class (<xref linkend="clsComparator" />).</para>
<simplelist type="vert" columns="3">
<member>compare (<xref linkend="mthComparatorCompare" />)</member>
</simplelist>
</section>
<section id="mthCaselessDescendingComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of CaselessDescendingComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of CaselessDescendingComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "-1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis>. The two strings are compared using a caseless comparison.
</para>
</section>
</section>
<section id="clsInvertingComparator"><title>The InvertingComparator Class</title>
<indexterm><primary>InvertingComparator class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>InvertingComparator class</secondary></indexterm>
<para>The InvertingComparator class inverts the comparison results of
another Comparator object to reverse the resulting sort order.</para>
<figure><title>The InvertingComparator class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxInvertingComparatorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The InvertingComparator class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>This class is defined as a mixin class.</para>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparator class (<xref linkend="clsComparator" />).</para>
<simplelist type="vert" columns="3">
<member>compare (<xref linkend="mthComparatorCompare" />)</member>
</simplelist>
</section>
<section id="mthInvertingComparatorCompare"><title>compare</title>
<indexterm><primary>compare method</primary>
<secondary>of InvertingComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compare method</secondary>
<tertiary>of InvertingComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compare(first,second)--------------------------------><
]]>
</programlisting>
<para>This method returns "1" if the <emphasis role="italic">second</emphasis> is larger than
<emphasis role="italic">first</emphasis>
object, "0" if the two objects are equal, and "-1" <emphasis role="italic">second</emphasis> is
smaller than <emphasis role="italic">first</emphasis>, resulting in a descending sort sequence.
The InvertingComparator will invert the ordering returned by the provided Comparator.
</para>
</section>
<section id="mthInvertingComparatorInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of InvertingComparator class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of InvertingComparator class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(comparator)----------------------------------><
]]>
</programlisting>
<para>Initializes an inverting comparator to sort strings using an inversion of the result from the
<emphasis role="italic">comparator</emphasis> compare() method.
</para>
</section>
</section>
<section id="clsMonitor"><title>The Monitor Class</title>
<indexterm><primary>Monitor class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Monitor class</secondary></indexterm>
<para>The Monitor class acts as a proxy for other objects. Messages sent to the
Monitor object are forwarded to a different target object. The message target can be
changed dynamically.
</para>
<figure><title>The Monitor class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxMonitorClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The Monitor class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthMonitorCurrent"><title>current</title>
<indexterm><primary>current method</primary>
<secondary>of Monitor class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>current method</secondary>
<tertiary>of Monitor class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-current-----------------------------------------------------><
]]>
</programlisting>
<para>Returns the current destination object.</para>
</section>
<section id="mthMonitorDestination"><title>destination</title>
<indexterm><primary>destination method</primary>
<secondary>of Monitor class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>destination method</secondary>
<tertiary>of Monitor class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-destination--+---------------+------------------------------><
+-(destination)-+
]]>
</programlisting>
<para>Returns a new destination object. If you specify
<emphasis role="italic">destination</emphasis>,
this becomes the new destination for any forwarded messages. If you omit
<emphasis role="italic">destination</emphasis>, the previous destination
object becomes the new destination for any forwarded messages.</para>
</section>
<section id="mthMonitorInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of Monitor class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of Monitor class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init--+---------------+-------------------------------------><
+-(destination)-+
]]>
</programlisting>
<para>Initializes the newly created monitor object.</para>
</section>
<section id="mthMonitorUnknown"><title>unknown</title>
<indexterm><primary>unknown method</primary>
<secondary>of Monitor class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>unknown method</secondary>
<tertiary>of Monitor class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-unknown(messagename,messageargs)----------------------------><
]]>
</programlisting>
<para>Reissues or forwards to the current monitor destination all unknown
messages sent to a monitor object. For additional information, see
<xref linkend="unkno" />.</para>
</section>
<section><title>Examples</title>
<indexterm><primary>examples</primary>
<secondary>of Monitor class</secondary></indexterm>
<example>
<title>Class MONITOR</title>
<programlisting>
.local~setentry("output",.monitor~new(.stream~new("my.new")~~command("open nobuffer")))
/* The following sets the destination */
previous_destination=.output~destination(.stream~new("my.out")~~command("open write"))
/* The following resets the destination */
.output~destination
.output~destination(.Stdout)
current_output_destination_stream_object=.output~current
</programlisting>
</example>
</section>
</section>
<section id="clsMutableBuffer"><title>The MutableBuffer Class</title>
<indexterm><primary>MutableBuffer class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>MutableBuffer class</secondary></indexterm>
<para>The MutableBuffer class is a buffer on which
certain string operations such as concatenation can be performed very
efficiently. Unlike String objects, MutableBuffers can be altered without
requiring a new object allocation. A MutableBuffer object can provide better
performance for algorithms that involve frequent concatenations to build up
longer string objects because it creates fewer intermediate objects.
</para>
<figure><title>The MutableBuffer class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxMutableBufferClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The MutableBuffer class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthMutableBufferNew"><title>new</title>
<indexterm><primary>new method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>new method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-new(-+--------+-+---------------+-)--------------------><
+-string-+ +-,-buffersize--+
]]>
</programlisting>
<para>Initialize the buffer, optionally assign a buffer content and
a starting <emphasis>buffer size</emphasis>. The default size is 256; the buffer
size increases to the length of <emphasis>string</emphasis> if the string
does not fit into the buffer.</para>
</section>
<section id="mthMutableBufferAppend"><title>append</title>
<indexterm><primary>append method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>append method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-append(string)------------------------------------------><
]]>
</programlisting>
<para>Appends <emphasis role="italic">string</emphasis> to the buffer content. The buffer size
is increased if necessary.</para>
</section>
<section id="mthMutableBufferCaselessChangeStr"><title>caselessChangeStr</title>
<indexterm><primary>caselessChangeStr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessChangeStr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-caselessChangeStr(needle,newneedle--+--------+--)---------------------------------><
+-,count-+
]]>
</programlisting>
<para>Returns the receiver MutableBuffer
<emphasis role="italic">newneedle</emphasis> replacing occurrences of <emphasis
role="italic">needle</emphasis>. If <emphasis role="italic">count</emphasis> is
not specified, all occurrences of
<emphasis role="italic">needle</emphasis> are replaced. If <emphasis role="italic">count</emphasis>
is specified, it must be a positive, whole number that gives the maximum number of
occurrences to be replaced.
The <emphasis role="italic">needle</emphasis> searches are performed
using caseless comparisons.
</para>
</section>
<section id="mthMutableBufferCaselessCountStr"><title>caselessCountStr</title>
<indexterm><primary>caselessCountStr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessCountStr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>caselessCountStr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessCountStr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-caselessCountStr(needle)--------------------------------------------><
]]>
</programlisting>
<para>Returns a count of the occurrences of
<emphasis role="italic">needle</emphasis> in the receiving MutableBuffer that
do not overlap. All matches are made using caseless comparisons.
</para>
</section>
<section id="mthMutableBufferCaselessLastPos"><title>caselessLastPos</title>
<indexterm><primary>caselessLastPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessLastPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>caselessLastPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessLastPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-caselessLastPos(needle-+---------------------------+-)---><
+-,--+-------+--+---------+-+
+-start-+ +-,length-+
]]>
</programlisting>
<para>Returns the position of the last occurrence of a string,
<emphasis role="italic">needle</emphasis>,
in the receiving buffer. (See also <xref linkend="mthMutableBufferPos" />.)
It returns <computeroutput>0</computeroutput> if
<emphasis role="italic">needle</emphasis> is the null string or not found.
By default, the search starts at the last character of the receiving buffer and
scans backward to the beginning of the string. You can override this by
specifying
<emphasis role="italic">start</emphasis>, the point at which the backward scan
starts and <emphasis role="italic">length</emphasis>, the range of characters to
scan. The
<emphasis role="italic">start</emphasis> must be a positive whole number and
defaults to <computeroutput>receiving_buffer~length</computeroutput> if larger
than that value or omitted. The <emphasis role="italic">length</emphasis> must be a
non-negative whole number and defaults to <emphasis
role="italic">start</emphasis>. The search is performed using caseless
comparisons.
</para>
</section>
<section id="mthMutableBufferCaselessMatch"><title>caselessMatch</title>
<indexterm><primary>caselessMatch method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessMatch method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>caselessMatch method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessMatch method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-caselessMatch(start,other-+----------------------------+-)-------------------><
+-,--+---+--+---------+------+
+-n-+ +-,length-+
]]>
</programlisting>
<para>Returns .true ("1") if the characters of the <emphasis role="italic">other</emphasis> match the
characters of the target buffer beginning at position <emphasis role="italic">start</emphasis>. Return .false
("0") if the characters are not a match. The matching is performed using caseless comparisons.
<emphasis role="italic">start</emphasis> must be a positive whole number less than or equal to the length of
the target buffer.
</para>
<para>If <emphasis role="italic">n</emphasis> is specified, the match will be performed starting with character
<emphasis role="italic">n</emphasis> of <emphasis role="italic">other</emphasis>. The default value for
<emphasis role="italic">n</emphasis> is "1". <emphasis role="italic">n</emphasis> must be a positive whole number
less than or equal to the length of <emphasis role="italic">other</emphasis>.
</para>
<para>If <emphasis role="italic">length</emphasis> is specified, it defines a substring of
<emphasis role="italic">other</emphasis> that is used for the match. <emphasis role="italic">length</emphasis>
must be a positive whole number and the combination of <emphasis role="italic">n</emphasis> and
<emphasis role="italic">length</emphasis> must be a valid substring within the bounds of
<emphasis role="italic">other</emphasis>.</para>
<para>The caselessMatch method is useful for efficient string parsing as it does
not require new string objects be extracted from the target string.
</para>
</section>
<section id="mthMutableBufferCaselessMatchChar"><title>caselessMatchChar</title>
<indexterm><primary>caselessMatchChar method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessMatchChar method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>caselessMatchChar method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessMatchChar method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-caselessMatchChar(n,chars)-------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the character at position <emphasis role="italic">n</emphasis> matches any
character of the string <emphasis role="italic">chars</emphasis>. Returns .false ("0") if the character does not
match any of the characters in the reference set. The match is made using caseless comparisons.
The argument <emphasis role="italic">n</emphasis> must be
a positive whole number less than or equal to the length of the target MutableBuffer.</para>
</section>
<section id="mthMutableBufferCaselessPos"><title>caselessPos</title>
<indexterm><primary>caselessPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>caselessPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>caselessPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-caselessPos(needle-+---------------------------+-)---><
+-,--+-------+--+---------+-+
+-start-+ +-,length-+
]]>
</programlisting>
<para>Returns the position in the receiving buffer of a
<emphasis role="italic">needle</emphasis> string. (See also
<xref linkend="mthMutableBufferLastPos" />.) It returns
<computeroutput>0</computeroutput> if
<emphasis role="italic">needle</emphasis> is the null string or is not found
or if <emphasis role="italic">start</emphasis> is greater than
the length of the receiving buffer. The search is performed using caseless
comparisons.
By default, the search starts at the first
character of the receiving buffer (that is, the value of
<emphasis role="italic">start</emphasis> is <computeroutput>1</computeroutput>),
and continues to the end of the buffer. You can override this by specifying
<emphasis role="italic">start
</emphasis>, the point at which the search starts, and
<emphasis role="italic">length</emphasis>, the bounding limit for the search.
If specified, <emphasis role="italic">start</emphasis> must be a positive
whole number and <emphasis role="italic">length</emphasis> must be
a non-negative whole number.
</para>
</section>
<section id="mthMutableBufferCaselessWordPos"><title>caselessWordPos</title>
<indexterm><primary>caselessWordPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>wordPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>word</primary>
<secondary>locating in a string</secondary></indexterm>
<programlisting>
<![CDATA[
>>-caselessWordPos(phrase-+--------+-)---------------------------------><
+-,start-+
]]>
</programlisting>
<para>Returns the word number of the first word of
<emphasis role="italic">phrase</emphasis> found in the receiving buffer, or
<computeroutput>0</computeroutput> if
<emphasis role="italic">phrase</emphasis> contains no words or
if <emphasis role="italic">phrase</emphasis> is not found.
Word matches are made independent of case. Multiple whitespace characters
between words in either
<emphasis role="italic">phrase</emphasis> or the receiving buffer are treated as
a single blank for the comparison, but, otherwise, the words must match
exactly.</para>
<para>By default the search starts at the first word in the receiving
string.
You can override this by specifying <emphasis
role="italic">start</emphasis>
(which must be positive),
the word at which the search is to be started.</para>
</section>
<section id="mthMutableBufferChangeStr"><title>changeStr</title>
<indexterm><primary>changeStr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>changeStr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-changeStr(needle,newneedle--+--------+--)---------------------------------><
+-,count-+
]]>
</programlisting>
<para>Returns the receiver MutableBuffer with
<emphasis role="italic">newneedle</emphasis> replacing occurrences of <emphasis
role="italic">needle</emphasis>.</para>
<para>If <emphasis role="italic">count</emphasis> is not specified, all occurrences of
<emphasis role="italic">needle</emphasis> are replaced. If <emphasis role="italic">count</emphasis>
is specified, it must be a positive, whole number that gives the maximum number of
occurrences to be replaced.</para>
</section>
<section id="mthMutableBufferCountStr"><title>countStr</title>
<indexterm><primary>countStr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>countStr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-countStr(needle)--------------------------------------------><
]]>
</programlisting>
<para>Returns a count of the occurrences of
<emphasis role="italic">needle</emphasis> in the receiving buffer that do not
overlap.</para>
</section>
<section id="mthMutableBufferDelete"><title>delete</title>
<indexterm><primary>delete method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>delete method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-delete(n---+---------+--)-------------------------------><
+-,length-+
]]>
</programlisting>
<para>Deletes <emphasis>length</emphasis> characters from the buffer beginning
at the <emphasis>n</emphasis>'th character. If length is omitted, or if length
is greater than the number of characters from <emphasis>n</emphasis> to the end
of the buffer, the method deletes the remaining buffer contents (including
the <emphasis>n</emphasis>'th character). The length must be a positive integer
or zero. The <emphasis>n</emphasis> must be a positive integer. If
<emphasis>n</emphasis> is greater than
the length of the buffer or zero, the method does not modify the
buffer content.</para>
</section>
<section id="mthMutableBufferDelstr"><title>delstr</title>
<indexterm><primary>delstr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>delstr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-delstr(n---+---------+--)-------------------------------><
+-,length-+
]]>
</programlisting>
<para>Deletes <emphasis>length</emphasis> characters from the buffer beginning
at the <emphasis>n</emphasis>'th character. If length is omitted, or if length
is greater than the number of characters from <emphasis>n</emphasis> to the end
of the buffer, the method deletes the remaining buffer contents (including
the <emphasis>n</emphasis>'th character). The length must be a positive integer
or zero. The <emphasis>n</emphasis> must be a positive integer. If
<emphasis>n</emphasis> is greater than
the length of the buffer or zero, the method does not modify the
buffer content. The delstr() method is the same as the delete() method. It
is provided for polymorphism with the String class.
</para>
</section>
<section id="mthMutableBufferDelWord"><title>delWord</title>
<indexterm><primary>delWord method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>delWord method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>deleting</primary>
<secondary>words from a mutablebuffer</secondary></indexterm>
<indexterm><primary>word</primary>
<secondary>deleting from a mutablebuffer</secondary></indexterm>
<programlisting>
<![CDATA[
>>-delWord(n--+---------+--)-----------------------------------><
+-,length-+
]]>
</programlisting>
<para>Deletes a substring from the MutableBuffer the substring that starts at the
<emphasis role="italic">n</emphasis>th word and is of
<emphasis role="italic">length</emphasis> whitespace-delimited words. If you
omit
<emphasis role="italic">length</emphasis>, or if
<emphasis role="italic">length</emphasis> is greater than
the number of words from <emphasis role="italic">n</emphasis> to the end of the
receiving bufffer, the
method deletes the remaining words in the receiving buffer (including the
<emphasis role="italic">n</emphasis>th word). The
<emphasis role="italic">length</emphasis> must be a positive whole number or
zero. The <emphasis role="italic">n</emphasis> must be a positive whole number.
If <emphasis role="italic">n</emphasis> is greater than
the number of words in the receiving buffer, the method returns the receiving
buffer unchanged. The portion deleted includes any whitespace characters
following the final word involved but none of the whitespace characters
preceding the first word involved.
</para>
</section>
<section id="mthMutableBufferGetBufferSize"><title>getBufferSize</title>
<indexterm><primary>getBufferSize method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>getBufferSizemethod</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-getBufferSize-------------------------------------------><
]]>
</programlisting>
<para>Retrieves the current buffer size.</para>
</section>
<section id="mthMutableBufferInsert"><title>insert</title>
<indexterm><primary>insert method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>insert method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-insert(new-+-----------------------------------------+--)><
+-,--+---+--+--------------------------+--+
+-n-+ +-,--+--------+--+------+--+
+-length-+ +-,pad-+
]]>
</programlisting>
<para>Inserts the string <emphasis role="italic">new</emphasis>, padded or truncated to
length <emphasis role="italic">length</emphasis>, into the mutable buffer after the
<emphasis>n</emphasis>'th character. The default
value for <emphasis role="italic">n</emphasis> is 0, which means insertion at the beginning
of the string. If specified, <emphasis role="italic">n</emphasis> and length must be
positive integers or zeros. If <emphasis role="italic">n</emphasis> is greater than the
length of the buffer contents,
the string new is padded at the beginning. The default value for
<emphasis role="italic">length</emphasis> is the length of <emphasis role="italic">new</emphasis>.
If length is less than the length of
string <emphasis role="italic">new</emphasis>,
insert truncates <emphasis role="italic">new</emphasis>
to length <emphasis role="italic">length</emphasis>. The default
<emphasis role="italic">pad</emphasis> character is a blank.</para>
</section>
<section id="mthMutableBufferLastPos"><title>lastPos</title>
<indexterm><primary>lastPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>lastPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>position</primary>
<secondary>last occurrence of a string</secondary></indexterm>
<programlisting>
<![CDATA[
>>-lastPos(needle-+--------+-)---------------------------------><
+-,start-+
]]>
</programlisting>
<para>Returns the position of the last occurrence of a string,
<emphasis role="italic">needle</emphasis>,
in the receiving buffer. (See also <xref linkend="mthMutableBufferPos" />.) It
returns <computeroutput>0</computeroutput> if
<emphasis role="italic">needle</emphasis> is the null string or not found.
By default, the search starts at the last character of the receiving buffer
and scans backward. You can override this by specifying
<emphasis role="italic">start</emphasis>, the point at which the
backward scan starts. The <emphasis role="italic">start</emphasis> must be a
positive whole number and defaults to
<computeroutput>receiving_buffer~length</computeroutput> if larger than that
value or omitted.</para>
<indexterm><primary>examples</primary>
<secondary>lastPos method</secondary></indexterm>
<example>
<title>Class MUTABLEBUGGER - lastPos method</title>
<programlisting>
x1 - .mutablebuffer~new("abc def ghi")
x1~lastPos(" ") -> 8
x1 - .mutablebuffer~new("abcdefghi")
x1~lastPos(" ") -> 0
x1 - .mutablebuffer~new("efgxyz")
x1~lastPos("xy") -> 4
x1 - .mutablebuffer~new("abc def ghi")
x1~lastPos(" ",7) -> 4
</programlisting>
</example>
</section>
<section id="mthMutableBufferLength"><title>length</title>
<indexterm><primary>length method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>length method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-length--------------------------------------------------><
]]>
</programlisting>
<para>Returns length of data in buffer.</para>
</section>
<section id="mthMutableBufferLower"><title>lower</title>
<indexterm><primary>lower method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>lower method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-lower(+---+--+---------+---)----------------------><
+-n-+ +-,length-+
]]>
</programlisting>
<para>Returns the receiving buffer with the characters of the target string
beginning with character
<emphasis role="italic">n</emphasis> for <emphasis role="italic">length</emphasis>
characters converted to lowercase. If <emphasis role="italic">n</emphasis> is specified, it must
be a positive whole number. If <emphasis role="italic">n</emphasis> is not specified, the case
conversion will start with the first character. If <emphasis role="italic">length</emphasis>
is specified, it must be a non-negative whole number. If <emphasis role="italic">length</emphasis>
the default is to convert the remainder of the buffer.</para>
</section>
<section id="mthMutableBufferMakeArray"><title>makeArray</title>
<indexterm><primary>makeArray method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>makeArray method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-makeArray(-+-----------+-)----><
+-Separator-+
]]>
</programlisting>
<para>This method returns an array of strings containing the substrings
that were separated using the separator character. The
default separator is the newline character.</para>
</section>
<section id="mthMutableBufferMatch"><title>match</title>
<indexterm><primary>match method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>match method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-match(start,other-+----------------------------+-)-------------------><
+-,--+---+--+---------+------+
+-n-+ +-,length-+
]]>
</programlisting>
<para>Returns .true ("1") if the characters of the <emphasis role="italic">other</emphasis> match the
characters of the target buffer beginning at position <emphasis role="italic">start</emphasis>. Return .false
("0") if the characters are not a match.
<emphasis role="italic">start</emphasis> must be a positive whole number less than or equal to the length of
the target buffer.
</para>
<para>If <emphasis role="italic">n</emphasis> is specified, the match will be performed starting with character
<emphasis role="italic">n</emphasis> of <emphasis role="italic">other</emphasis>. The default value for
<emphasis role="italic">n</emphasis> is "1". <emphasis role="italic">n</emphasis> must be a positive whole number
less than or equal to the length of <emphasis role="italic">other</emphasis>.
</para>
<para>If <emphasis role="italic">length</emphasis> is specified, it defines a substring of
<emphasis role="italic">other</emphasis> that is used for the match. <emphasis role="italic">length</emphasis>
must be a positive whole number and the combination of <emphasis role="italic">n</emphasis> and
<emphasis role="italic">length</emphasis> must be a valid substring within the bounds of
<emphasis role="italic">other</emphasis>.</para>
<para>The match method is useful for efficient string parsing as it does not
require new string objects be extracted from the target buffer.
</para>
</section>
<section id="mthMutableBufferMatchChar"><title>matchChar</title>
<indexterm><primary>matchChar method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>matchChar method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-matchChar(n,chars)-------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the character at position <emphasis role="italic">n</emphasis> matches any
character of the string <emphasis role="italic">chars</emphasis>. Returns .false ("0") if the character does not
match any of the characters in the reference set. The argument <emphasis role="italic">n</emphasis> must be
a positive whole number less than or equal to the length of the target
buffer.</para>
</section>
<section id="mthMutableBufferOverlay"><title>overlay</title>
<indexterm><primary>overlay method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>overlay method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-overlay(new-+-----------------------------------------+--)--><
+-,--+---+--+--------------------------+--+
+-n-+ +-,--+--------+--+------+--+
+-length-+ +-,pad-+
]]>
</programlisting>
<para>Modifies the buffer content by overlaying it, starting at the
<emphasis>n</emphasis>'th character, with the string <emphasis>new</emphasis>,
padded or truncated to length <emphasis>length</emphasis>. The overlay can extend
beyond the end of the buffer. In this case the buffer size will be increased.
If you specify <emphasis>length</emphasis>, it must be a positive integer or
zero. The default value for <emphasis>length</emphasis> is the length of
<emphasis>new</emphasis>. If <emphasis>n</emphasis> is
greater than the length of the buffer content, padding is
added before the new string. The default <emphasis>pad</emphasis> character is
a blank, and the default value for <emphasis>n</emphasis> is 1. If you specify
<emphasis>n</emphasis>, it must be a positive integer.</para>
</section>
<section id="mthMutableBufferPos"><title>pos</title>
<indexterm><primary>pos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>pos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>finding</primary>
<secondary>string in a MutableBuffer</secondary></indexterm>
<indexterm><primary>locating</primary>
<secondary>string in a MutableBuffer</secondary></indexterm>
<programlisting>
<![CDATA[
>>-pos(needle-+--------+-)-------------------------------------><
+-,start-+
]]>
</programlisting>
<para>Returns the position in the receiving buffer of another string,
<emphasis role="italic">needle</emphasis>. (See also
<xref linkend="mthMutableBufferLastPos" />.) It returns
<computeroutput>0</computeroutput> if
<emphasis role="italic">needle</emphasis> is the null string or is not found
or if <emphasis role="italic">start</emphasis> is greater than
the length of the receiving buffer. By default, the search starts at the first
character of the receiving buffer (that is, the value of
<emphasis role="italic">start</emphasis> is <computeroutput>1</computeroutput>).
You can override this by specifying <emphasis role="italic">start</emphasis>
(which must be
a positive whole number), the point at which the search starts.</para>
<indexterm><primary>examples</primary>
<secondary>pos method</secondary></indexterm>
<example>
<title>Class MUTABLEBUGGER - pos method</title>
<programlisting>
x1 = .mutablebuffer~new("Saturday")
x1~pos("day") -> 6
x1 = .mutablebuffer~new("abc def ghi")
x1~pos("x") -> 0
x1~pos(" ") -> 4
x1~pos(" ",5) -> 8
</programlisting>
</example>
</section>
<section id="mthMutableBufferReplaceAt"><title>replaceAt</title>
<indexterm><primary>replaceAt method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>replaceAt method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>replacing characters within a string</primary></indexterm>
<programlisting>
<![CDATA[
>>-replaceAt(new-,-n-,-+----------+-+-------+-)-----><
+-,-length-+ +-,-pad-+
]]>
</programlisting>
<para>Returns the receiving buffer with the characters from the
<emphasis role="italic">n</emphasis>th character for <emphasis role="italic">length</emphasis>
characters replaced with
<emphasis role="italic">new</emphasis>. The replacement position and length can
extend beyond the end of the receiving string.
The starting position, <emphasis role="italic">n</emphasis>, is required and must be a positive whole number. The
<emphasis role="italic">length</emphasis> is optional and must be a positive whole number or zero. If <emphasis
role="italic">length</emphasis> is omitted, it defaults to the length of <emphasis role="italic">new</emphasis>.
</para>
<para>
If <emphasis role="italic">n</emphasis> is greater than the length of the receiving string, padding is added
before
the <emphasis role="italic">new</emphasis> string. The default <emphasis role="italic">pad</emphasis> character is a
blank.
</para>
</section>
<section id="mthMutableBufferSetBufferSize"><title>setBufferSize</title>
<indexterm><primary>setBufferSize method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>setBufferSizemethod</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-setBufferSize(n)----------------------------------------><
]]>
</programlisting>
<para>Sets the buffer size. If <emphasis>n</emphasis>
is less than the length of buffer
content, the content is truncated. If <emphasis>n</emphasis> is 0, the entire
contents is erased and the new buffer size is the value given
in the <emphasis role="bold">init</emphasis> method.</para>
</section>
<section id="mthMutableBufferSpace"><title>space</title>
<indexterm><primary>space method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>space method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>formatting</primary>
<secondary>text spacing</secondary></indexterm>
<indexterm><primary>spacing, formatting, space method</primary></indexterm>
<programlisting>
<![CDATA[
>>-space-+---------------+-------------------------------------><
+-(n-+------+-)-+
+-,pad-+
]]>
</programlisting>
<para>Returns the target mutablebuffer, with
<emphasis role="italic">n</emphasis>&nbsp;<emphasis role="italic">pad</emphasis>
characters between each whitespace-delimited word. If you specify
<emphasis role="italic">n</emphasis>, it must
be a positive whole number or zero. If it is
<computeroutput>0</computeroutput>, all whitespace characters are removed.
Leading and trailing whitespace characters are always removed. The default for
<emphasis role="italic">n</emphasis> is <computeroutput>1</computeroutput>,
and the default <emphasis role="italic">pad</emphasis> character is a blank.
</para>
</section>
<section id="mthMutableBufferString"><title>string</title>
<indexterm><primary>string method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>string method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-string--------------------------------------------------><
]]>
</programlisting>
<para>Retrieves the content of the buffer as a string.</para>
</section>
<section id="mthMutableBufferSubchar"><title>subchar</title>
<indexterm><primary>subcharmethod</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>subchar method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-subchar(n)----------------------------------------------><
]]>
</programlisting>
<para>Returns the <emphasis>n</emphasis>'th character of the receiving
buffer. <emphasis>n</emphasis> must be a positive whole number. If
<emphasis>n</emphasis> is greater that the length of the receiving buffer
then a zero-length string is returned.</para>
</section>
<section id="mthMutableBufferSubstr"><title>substr</title>
<indexterm><primary>substr method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>substr method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-substr(n-+--------------------------+--)----------------><
+-,--+--------+--+------+--+
+-length-+ +-,pad-+
]]>
</programlisting>
<para>Returns a substring from the buffer content that begins at the
<emphasis>n</emphasis>'th character and is of length
<emphasis>length</emphasis>, padded with <emphasis>pad</emphasis> if
necessary. The <emphasis>n</emphasis> must be a positive integer. If
<emphasis>n</emphasis> is greater
than receiving_string~length, only <emphasis>pad</emphasis> characters
are returned. If you omit <emphasis>length</emphasis>, the remaining
buffer content is returned.
The default <emphasis>pad</emphasis> character is a blank.</para>
</section>
<section id="mthMutableBufferSubWord"><title>subWord</title>
<indexterm><primary>subWord method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>subWord method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>extracting words with subWord</primary></indexterm>
<indexterm><primary>word</primary>
<secondary>extracting from a string</secondary></indexterm>
<programlisting>
<![CDATA[
>>-subWord(n-+---------+-)-------------------------------------><
+-,length-+
]]>
</programlisting>
<para>Returns the substring of the receiving buffer that starts at the
<emphasis role="italic">n</emphasis>th word and is up to
<emphasis role="italic">length</emphasis> whitespace-delimited words. The
<emphasis role="italic">n</emphasis> must be a positive whole number.
If you omit <emphasis role="italic">length</emphasis>, it defaults
to the number of remaining words in the receiving buffer. The returned string
never has leading or trailing whitespace characters, but includes all whitespace
characters between the selected words.
</para>
</section>
<section id="mthMutableBufferSubWords"><title>subWords</title>
<indexterm><primary>subWords method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>subWords method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>extracting words with subWords</primary></indexterm>
<indexterm><primary>word</primary>
<secondary>extracting from a string</secondary></indexterm>
<programlisting>
<![CDATA[
>>-subWords(--+---+-+---------+-)-------------------------------------><
+-n-+ +-,length-+
]]>
</programlisting>
<para>Returns an array containing all words within the substring
of the receiving mutablebuffer that starts at the
<emphasis role="italic">n</emphasis>th word and is up to
<emphasis role="italic">length</emphasis> blank-delimited words. The
<emphasis role="italic">n</emphasis> must be a positive whole number. If you omit
<emphasis role="italic">n</emphasis>, it defaults to 1.
If you omit <emphasis role="italic">length</emphasis>, it defaults
to the number of remaining words in the receiving mutablebuffer. The strings
in the returned array never have leading or trailing whitespace.
</para>
</section>
<section id="mthMutableBufferTranslate"><title>translate</title>
<indexterm><primary>translate method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>translate method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>reordering data</primary></indexterm>
<indexterm><primary>translation</primary>
<secondary>with translate method</secondary></indexterm>
<indexterm><primary>uppercase translation</primary>
<secondary>with translate method</secondary></indexterm>
<programlisting>
<![CDATA[
>>-translate-+--------------------------------------------------------------------------+-><
+-(--+-------------------------------------+-+-----------------------+-)---+
+-tableo--+-------------------------+-+ +-,--+---+--+---------+-+
+-,--+--------+--+------+-+ +-n-+ +-,length-+
+-tablei-+ +-,pad-+
]]>
</programlisting>
<para>Returns the receiving buffer with each character translated to another
character or unchanged.
</para>
<para>The output table is <emphasis role="italic">tableo</emphasis>
and the input translation table is <emphasis role="italic">tablei</emphasis>.
<emphasis role="bold">translate</emphasis> searches
<emphasis role="italic">tablei</emphasis> for each character
in the receiving buffer. If the character is found, the corresponding character
in
<emphasis role="italic">tableo</emphasis> is replaces the character in the
buffer. If there are duplicates in
<emphasis role="italic">tablei</emphasis>, the first (leftmost) occurrence is
used. If the character is not found, the original character in the receiving
buffer is unchanged. </para>
<para>The tables can be of any length. If you specify neither translation table and
omit <emphasis role="italic">pad</emphasis>, the receiving string is
translated to uppercase (that is, lowercase
<computeroutput>a</computeroutput>-<computeroutput>z</computeroutput>
to uppercase
<computeroutput>A</computeroutput>-<computeroutput>Z</computeroutput>),
but if you include <emphasis role="italic">pad</emphasis>
the buffer translates the entire
string to <emphasis role="italic">pad</emphasis> characters.
<emphasis role="italic">tablei</emphasis> defaults to
<computeroutput>XRANGE("00"x,"FF"x)</computeroutput>, and
<emphasis role="italic">tableo</emphasis> defaults to the null string and
is padded with <emphasis role="italic">pad</emphasis> or truncated as necessary.
The default <emphasis role="italic">pad</emphasis> is a blank.</para>
<para><emphasis role="italic">n</emphasis> is the position of the first
character of the translated range. The default starting position is 1.
<emphasis role="italic">length</emphasis> is the range of characters to be
translated. If omitted, <emphasis role="italic">length</emphasis> remainder of
the buffer from the starting position to the end is used. </para>
</section>
<section id="mthMutableBufferUpper"><title>upper</title>
<indexterm><primary>upper method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>upper method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-upper(+---+--+---------+---)----------------------><
+-n-+ +-,length-+
]]>
</programlisting>
<para>Returns the receiving buffer with the characters of the target string
beginning with character <emphasis role="italic">n</emphasis> for <emphasis role="italic">length</emphasis>
characters converted to uppercase. If <emphasis role="italic">n</emphasis> is specified, it must
be a positive whole number. If <emphasis role="italic">n</emphasis> is not specified, the case
conversion will start with the first character. If <emphasis role="italic">length</emphasis>
is specified, it must be a non-negative whole number. If <emphasis role="italic">length</emphasis>
the default is to convert the remainder of the buffer.</para>
</section>
<section id="mthMutableBufferVerify"><title>verify</title>
<indexterm><primary>verify method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>verify method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>string</primary>
<secondary>verifying contents of</secondary></indexterm>
<indexterm><primary>verifying contents of a buffer</primary></indexterm>
<programlisting>
<![CDATA[
>>-verify(reference-+----------------------------------------------+-)--><
+-,--+--------+--+---------------------------+-+
+-option-+ +-,--+-------+--+---------+-+
+-start-+ +-,length-+
]]>
</programlisting>
<para>Returns a number that, by default, indicates whether the receiving buffer
is composed only of characters from
<emphasis role="italic">reference</emphasis>. It returns
<computeroutput>0</computeroutput> if all characters in the receiving buffer are
in
<emphasis role="italic">reference</emphasis> or returns the position of the
first character in the receiving buffer not in
<emphasis role="italic">reference</emphasis>.</para>
<para>The <emphasis role="italic">option</emphasis> can be either
<computeroutput>Nomatch</computeroutput> (the
default) or <computeroutput>Match</computeroutput>. (You need to specify only
the first capitalized and highlighted letter;
all characters following the first character are ignored, which can be in uppercase or
lowercase.)</para>
<para>If you specify <computeroutput>Match</computeroutput>, the method returns
the position of the first character in the receiving buffer that is in
<emphasis role="italic">reference</emphasis>, or returns
<computeroutput>0</computeroutput> if none of the characters
are found.</para>
<para>The default for <emphasis role="italic">start</emphasis> is
<computeroutput>1</computeroutput>. Thus, the search starts
at the first character of the receiving buffer. You can override this by
specifying a different
<emphasis role="italic">start</emphasis> point, which must be a positive whole
number.</para>
<para>The default for <emphasis role="italic">length</emphasis> is the length of
the buffer from <emphasis role="italic">start</emphasis> to the end of the
buffer. Thus, the search proceeds to the end of the receiving buffer. You can
override this by specifying a different
<emphasis role="italic">length</emphasis>, which must be a non-negative whole
number.
</para>
<para>If the receiving string is null, the method returns
<computeroutput>0</computeroutput>, regardless
of the value of the <emphasis role="italic">option</emphasis>. Similarly, if
<emphasis role="italic">start</emphasis> is greater
than <computeroutput>receiving_buffer~length</computeroutput>, the method
returns
<computeroutput>0</computeroutput>. If
<emphasis role="italic">reference</emphasis> is null, the method returns
<computeroutput>0</computeroutput> if
you specify <computeroutput>Match</computeroutput>. Otherwise, the method
returns the <emphasis role="italic">start</emphasis> value.</para>
<indexterm><primary>examples</primary>
<secondary>verify method</secondary></indexterm>
<example>
<title>Class MUTABLEBUGGER - verify method</title>
<programlisting>
.mutablebuffer~new('123')~verify('1234567890') -> 0
.mutablebuffer~new('1Z3')~verify('1234567890') -> 2
.mutablebuffer~new('AB4T')~verify('1234567890') -> 1
.mutablebuffer~new('AB4T')~verify('1234567890','M') -> 3
.mutablebuffer~new('AB4T')~verify('1234567890','N') -> 1
.mutablebuffer~new('1P3Q4')~verify('1234567890', ,3) -> 4
.mutablebuffer~new('123')~verify("",N,2) -> 2
.mutablebuffer~new('ABCDE')~verify("", ,3) -> 3
.mutablebuffer~new('AB3CD5')~verify('1234567890','M',4) -> 6
.mutablebuffer~new('ABCDEF')~verify('ABC',"N",2,3) -> 4
.mutablebuffer~new('ABCDEF')~verify('ADEF',"M",2,3) -> 4
</programlisting>
</example>
</section>
<section id="mthMutableBufferWord"><title>word</title>
<indexterm><primary>word method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>word method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>extracting</primary>
<secondary>word from a mutable buffer</secondary></indexterm>
<indexterm><primary>locating</primary>
<secondary>word in another mutable buffer</secondary></indexterm>
<programlisting>
<![CDATA[
>>-word(n)-----------------------------------------------------><
]]>
</programlisting>
<para>Returns the <emphasis role="italic">n</emphasis>th whitespace-delimited
word in the receiving buffer or the null string if the receiving buffer has
fewer than
<emphasis role="italic">n</emphasis> words. The
<emphasis role="italic">n</emphasis> must be a positive whole number. This
method is exactly equivalent
to <computeroutput>receiving_buffer~subWord(n,1)</computeroutput>.</para>
</section>
<section id="mthMutableBufferWordIndex"><title>wordIndex</title>
<indexterm><primary>wordIndex method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>wordIndex method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-wordIndex(n)------------------------------------------------><
]]>
</programlisting>
<para>Returns the position of the first character in the
<emphasis role="italic">n</emphasis>th whitespace-delimited word in the
receiving buffer. It returns
<computeroutput>0</computeroutput> if the receiving buffer has fewer
than
<emphasis role="italic">n</emphasis> words. The
<emphasis role="italic">n</emphasis> must be a positive whole number.
</para>
</section>
<section id="mthMutableBufferWordLength"><title>wordLength</title>
<indexterm><primary>wordLength method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>wordLength method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>finding</primary>
<secondary>word length</secondary></indexterm>
<programlisting>
<![CDATA[
>>-wordLength(n)-----------------------------------------------><
]]>
</programlisting>
<para>Returns the length of the <emphasis role="italic">n</emphasis>th
whitespace-delimited word in the receiving buffer or
<computeroutput>0</computeroutput> if the receiving buffer has fewer than
<emphasis role="italic">n</emphasis> words. The <emphasis
role="italic">n</emphasis> must be a positive whole number.</para>
</section>
<section id="mthMutableBufferWordPos"><title>wordPos</title>
<indexterm><primary>wordPos method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>wordPos method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>word</primary>
<secondary>locating in a mutable buffer</secondary></indexterm>
<programlisting>
<![CDATA[
>>-wordPos(phrase-+--------+-)---------------------------------><
+-,start-+
]]>
</programlisting>
<para>Returns the word number of the first word of
<emphasis role="italic">phrase</emphasis> found in the receiving buffer, or
<computeroutput>0</computeroutput> if
<emphasis role="italic">phrase</emphasis> contains no words or
if <emphasis role="italic">phrase</emphasis> is not found. Multiple whitespace
characters between words in either
<emphasis role="italic">phrase</emphasis> or the receiving buffer are treated as
a single blank for the comparison, but, otherwise, the words must match
exactly.</para>
<para>By default the search starts at the first word in the receiving buffer.
You can override this by specifying
<emphasis role="italic">start</emphasis> (which must be positive), the word at
which the search is to be started.</para>
</section>
<section id="mthMutableBufferWords"><title>words</title>
<indexterm><primary>words method</primary>
<secondary>of MutableBuffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>words method</secondary>
<tertiary>of MutableBuffer class</tertiary></indexterm>
<indexterm><primary>counting</primary>
<secondary>words in a mutable buffer</secondary></indexterm>
<indexterm><primary>extracting</primary>
<secondary>words from a mutable buffer</secondary></indexterm>
<indexterm><primary>word</primary>
<secondary>counting in a mutable buffer</secondary></indexterm>
<indexterm><primary>word</primary>
<secondary>extracting from a mutable buffer</secondary></indexterm>
<programlisting>
<![CDATA[
>>-words-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the number of whitespace-delimited words in the receiving buffer.
</para>
</section>
</section>
<section id="clsRegularExpression"><title>The RegularExpression Class</title>
<indexterm><primary>RegularExpression class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>RegularExpression class</secondary></indexterm>
<para>This class provides support for regular expressions. A regular
expression is a pattern you can use to match strings.</para>
<note><para>The RegularExpression class is not a built-in class
and is NOT preloaded. It is defined
in the <computeroutput>rxregexp.cls</computeroutput>
file. This means you must
use a <computeroutput>::requires </computeroutput>
statement to activate its functionality, as follows:</para></note>
<programlisting>
<![CDATA[
::requires "rxregexp.cls"
]]>
</programlisting>
<figure><title>The RegularExpression class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxRegularExpressionClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The RegularExpression class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<para>Here is a description of the syntax:</para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>|</entry>
<entry><para>OR operator between the left and right expression
</para></entry></row>
<row><entry>?</entry>
<entry><para>Matches any single character
</para></entry></row>
<row><entry>*</entry>
<entry><para>Matches the previous expression zero or more times
</para></entry></row>
<row><entry>+</entry>
<entry><para>Matches the previous expression one or more times
</para></entry></row>
<row><entry>\</entry>
<entry><para>"Escape" symbol: use the next character literally
</para></entry></row>
<row><entry>()</entry>
<entry><para>Expression in parenthesis (use where needed)
</para></entry></row>
<row><entry>{n}</entry>
<entry><para>Matches previous expression n times (n>1)
</para></entry></row>
<row><entry>[]</entry>
<entry><para>Set definition: matches any single character out of the defined
set.</para>
<para>A &apos;^&apos; right after the opening bracket means that none of the
following characters should be matched.</para>
<para>A &apos;-&apos; (if not used with &apos;\&apos;) defines a range between the last
specified character and the one following &apos;-&apos;. If it is the
first character in the set definition, it is used literally.
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
<para>The following symbolic names (they must start and end with &apos;:&apos;) can
be used to abbreviate common sets:</para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>:ALPHA:</entry>
<entry><para>Characters in the range A-Z and a-z
</para></entry></row>
<row><entry>:LOWER:</entry>
<entry><para>Characters in the range a-z
</para></entry></row>
<row><entry>:UPPER:</entry>
<entry><para>Characters in the range A-Z
</para></entry></row>
<row><entry>:DIGIT:</entry>
<entry><para>Characters in the range 0-9
</para></entry></row>
<row><entry>:ALNUM:</entry>
<entry><para>Characters in :DIGIT: and :ALPHA:
</para></entry></row>
<row><entry>:XDIGIT:</entry>
<entry><para>Characters in :DIGIT:, A-F and a-f
</para></entry></row>
<row><entry>:BLANK:</entry>
<entry><para>Space and tab characters
</para></entry></row>
<row><entry>:SPACE:</entry>
<entry><para>Characters "09"x to "0D"x and space
</para></entry></row>
<row><entry>:CNTRL:</entry>
<entry><para>Characters "00"x to "1F"x and "7F"x
</para></entry></row>
<row><entry>:PRINT:</entry>
<entry><para>Characters in the range "20"x to "7E"x
</para></entry></row>
<row><entry>:GRAPH:</entry>
<entry><para>Characters in :PRINT: without space
</para></entry></row>
<row><entry>:PUNCT:</entry>
<entry><para>All :PRINT: characters without space and not in :ALNUM:
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
<indexterm><primary>examples</primary>
<secondary>RegularExpression class</secondary></indexterm>
<example>
<title>Class REGULAREXPRESSION</title>
<programlisting>
<![CDATA[
::requires "rxregexp.cls"
"(Hi|Hello) World" Matches "Hi World" and
"Hello World".
"file.???" Matches any file with three
characters after "."
"file.?{3}" Same as above.
"a *b" Matches all strings that begin with
"a" and end with "b" and have an
arbitrary number of spaces in between
both.
"a +b" Same as above, but at least one space
must be present.
"file.[bd]at" Matches "file.bat" and "file.dat".
"[A-Za-z]+" Matches any string containing only
letters.
"[:ALPHA:]+" Same as above, using symbolic names.
"[^0-9]*" Matches any string containing no
numbers, including the empty string.
"[:DIGIT::LOWER:]" A single character, either a digit or
a lower case character.
"This is (very )+nice." Matches all strings with one or more
occurrences of "very " between
"This is " and "nice.".
]]>
</programlisting>
</example>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthRegularExpressionInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of RegularExpression class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of RegularExpression class</tertiary></indexterm>
<programlisting>
<![CDATA[
+-,-"MAXIMAL"--+
>>-init(-+---------+-+--------------+-)--------------------><
+-Pattern-+ +-,-"MINIMAL"--+
]]>
</programlisting>
<para>Instantiates a RegularExpression object. Use the optional parameter
<emphasis>Pattern</emphasis> to define a pattern that is used to match
strings. See the introductory text below for a description of the
syntax. If the strings match, you can decide whether you want to
apply "greedy" matching (a maximum-length match) or "non-greedy"
matching (a minimum-length match).</para>
<example>
<title>Class REGULAREXPRESSION - new method</title>
<programlisting>
<![CDATA[
myRE1 = .RegularExpression~new
myRE2 = .RegularExpression~new("Hello?*")
]]>
</programlisting>
</example>
</section>
<section id="mthRegularExpressionMatch"><title>match</title>
<indexterm><primary>match method</primary>
<secondary>of RegularExpression class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>match method</secondary>
<tertiary>of RegularExpression class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-match(-string-)-----------------------------------------><
]]>
</programlisting>
<para>This method tries to match <emphasis role="italic">string</emphasis> to the regular
expression that was defined on the "new" invocation or on the
"parse" invocation. It returns 0 on an unsuccessful match and 1
on a successful match. For an example see
<xref linkend="mthRegularExpressionParse" />.
</para>
</section>
<section id="mthRegularExpressionParse"><title>parse</title>
<indexterm><primary>parse method</primary>
<secondary>of RegularExpression class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>parse method</secondary>
<tertiary>of RegularExpression class</tertiary></indexterm>
<programlisting>
<![CDATA[
+-,-"CURRENT"--+
>>-parse(-Pattern-+--------------+-------------------------><
+-,-"MAXIMAL"--+
+-,-"MINIMAL"--+
]]>
</programlisting>
<para>This method creates the matcher used to match a string from the
regular expression specified with
<emphasis>Pattern</emphasis>. The RegularExpression
object uses this regular expression until a new invocation of Parse
takes place. The second (optional) parameter specifies whether to
use minimal or maximal matching. The default is to use the current
matching behavior.</para>
<para><emphasis role="bold">Return values:</emphasis></para>
<variablelist>
<varlistentry><term>0</term>
<listitem><para>Regular expression was parsed successfully.
</para></listitem></varlistentry>
<varlistentry><term>1</term>
<listitem><para>An unexpected symbol was met during parsing.
</para></listitem></varlistentry>
<varlistentry><term>2</term>
<listitem><para>A missing &apos;)&apos; was found.
</para></listitem></varlistentry>
<varlistentry><term>3</term>
<listitem><para>An illegal set was defined.
</para></listitem></varlistentry>
<varlistentry><term>4</term>
<listitem><para>The regular expression ended unexpectedly.
</para></listitem></varlistentry>
<varlistentry><term>5</term>
<listitem><para>An illegal number was specified.
</para></listitem></varlistentry>
</variablelist>
<indexterm><primary>examples</primary>
<secondary>RegularExpression class</secondary></indexterm>
<example>
<title>Class REGULAREXPRESSION - parse method</title>
<programlisting>
<![CDATA[
a.0 = "does not match regular expression"
a.1 = "matches regular expression"
b = .array~of("This is a nice flower.",
"This is a yellow flower.", ,
"This is a blue flower.",
"Hi there!")
myRE = .RegularExpression~new
e = myRE~parse("This is a ???? flower.")
if e == 0 then do
do i over b
j = myRE~match(i)
say i~left(24) ">>" a.j
end
end
else
say "Error" e "occurred!"
exit
::requires "rxregexp.cls"
]]>
</programlisting>
</example>
<para>Output:</para>
<programlisting>
<![CDATA[
This is a nice flower. >> Does match regular expression
This is a yellow flower. >> Does not match regular expression
This is a blue flower. >> Does match regular expression
Hi there! >> Does not match regular expression
]]>
</programlisting>
<indexterm><primary>examples</primary>
<secondary>RegularExpression class</secondary></indexterm>
<example>
<title>Class REGULAREXPRESSION - parse method</title>
<programlisting>
<![CDATA[
a.0 = "an invalid number!"
a.1 = "a valid number."
b = .array~of("1","42","0","5436412","1a","f43g")
myRE = .RegularExpression~new("[1-9][0-9]*")
do i over b
j = myRE~match(i)
say i "is" a.j
end
say
/* Now allow "hex" numbers and a single 0 */
if myRE~parse("0|([1-9a-f][0-9a-f]*)") == 0 then do
do i over b
j = myRE~match(i)
say i "is" a.j
end
end
else
say "invalid regular expression!"
exit
::requires "rxregexp.cls"
]]>
</programlisting>
</example>
<indexterm><primary>examples</primary>
<secondary>RegularExpression class</secondary></indexterm>
<example>
<title>Class REGULAREXPRESSION - parse method</title>
<programlisting>
<![CDATA[
str = "<p>Paragraph 1</p><p>Paragraph 2</p>"
myRE1 = .RegularExpression~new("<p>?*</p>","MINIMAL")
myRE1~match(str)
myRE2 = .RegularExpression~new("<p>?*</p>","MAXIMAL")
myRE2~match(str)
say "myRE1 (minimal) matched" str~substr(1,myRE1~position)
say "myRE2 (maximal) matched" str~substr(1,myRE2~position)
::requires "rxregexp.cls"
]]>
</programlisting>
</example>
<para>Output:</para>
<programlisting>
<![CDATA[
myRE1 (minimal) matched <p>Paragraph 1</p>
myRE2 (maximal) matched <p>Paragraph 1</p><p>Paragraph 2</p>
]]>
</programlisting>
</section>
<section id="mthRegularExpressionPos"><title>pos</title>
<indexterm><primary>pos method</primary>
<secondary>of RegularExpression class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>pos method</secondary>
<tertiary>of RegularExpression class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-pos-(-haystack-)----------------------------------------><
]]>
</programlisting>
<para>This method tries to locate a string defined by the regular
expression on the "new" invocation or on the "parse" invocation
in the given <emphasis role="italic">haystack</emphasis> string.
It returns 0 on an unsuccessful match or the starting position
on a successful match. The end position of the match can be
retrieved with the position method (<xref linkend="mthRegularExpressionPosition" />).</para>
<example>
<title>Class REGULAREXPRESSION - haystack method</title>
<programlisting>
<![CDATA[
str = "It is the year 2002!"
myRE = .RegularExpression~new("[1-9][0-9]*")
begin = myRE~pos(str)
if begin > 0 then do
year = str~substr(begin, myRE~position - begin + 1)
say "Found the number" year "in this sentence."
end
::requires "rxregexp.cls"
]]>
</programlisting>
</example>
<para>Output:</para>
<programlisting>
<![CDATA[
Found the number 2002 in this sentence.
]]>
</programlisting>
</section>
<section id="mthRegularExpressionPosition"><title>position</title>
<indexterm><primary>position method</primary>
<secondary>of RegularExpression class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>position method</secondary>
<tertiary>of RegularExpression class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-position------------------------------------------------><
]]>
</programlisting>
<para>Returns the character position at which the last parse(), pos(), or match()
method ended.</para>
<example>
<title>Class REGULAREXPRESSION - position method</title>
<programlisting>
<![CDATA[
myRE = .RegularExpression~new
myRE~parse("[abc") -- illegal set definition
say myRE~position -- will be 4
myRE = .RegularExpression~new("[abc]12")
myRE~match("c12")
say myRE~position -- will be 3
myRE~match("a13")
say myRE~position -- will be 2 (failure to match)
::requires "rxregexp.cls"
]]>
</programlisting>
</example>
</section>
</section>
<section id="clsRexxQueue"><title>The RexxQueue Class</title>
<indexterm><primary>RexxQueue class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>RexxQueue class</secondary></indexterm>
<para>The RexxQueue class provides object-style access to Rexx external data queues.</para>
<figure><title>The RexxQueue class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxRexxQueueClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The RexxQueue class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthRexxQueueCreate"><title>create (Class Method)</title>
<indexterm><primary>create method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>create method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-create(name)--------------------------------------------><
]]>
</programlisting>
<para>Attempts to create an external Rexx named queue using <emphasis role="italic">name</emphasis>. If
a <emphasis role="italic">name</emphasis> queue already exists, a new queue with a Rexx-generated name will be
created. This method returns the name of the created queue, which will be either
<emphasis role="italic">name</emphasis>, or a generated name if there is a conflict.
</para>
</section>
<section id="mthRexxQueueDeleteClsMethod"><title>delete (Class Method)</title>
<indexterm><primary>delete class method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>delete class method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-delete(name)--------------------------------------------><
]]>
</programlisting>
<para>Attempts to delete an external Rexx named queue named <emphasis role="italic">name</emphasis>. This method
returns "0" if the queue was successfully deleted. Non-zero results are the error codes from the RexxDeleteQueue()
programming interface.
</para>
</section>
<section id="mthRexxQueueExists"><title>exists (Class Method)</title>
<indexterm><primary>exists method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>exists method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-exists(name)--------------------------------------------><
]]>
</programlisting>
<para>Tests if an external Rexx queue <emphasis role="italic">name</emphasis> currently exists, returning
1 (true) if it does and 0 (false) otherwise.
</para>
</section>
<section id="mthRexxQueueOpen"><title>open (Class Method)</title>
<indexterm><primary>open method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>open method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-open(name)--------------------------------------------><
]]>
</programlisting>
<para>Tests if the external Rexx named queue <emphasis role="italic">name</emphasis>exists and
creates the queue if it does not.
</para>
</section>
<section id="mthRexxQueueDelete"><title>delete</title>
<indexterm><primary>delete method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>delete method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-delete------------------------------------------------><
]]>
</programlisting>
<para>Deletes the Rexx external queue associated with this RexxQueue instance.
</para>
</section>
<section id="mthRexxQueueEmpty"><title>empty</title>
<indexterm><primary>empty method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>empty method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-empty-------------------------------------------------><
]]>
</programlisting>
<para>Removes all items from the Rexx external queue associated with this RexxQueue instance.
</para>
</section>
<section id="mthRexxQueueGet"><title>get</title>
<indexterm><primary>get method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>get method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-get------------------------------------------------><
]]>
</programlisting>
<para>Returns the name of the Rexx external queue associated with this instance.
</para>
</section>
<section id="mthRexxQueueInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(-+------+-)----------------------------------><
+-name-+
]]>
</programlisting>
<para>Initializes a new RexxQueue instance associated with the named Rexx external queue. If
<emphasis role="italic">name</emphasis> is not specified, the SESSION queue is used. If the named
queue does not exist, one will be created.
</para>
</section>
<section id="mthRexxQueueLineIn"><title>lineIn</title>
<indexterm><primary>lineIn method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>lineIn method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-lineIn--------------------------------------------------><
]]>
</programlisting>
<para>Reads a single line from the Rexx external queue. If the queue is empty,
<emphasis role="bold">lineIn</emphasis> will wait until a line is added to the queue.
</para>
</section>
<section id="mthRexxQueueLineOut"><title>lineOut</title>
<indexterm><primary>lineOut method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>lineOut method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-lineOut(-+------+-)----------------------------------><
+-line-+
]]>
</programlisting>
<para>Adds a line to the Rexx external queue in first-in-first-out (FIFO) order. If
<emphasis role="italic">line</emphasis> is not specified, a null string ("") is added.
</para>
</section>
<section id="mthRexxQueueMakeArray"><title>makeArray</title>
<indexterm><primary>makeArray method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>makeArray method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-makeArray---------------------------------------------><
]]>
</programlisting>
<para>Returns a single-index array with the same number of items as the receiver object.
Items in the new array will have the same order as the items in the external queue.
The external queue is emptied.
</para>
</section>
<section id="mthRexxQueuePull"><title>pull</title>
<indexterm><primary>pull method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>pull method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-pull--------------------------------------------------><
]]>
</programlisting>
<para>Reads a line from the Rexx external queue. If the queue is currently empty,
this method will immediately return the Nil Object without waiting for lines to be added to the queue.
</para>
</section>
<section id="mthRexxQueuePush"><title>push</title>
<indexterm><primary>push method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>push method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-push(-+------+-)----------------------------------><
+-line-+
]]>
</programlisting>
<para>Adds a line to the Rexx external queue in last-in-last-out (LIFO) order. If
<emphasis role="italic">line</emphasis> is not specified, a null string ("") is added.
</para>
</section>
<section id="mthRexxQueueQueue"><title>queue</title>
<indexterm><primary>queue method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>queue method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-queue(-+------+-)----------------------------------><
+-line-+
]]>
</programlisting>
<para>Adds a line to the Rexx external queue in first-in-first-out (FIFO) order. If
<emphasis role="italic">line</emphasis> is not specified, a null string ("") is added.
</para>
</section>
<section id="mthRexxQueueQueued"><title>queued</title>
<indexterm><primary>queued method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>queued method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-queued---------------------------------------------><
]]>
</programlisting>
<para>Returns the count of lines currently in the Rexx external queue.
</para>
</section>
<section id="mthRexxQueueSay"><title>say</title>
<indexterm><primary>say method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>say method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-say(-+------+-)----------------------------------><
+-line-+
]]>
</programlisting>
<para>Adds a line to the Rexx external queue in first-in-first-out (FIFO) order. If
<emphasis role="italic">line</emphasis> is not specified, a null string ("") is added.
</para>
</section>
<section id="mthRexxQueueSet"><title>set</title>
<indexterm><primary>set method</primary>
<secondary>of RexxQueue class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>set method</secondary>
<tertiary>of RexxQueue class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-set(name)----------------------------------><
]]>
</programlisting>
<para>Switches the Rexx external queue associated with the RexxQueue instance. The new queue must have
been previously created. The method return value is the name of current queue being used by the instance.
</para>
</section>
</section>
<section id="clsSupplier"><title>The Supplier Class</title>
<indexterm><primary>Supplier class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Supplier class</secondary></indexterm>
<para>You can use a supplier object to iterate over items of a collection.
Supplier objects are created from a snapshot of a collection. The iteration
results are not affected by later changes to the source collection object.
</para>
<figure><title>The Supplier class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxSupplierClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The Supplier class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthSupplierNew"><title>new (Class Method)</title>
<indexterm><primary>new method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>new method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-new(items,indexes)-----------------------------------------><
]]>
</programlisting>
<para>Returns a new supplier object. The
<emphasis role="italic">items</emphasis> argument must be an
array of objects over which the supplier iterates. The
<emphasis role="italic">indexes</emphasis> argument
is an array of index values with a one-to-one correspondence to the objects
contained in the <emphasis role="italic">items</emphasis> array.
The created supplier iterates over the arrays,
returning elements of the values array in response to
<emphasis role="bold">items</emphasis> messages, and
elements of the indexes array in response to
<emphasis role="bold">index</emphasis> messages. The supplier
iterates for the number of items contained in the values array, returning
the Nil object for any nonexistent items in either array.</para>
</section>
<section id="mthSupplierAllIndexes"><title>allIndexes</title>
<indexterm><primary>allIndexes method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>allIndexes method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-allItems--------------------------------------------------------><
]]>
</programlisting>
<para>Returns an array of all index values from the current supplier position to the end of the
supplier. Once <emphasis role="bold">allIndexes</emphasis> is called, no
additional items can be retrieved from the supplier. Calls to <emphasis role="bold">available</emphasis>
will return "0" (false).</para>
</section>
<section id="mthSupplierAllItems"><title>allItems</title>
<indexterm><primary>allItems method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>allItems method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-allItems--------------------------------------------------------><
]]>
</programlisting>
<para>Returns an array of all items from the current supplier position to the end of the
supplier. Once <emphasis role="bold">allItems</emphasis> is called, no
additional items can be retrieved from the supplier. Calls to <emphasis role="bold">available</emphasis>
will return "0" (false).</para>
</section>
<section id="mthSupplierAvailable"><title>available</title>
<indexterm><primary>available method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>available method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-available---------------------------------------------------><
]]>
</programlisting>
<para>Returns <computeroutput>1</computeroutput> (true) if an item is available
from the supplier (that is, if the
<emphasis role="bold">item</emphasis> method would return a value). It returns
<computeroutput>0</computeroutput> (false) if the collection is empty or the
supplier has already enumerated the entire collection.</para>
</section>
<section id="mthSupplierIndex"><title>index</title>
<indexterm><primary>index method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>index method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-index-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the index of the current
item in the collection. If no item is available, that is, if
<emphasis role="bold">available</emphasis> would
return false, the supplier raises an error.</para>
</section>
<section id="mthSupplierInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init--------------------------------------------------------><
]]>
</programlisting>
<para>Initializes the object instance.</para>
</section>
<section id="mthSupplierItem"><title>item</title>
<indexterm><primary>item method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>item method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-item--------------------------------------------------------><
]]>
</programlisting>
<para>Returns the current item in the collection. If no item is available, that
is, if <emphasis role="bold">available</emphasis>
would return false, the supplier raises an error.
</para>
</section>
<section id="mthSupplierNext"><title>next</title>
<indexterm><primary>next method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>next method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-next--------------------------------------------------------><
]]>
</programlisting>
<para>Moves to the next item in the collection.
By repeatedly sending <emphasis role="bold">next</emphasis>
to the supplier (as long as <emphasis role="bold">available</emphasis>
returns true),
you can enumerate all items in the collection. If no item is available, that
is, if <emphasis role="bold">available</emphasis>
would return false, the supplier raises an error.
</para>
</section>
<section id="supex"><title>Examples</title>
<indexterm><primary>examples</primary>
<secondary>of Supplier class</secondary></indexterm>
<example>
<title>Class SUPPLIER</title>
<programlisting>
desserts=.array~of(apples, peaches, pumpkins, 3.14159) /* Creates array */
say "The desserts we have are:"
baker=desserts~supplier /* Creates supplier object named BAKER */
do while baker~available /* Array suppliers are sequenced */
if baker~index=4
then say baker~item "is pi, not pie!!!"
else say baker~item
baker~next
end
/* Produces: */
/* The desserts we have are: */
/* APPLES */
/* PEACHES */
/* PUMPKINS */
/* 3.14159 is pi, not pie!!! */
</programlisting>
</example>
</section>
<section id="mthSupplierSupplier"><title>supplier</title>
<indexterm><primary>supplier method</primary>
<secondary>of Supplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>supplier method</secondary>
<tertiary>of Supplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-supplier------------------------------------------------------><
]]>
</programlisting>
<para>Returns the target supplier as a result. This method allows an existing
supplier to be passed to methods that expect an object that implements a
<emphasis role="bold">supplier</emphasis> method as an argument.
</para>
</section>
</section>
<section id="clsStreamSupplier"><title>The StreamSupplier Class</title>
<indexterm><primary>StreamSupplier class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>StreamSupplier class</secondary></indexterm>
<para>
A subclass of the Supplier class (<xref linkend="clsSupplier" />) that will provided stream lines
using supplier semantics. This allows the programmer to iterate over the remaining lines in a stream. A
<emphasis role="italic">StreamSupplier</emphasis> object provides a snapshot of the stream at the point
in time it is created, including the current line read position. In general, the iteration is not
effected by later changes to the read and write positioning of the stream. However, forces external to
the iteration may change the <emphasis role="italic">content</emphasis> of the remaining lines as the
itertion progresses.
</para>
<figure><title>The StreamSupplier class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxStreamSupplierClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The StreamSupplier class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the Supplier class
(<xref linkend="clsSupplier" />).</para>
<simplelist type="vert" columns="3">
<member>new (class method (<xref linkend="mthSupplierNew" />)</member>
<member>allIndexes (<xref linkend="mthSupplierAllIndexes" />)</member>
<member>allItems (<xref linkend="mthSupplierAllItems" />)</member>
<member>available (<xref linkend="mthSupplierAvailable" />)</member>
<member>index (<xref linkend="mthSupplierIndex" />)</member>
<member>init (<xref linkend="mthSupplierInit" />)</member>
<member>item (<xref linkend="mthSupplierItem" />)</member>
<member>next (<xref linkend="mthSupplierNext" />)</member>
<member>supplier (<xref linkend="mthSupplierSupplier" />)</member>
</simplelist>
</section>
<section id="mthStreamSupplierAvailable"><title>available</title>
<indexterm><primary>available method</primary>
<secondary>of StreamSupplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>available method</secondary>
<tertiary>of StreamSupplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-available---------------------------------------------------><
]]>
</programlisting>
<para>Returns <computeroutput>1</computeroutput> (true) if an item is available
from the supplier (that is, if the
<emphasis role="bold">item</emphasis> method would return a value). It returns
<computeroutput>0</computeroutput> (false) if the collection is empty or the
supplier has already enumerated the entire collection.</para>
</section>
<section id="mthStreanSupplierIndex"><title>index</title>
<indexterm><primary>index method</primary>
<secondary>of StreamSupplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>index method</secondary>
<tertiary>of StreamSupplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-index-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the index of the current
item in the collection. If no item is available, that is, if
<emphasis role="bold">available</emphasis> would
return false, the supplier raises an error.</para>
</section>
<section id="mthStreamSupplierInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of StreamSupplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of StreamSupplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init--------------------------------------------------------><
]]>
</programlisting>
<para>Initializes the object instance.</para>
</section>
<section id="mthStreamSupplierItem"><title>item</title>
<indexterm><primary>item method</primary>
<secondary>of StreamSupplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>item method</secondary>
<tertiary>of StreamSupplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-item--------------------------------------------------------><
]]>
</programlisting>
<para>Returns the current item in the collection. If no item is available, that
is, if <emphasis role="bold">available</emphasis>
would return false, the supplier raises an error.
</para>
</section>
<section id="mthStreamSupplierNext"><title>next</title>
<indexterm><primary>next method</primary>
<secondary>of StreamSupplier class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>next method</secondary>
<tertiary>of StreamSupplier class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-next--------------------------------------------------------><
]]>
</programlisting>
<para>Moves to the next item in the collection.
By repeatedly sending <emphasis role="bold">next</emphasis>
to the supplier (as long as <emphasis role="bold">available</emphasis>
returns true),
you can enumerate all items in the collection. If no item is available, that
is, if <emphasis role="bold">available</emphasis>
would return false, the supplier raises an error.
</para>
</section>
</section>
<section id="clsRexxContext"><title>The RexxContext Class</title>
<indexterm><primary>RexxContext class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>RexxContext class</secondary></indexterm>
<para>The RexxContext class gives access to context information about the
currently executing Rexx code. Instances of the RexxContext class can only be
obtained via the .CONTEXT environment symbol. They cannot be directly created
by the user. It is a
subclass of the Object class (<xref linkend="clsObject" />).</para>
<figure><title>The RexxContext class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxContextClass.png" />
</imageobject>
</mediaobject>
</figure>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthRexxContextArgs"><title>args</title>
<indexterm><primary>args method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>args method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-args---------------------------------------------------------><
]]>
</programlisting>
<para>Returns the arguments used to invoke the current context as an array.
This is equivalent to using the Arg(1, 'A') (<xref linkend="bifArg" />) built-in function.
</para>
</section>
<section id="mthRexxContextCondition"><title>condition</title>
<indexterm><primary>condition method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>condition method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-condition----------------------------------------------------><
]]>
</programlisting>
<para>Returns the current context condition object, or the Nil object if the context does
not currently have a trapped condition. This is equivalent to using the
Condition('O') (<xref linkend="bifCondition" />) built-in function.
</para>
</section>
<section id="mthRexxContextDigits"><title>digits</title>
<indexterm><primary>digits method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>digits method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-digits-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the current context digits setting. This is equivalent to using
the digits() (<xref linkend="bifDigits" />) built-in function.
</para>
</section>
<section id="mthRexxContextExecutable"><title>executable</title>
<indexterm><primary>executable method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>executable method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-executable-------------------------------------------------><
]]>
</programlisting>
<para>Returns the current executable object for the current context. The
executable will be either a Routine (<xref linkend="clsRoutine" />) or
Method object (<xref linkend="clsMethod" />), depending on the type of
the active context.
</para>
</section>
<section id="mthRexxContextForm"><title>form</title>
<indexterm><primary>form method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>form method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-form-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the current context form setting. This is equivalent to using the
form() (<xref linkend="bifForm" />) built-in function.
</para>
</section>
<section id="mthRexxContextFuzz"><title>fuzz</title>
<indexterm><primary>fuzz method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>fuzz method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-fuzz-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the current context fuzz setting. This is equivalent to using the
fuzz() (<xref linkend="bifFuzz" />) built-in function.
</para>
</section>
<section id="mthRexxContextLine"><title>line</title>
<indexterm><primary>line method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>line method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-line-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the context current execution line. This is equivalent to using the
.LINE (<xref linkend="linee" />) environment symbol.
</para>
</section>
<section id="mthRexxContextName"><title>name</title>
<indexterm><primary>name method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>name method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-name-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the name used to invoke the current context. If the current
context is a method, <emphasis role="italic">name</emphasis> is the message name
used to invoke the method. If the current context is a routine invoked as an
external call, <emphasis role="italic">name</emphasis> is the name used to call
the routine. If the current context is an internal routine call, <emphasis role="italic">name</emphasis>
is the name of the label used to invoke the call. If the context is the main part of the program,
<emphasis role="italic">name</emphasis> will be the package name.
</para>
</section>
<section id="mthRexxContextPackage"><title>package</title>
<indexterm><primary>package method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>package method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-package----------------------------------------------------><
]]>
</programlisting>
<para>Returns the Package (<xref linkend="clsPackage" />) object
associated with the current executable object.
</para>
</section>
<section id="mthRexxContextRS"><title>rs</title>
<indexterm><primary>rs method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>rs method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-rs-------------------------------------------------------><
]]>
</programlisting>
<para>Returns the context current return status value. If no host commands have
been issued in the current context, the Nil object is returned. This is equivalent to using
the .RS (<xref linkend="rs" />) environment symbol.
</para>
</section>
<section id="mthRexxContextVariables"><title>variables</title>
<indexterm><primary>variables method</primary>
<secondary>of RexxContextclass</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>variables method</secondary>
<tertiary>of RexxContext class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-variables--------------------------------------------------><
]]>
</programlisting>
<para>Returns a directory object containing all of the variables in the current
execution context. The directory keys will be the variable names and the
mapped values are the values of the variables. The directory will only
contain simple variables and stem variables. Compound variable values may
be accessed by using the stem objects that are returned for the stem
variable names.
</para>
</section>
</section>
<section id="clsWeakReference"><title>The WeakReference Class</title>
<indexterm><primary>WeakReference class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>WeakReference class</secondary></indexterm>
<para>A WeakReference instance maintains a non-pinning reference to another
object. A non-pinning reference does not prevent an object from getting garbage
collected or having its uninit method run when there are no longer normal
references maintained to the object. Once the referenced object is eligible for
garbage collection, the reference inside the WeakReference instance will be
cleared and the VALUE method will return .nil on all subsequent calls.
WeakReferences are useful for maintaining caches of objects without preventing
the objects from being reclaimed by the garbage collector when needed.</para>
<figure><title>The WeakReference class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxWeakReferenceClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The WeakReference class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthWeakReferenceNew"><title>new (Class Method)</title>
<indexterm><primary>new method</primary>
<secondary>of WeakReference class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>new method</secondary>
<tertiary>of WeakReference class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-new-(object)------------------------------------------------><
]]>
</programlisting>
<para>Returns a new WeakReference instance containing a reference to
<emphasis role="italic">object</emphasis>.</para>
</section>
<section id="mthWeakReferenceValue"><title>value</title>
<indexterm><primary>value method</primary>
<secondary>of WeakReference class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>value method</secondary>
<tertiary>of WeakReference class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-value------------------------------------------------><
]]>
</programlisting>
<para>This method returns the referenced object. If the object has been garbage
collected, then the Nil object is returned.
</para>
</section>
</section>
<section id="clsPointer"><title>The Pointer Class</title>
<indexterm><primary>Pointer class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Pointer class</secondary></indexterm>
<figure><title>The Pointer class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxPointerClass.png" />
</imageobject>
</mediaobject>
</figure>
<para>A Pointer instance is a wrapper around a native pointer value. This class
is designed primarily for writing methods and functions in native code and can
only be created using the native code application programming interfaces. The Pointer
class new method will raise an error if invoked.</para>
<note><title>Note</title>
<para>The Pointer class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthPointerNew"><title>new (Class Method)</title>
<indexterm><primary>new method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>new method</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-new---------------------------------------------------------><
]]>
</programlisting>
<para>Creating Pointer object instances directly from Rexx code is not supported.
The Pointer class new method will raise an error if invoked.</para>
</section>
<section id="mthPointerOperators"><title>Operator Methods</title>
<programlisting>
<![CDATA[
>>-comparison_operator(argument)-------------------------------><
]]>
</programlisting>
<para>Returns <computeroutput>1</computeroutput> (true) or
<computeroutput>0</computeroutput> (false), the result of performing
a specified comparison operation.
</para>
<para>For the Pointer class, the argument object must be a pointer object instance and
the wrappered pointer value must be the same.</para>
<para>The comparison operators you can use in a message are: </para>
<informaltable frame="none" colsep="0" rowsep="0" pgwide="1">
<tgroup cols="2">
<colspec colnum="1" colwidth="1*" />
<colspec colnum="2" colwidth="4*" />
<tbody>
<row><entry>=, ==
<indexterm><primary>= method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>== method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>=</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
<indexterm><primary>method</primary>
<secondary>==</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
</entry>
<entry><para>True if the wrappered pointer values are the same.
</para></entry></row>
<row><entry>\=, >&lt;, &lt;>, \==
<indexterm><primary>\= method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>>&lt; method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>&lt;> method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>\== method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>\=</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
<indexterm><primary>method</primary>
<secondary>>&lt;</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
<indexterm><primary>method</primary>
<secondary>&lt;></secondary>
<tertiary>of Pointer class</tertiary></indexterm>
<indexterm><primary>method</primary>
<secondary>\==</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
</entry>
<entry><para>True if the wrappered pointer values are not the same.
</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</section>
<section id="mthPointerIsNull"><title>isNull</title>
<indexterm><primary>isNull method</primary>
<secondary>of Pointer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isNull method</secondary>
<tertiary>of Pointer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isNull-----------------------------------------------><
]]>
</programlisting>
<para>Returns 1 (true) if the wrappered pointer value is a NULL pointer (0) value.
Returns 0 (false) if the pointer value is non-zero.
</para>
</section>
</section>
<section id="clsBuffer"><title>The Buffer Class</title>
<indexterm><primary>Buffer class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>Buffer class</secondary></indexterm>
<figure><title>The Buffer class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxBufferClass.png" />
</imageobject>
</mediaobject>
</figure>
<para>A Buffer instance is a Rexx interpreter managed block of storage. This class
is designed primarily for writing methods and functions in native code and can
only be created using the native code application programming interfaces. The Buffer
class new method will raise an error if invoked.</para>
<note><title>Note</title>
<para>The Buffer also has available class methods that its
metaclass, the Class class(<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="mthBufferNew"><title>new (Class Method)</title>
<indexterm><primary>new method</primary>
<secondary>of Buffer class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>new method</secondary>
<tertiary>of Buffer class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-new---------------------------------------------------------><
]]>
</programlisting>
<para>Creating Buffer object instances directly from Rexx code is not supported.
The Buffer class new method will raise an error if invoked.</para>
</section>
</section>
<section id="clsFile"><title>The File Class</title>
<indexterm><primary>File class</primary></indexterm>
<indexterm><primary>class</primary>
<secondary>File class</secondary></indexterm>
<para>The File class provides services which are common to all the filesystems supported by ooRexx. A File object represents a path to a file or directory. The path can be relative or absolute.
</para>
<para>
If you create a File object with a relative path, the absolute path will be calculated using the current default directory.
This absolute path is memorized on the File object, and will not change if you change of default directory.
</para>
<figure><title>The File class and methods</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/ooRexxFileClass.png" />
</imageobject>
</mediaobject>
</figure>
<note><title>Note</title>
<para>The File class also has available class methods that its
metaclass, the Class class (<xref linkend="clsClass" />), defines.</para></note>
<section><title>Inherited Methods</title>
<para>Methods inherited from the
Object class (<xref linkend="clsObject" />).</para>
<xi:include href="objectclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<para>Methods inherited from the
Comparable class (<xref linkend="clsComparable" />).</para>
<itemizedlist>
<listitem><para>compare (<xref linkend="mthComparableCompareTo" />)</para></listitem>
</itemizedlist>
<para>Methods inherited from the
Orderable class (<xref linkend="clsObject" />).</para>
<xi:include href="orderableclassmethods.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
<section id="clsmthFileIsCaseSensitive"><title>isCaseSensitive (Class Method)</title>
<indexterm><primary>isCaseSensitive method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isCaseSensitive method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isCaseSensitive---------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the file system is case-sensitive. Otherwise returns .false ("0").
</para>
<para>This query method is available as both instance and class method.
</para>
</section>
<section id="clsmthFileListRoots"><title>listRoots (Class Method)</title>
<indexterm><primary>listRoots method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>listRoots method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-listRoots---------------------------------------------------><
]]>
</programlisting>
<para>Returns the file system root elements, as an array of string.
On Windows, each of the drives is a root element (Ex : "C:\").
On Unix, there is just one root ("/").
</para>
<example>
<title>Class FILE</title>
<programlisting>
<![CDATA[
say .File~listRoots~toString
/* Possible output on Windows : /*
C:\
D:\
E:\
R:\
]]>
</programlisting>
</example>
</section>
<section id="clsmthFilePathSeparator"><title>pathSeparator (Class Method)</title>
<indexterm><primary>pathSeparator method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>pathSeparator method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-pathSeparator-----------------------------------------------><
]]>
</programlisting>
<para>Returns the separator used for file search paths (";" on Windows, ":" on Unix).
</para>
<para>This query method is available as both instance and class method.
</para>
</section>
<section id="clsmthFileSeparator"><title>separator (Class Method)</title>
<indexterm><primary>separator method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>separator method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-separator---------------------------------------------------><
]]>
</programlisting>
<para>Returns the file name separator used by the file system ("\" on Windows, "/" on Unix).
</para>
<para>This query method is available as both instance and class method.
</para>
<example>
<title>Class FILE - separator method</title>
<programlisting>
<![CDATA[
file = .File~new("dir1" || .File~separator || "dir2" || .File~separator || "file")
-- "dir1/dir2/file" on Unix, "dir1\dir2\file" on Windows
]]>
</programlisting>
</example>
</section>
<section id="mthFileAbsoluteFile"><title>absoluteFile</title>
<indexterm><primary>absoluteFile method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>absoluteFile method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-absoluteFile------------------------------------------------><
]]>
</programlisting>
<para>Returns the fully qualified path as a new instance of File.
</para>
<example>
<title>Class FILE - absoluteFile method</title>
<programlisting>
<![CDATA[
/* On Windows */
'cd c:\program files\oorexx'
say .File~new("my file")~absoluteFile~class -- The File class
say .File~new("my file")~absoluteFile -- c:\program files\oorexx\my file
say .File~new("..\my file")~absoluteFile -- c:\program files\my file
say .File~new("..\..\my file")~absoluteFile -- c:\my file
say .File~new("..\..\my dir\my file")~absoluteFile -- c:\my dir\my file
/* On Linux */
'cd /opt/ooRexx'
say .File~new("my file")~absoluteFile -- /opt/ooRexx/my file
say .File~new("../my file")~absoluteFile -- /opt/my file
]]>
</programlisting>
</example>
</section>
<section id="mthFileAbsolutePath"><title>absolutePath</title>
<indexterm><primary>absolutePath method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>absolutePath method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-absolutePath------------------------------------------------><
]]>
</programlisting>
<para>Returns the fully qualified path as a string.
</para>
<example>
<title>Class FILE - absolutePath method</title>
<programlisting>
<![CDATA[
/* On Windows */
'cd c:\program files\oorexx'
say .File~new("my file")~absolutePath~class -- The String class
say .File~new("my file")~absolutePath -- c:\program files\oorexx\my file
say .File~new("..\my file")~absolutePath -- c:\program files\my file
say .File~new("..\..\my file")~absolutePath -- c:\my file
say .File~new("..\..\my dir\my file")~absolutePath -- c:\my dir\my file
/* On Linux */
'cd /opt/ooRexx'
say .File~new("my file")~absolutePath -- /opt/ooRexx/my file
say .File~new("../my file")~absolutePath -- /opt/my file
]]>
</programlisting>
</example>
</section>
<section id="mthFileCanRead"><title>canRead</title>
<indexterm><primary>canRead method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>canRead method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-canRead-----------------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the file exists and is readable. Otherwise returns .false ("0").
</para>
</section>
<section id="mthFileCanWrite"><title>canWrite</title>
<indexterm><primary>canWrite method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>canWrite method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-canWrite----------------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the file exists and is writable. Otherwise returns .false ("0").
</para>
</section>
<section id="mthFileCompareTo"><title>compareTo</title>
<indexterm><primary>compareTo method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>compareTo method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-compareTo(other)--------------------------------------------><
]]>
</programlisting>
<para>Performs a sorting comparison of the target File object to the <emphasis role="italic">other</emphasis> File object.
The comparison is made on the absolute paths (strings) of both File objects.
If the filesystem is case-sensitive then the paths comparison is case-sensitive, otherwise the comparison is caseless.
If the two paths are equal , 0 is returned. If the target path is larger, 1 is returned. -1 if the
<emphasis role="italic">other</emphasis> argument is the larger path.
</para>
<example>
<title>Class FILE - conpareTo method</title>
<programlisting>
<![CDATA[
file1 = .File~new("file", "dir")
file2 = .File~new("FILE", "DIR")
'cd' .File~listRoots[1]
file1~compareTo(file2) -- 0 on Windows (both Files denote the same path)
file1~compareTo(file2) -- 1 on Unix ("/dir/file" is greater than "/DIR/FILE")
]]>
</programlisting>
</example>
</section>
<section id="mthFileDelete"><title>delete</title>
<indexterm><primary>delete method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>delete method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-delete------------------------------------------------------><
]]>
</programlisting>
<para>Deletes the file or directory denoted by the absolute path of the target File object.
Only empty directories can be deleted.
</para>
<para>Returns .true ("1") if the deletion was successful, otherwise returns .false ("0").
</para>
</section>
<section id="mthFileExists"><title>exists</title>
<indexterm><primary>exists method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>exists method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-exists------------------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the file or directory (denoted by the absolute path of the target File object) exists.
Otherwise returns .false ("0").
</para>
</section>
<section id="mthFileHashCode"><title>hashCode</title>
<indexterm><primary>hashCode method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>hashCode method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-hashCode----------------------------------------------------><
]]>
</programlisting>
<para>Returns a string value that is used as a hash value for MapCollection such as Table, Relation, Set, Bag,
and Directory.
</para>
</section>
<section id="mthFileInit"><title>init</title>
<indexterm><primary>init method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>init method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-init(path-+------+-)----------------------------------------><
+-,dir-+
]]>
</programlisting>
<para>Initializes a new File instance with the path <emphasis role="italic">path</emphasis>
(after normalization).
</para>
<para>If specified, <emphasis role="italic">dir</emphasis> is a parent path that is prepended
to <emphasis role="italic">path</emphasis>. If <emphasis role="italic">dir</emphasis> is a File
object then the absolute path of <emphasis role="italic">dir</emphasis> is prepended, otherwise
<emphasis role="italic">dir</emphasis> is prepended as-is (after normalization).
The normalization consists in adjusting the separators to the platform's convention and removing
the final separator (if any).
</para>
<example>
<title>Class FILE - init method</title>
<programlisting>
<![CDATA[
/* Windows */
file = .File~new("file") -- file
file = .File~new("c:\program files\") -- c:\program files
file = .File~new("file", "c:/program files") -- c:\program files\file
'cd c:\program files\oorexx'
samples = .File~new("samples") -- samples
file = .File~new("file", "samples") -- samples\file
file = .File~new("file", samples) -- c:\program files\oorexx\samples\file
/* Unix */
file = .File~new("/opt/ooRexx/") -- /opt/ooRexx
'cd /opt/ooRexx'
samples = .File~new("samples") -- samples
file = .File~new("file", "samples") -- samples/file
file = .File~new("file", samples) -- /opt/ooRexx/samples/file
]]>
</programlisting>
</example>
</section>
<section id="mthFileIsCaseSensitive"><title>isCaseSensitive</title>
<indexterm><primary>isCaseSensitive method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isCaseSensitive method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isCaseSensitive---------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the file system is case-sensitive. Otherwise returns .false ("0").
</para>
<para>This query method is available as both instance and class method.
</para>
</section>
<section id="mthFileIsDirectory"><title>isDirectory</title>
<indexterm><primary>isDirectory method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isDirectory method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isDirectory---------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the absolute path of the target File object references a directory.
Otherwise returns .false ("0").
</para>
</section>
<section id="mthFileIsFile"><title>isFile</title>
<indexterm><primary>isFile method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isFile method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isFile------------------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the absolute path of the target File object references a file.
Otherwise returns .false ("0").
</para>
</section>
<section id="mthFileIsHidden"><title>isHidden</title>
<indexterm><primary>isHidden method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>isHidden method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-isHidden----------------------------------------------------><
]]>
</programlisting>
<para>Returns .true ("1") if the absolute path of the target File object references an existing file or
directory which is hidden. Otherwise returns .false ("0").
</para>
<para>On Windows, a file or directory is hidden when its attribute FILE_ATTRIBUTE_HIDDEN is set.
</para>
<para>On Unix, a file or directory is hidden when its name starts with a period character (".") or when one of its parent
directories has a name starting with a period character.
</para>
<example>
<title>Class FILE - isHidden method</title>
<programlisting>
<![CDATA[
/* Unix, when file exists */
say .File~new("/tmp/file")~isHidden -- 0
say .File~new("/tmp/.file")~isHidden -- 1
say .File~new("/tmp/.dir/file")~isHidden -- 1
]]>
</programlisting>
</example>
</section>
<section id="mthFileLastModified"><title>lastModified (Attribute)</title>
<indexterm><primary>lastModified attribute</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>lastModified method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-lastModified------------------------------------------------><
>>-lastModified=date-------------------------------------------><
]]>
</programlisting>
<variablelist>
<varlistentry><term><emphasis role="bold">lastModified get:</emphasis></term>
<listitem>
<para>Returns the last modified date of the file/directory denoted by the absolute
path of the receiver object. The result is a DateTime object, or .nil in case of error.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">lastModified set:</emphasis></term>
<listitem>
<para>Sets the last modified date of the file/directory denoted by the absolute path of the receiver object.
</para>
<para>The <emphasis role="italic">date</emphasis> parameter is a DateTime object.
</para>
</listitem></varlistentry>
<varlistentry><term><emphasis role="bold">Examples:</emphasis></term>
<listitem>
<example>
<title>Class FILE - lastModified method</title>
<programlisting>
<![CDATA[
/* On Windows */
say .File~new("C:\Program Files")~lastModified~class -- The DateTime class
say .File~new("C:\Program Files")~lastModified -- 2010-11-01T19:14:49.000000
say .File~new("dummy")~lastModified -- The NIL object
/* A possible implementation of : touch -c -m -r referenceFile file
-c, --no-create do not create any files
-m change only the modification time
-r, --reference=FILE use this file's time instead of current time
*/
parse arg referenceFilePath filePath .
file = .File~new(filePath)
if \ file~exists then return 0 -- OK, not an error
referenceFile = .File~new(referenceFilePath)
referenceDate = referenceFile~lastModified
if referenceDate == .nil then return 1 -- KO
file~lastModified = referenceDate
return 0 -- OK
]]>
</programlisting>
</example>
</listitem></varlistentry>
</variablelist>
</section>
<section id="mthFileLength"><title>length</title>
<indexterm><primary>length method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>length method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-length------------------------------------------------------><
]]>
</programlisting>
<para>Returns the size in bytes of the file/directory denoted by the absolute
path of the receiver object.
</para>
</section>
<section id="mthFileList"><title>list</title>
<indexterm><primary>list method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>list method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-list--------------------------------------------------------><
]]>
</programlisting>
<para>Returns an array of files/directories names which are immediate childrens of the directory
denoted by the absolute path of the receiver object.
The order in which the names are returned is dependent on the file system (not necessarily alphabetic order).
The special names "." and ".." are not returned.
</para>
<para>The result is an array of strings.
If the receiver object is not a directory then the result is .nil.
</para>
<example>
<title>Class FILE - list method</title>
<programlisting>
<![CDATA[
names = .File~new("c:\program files\oorexx\samples")~list
say names -- an Array
say names~toString
/* Possible output */
api
ccreply.rex
complex.rex
drives.rex
factor.rex
(etc...)
]]>
</programlisting>
</example>
</section>
<section id="mthFileListFiles"><title>listFiles</title>
<indexterm><primary>listFiles method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>listFiles method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-listFiles---------------------------------------------------><
]]>
</programlisting>
<para>Returns an array of files/directories which are immediate childrens of the directory
denoted by the absolute path of the receiver object.
The order in which the names are returned is dependent on the file system (not necessarily alphabetic order).
The special names "." and ".." are not returned.
</para>
<para>The result is an array of File objects.
If the receiver object is not a directory then the result is .nil.
</para>
<example>
<title>Class FILE - listFiles method</title>
<programlisting>
<![CDATA[
do file over deepListFiles("c:\program files\oorexx\samples")
say file
end
-- Depth first iteration
::routine deepListFiles
use strict arg directory, accumulator=(.List~new)
files = .File~new(directory)~listFiles
if files == .nil then return accumulator
do file over files
accumulator~append(file)
if file~isDirectory then call deepListFiles file~absolutePath, accumulator
end
return accumulator
/* Possible output */
c:\program files\oorexx\samples\api
c:\program files\oorexx\samples\api\callrxnt
c:\program files\oorexx\samples\api\callrxnt\backward.fnc
c:\program files\oorexx\samples\api\callrxnt\callrxnt.c
c:\program files\oorexx\samples\api\callrxnt\callrxnt.exe
c:\program files\oorexx\samples\api\callrxnt\callrxnt.ico
c:\program files\oorexx\samples\api\callrxnt\callrxnt.mak
c:\program files\oorexx\samples\api\callrxwn
c:\program files\oorexx\samples\api\callrxwn\backward.fnc
(etc...)
]]>
</programlisting>
</example>
</section>
<section id="mthFileMakeDir"><title>makeDir</title>
<indexterm><primary>makeDir method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>makeDir method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-makeDir-----------------------------------------------------><
]]>
</programlisting>
<para>Makes just the directory represented by the last name (<xref linkend="mthFileName" />)
portion of the receiver object's absolute path. Does not create any parent directories,
which must all exist for a successful creation of the leaf directory.
</para>
<para>Returns .true ("1") if the creation was successful, otherwise returns .false ("0").
If the directory already exists then the result is .false.
</para>
</section>
<section id="mthFileMakeDirs"><title>makeDirs</title>
<indexterm><primary>makeDirs method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>makeDirs method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-makeDirs----------------------------------------------------><
]]>
</programlisting>
<para>Creates the entire directory hierarchy represented by the absolute path
of the receiver object.
</para>
<para>Returns .true ("1") if the creation was successful, otherwise returns .false ("0").
If the directory already exists then the result is .false.
</para>
</section>
<section id="mthFileName"><title>name</title>
<indexterm><primary>name method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>name method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-name--------------------------------------------------------><
]]>
</programlisting>
<para>Returns the name portion of the receiver object's absolute path.
This is everything after the last path separator. On Windows, the file's
extension is part of the name.
</para>
<example>
<title>Class FILE - name method</title>
<programlisting>
<![CDATA[
/* On Windows */
say .File~new("c:\program files\oorexx\rexx.exe")~name -- rexx.exe
say .File~new("c:\")~name -- empty string
say .File~new("c:")~name -- empty string
/* On Unix */
say .File~new("/opt/ooRexx/bin/rexx.img")~name -- rexx.img
say .File~new("/")~name -- empty string
]]>
</programlisting>
</example>
</section>
<section id="mthFileParent"><title>parent</title>
<indexterm><primary>parent method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>parent method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-parent------------------------------------------------------><
]]>
</programlisting>
<para>Returns the parent directory portion of the receiver object's absolute path.
If no separator is found or the absolute path ends with a separator
(which means this is a root path) then returns .nil.
</para>
<example>
<title>Class FILE - parent method</title>
<programlisting>
<![CDATA[
/* On Windows */
say .File~new("c:\program files\oorexx\rexx.exe")~parent -- c:\program files\oorexx
say .File~new("c:\")~parent -- The NIL object
say .File~new("c:")~parent -- The NIL object
/* On Unix */
say .File~new("/opt/ooRexx/bin/rexx.img")~parent -- /opt/ooRexx/bin
say .File~new("/")~parent -- The NIL object
]]>
</programlisting>
</example>
</section>
<section id="mthFileParentFile"><title>parentFile</title>
<indexterm><primary>parentFile method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>parentFile method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-parentFile--------------------------------------------------><
]]>
</programlisting>
<para>Returns the parent (<xref linkend="mthFileParent" /> directory
portion as a File object.
If no separator is found or the absolute path ends with a separator
(which means this is a root path) then returns .nil.
</para>
</section>
<section id="mthFilePath"><title>path</title>
<indexterm><primary>path method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>path method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-path--------------------------------------------------------><
]]>
</programlisting>
<para>Returns the original path (after normalization) used to create the File object.
The normalization consists in adjusting the separators to the platform's convention and removing
the final separator (if any).
</para>
</section>
<section id="mthFilePathSeparator"><title>pathSeparator</title>
<indexterm><primary>pathSeparator method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>pathSeparator method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-pathSeparator-----------------------------------------------><
]]>
</programlisting>
<para>Returns the separator used for file search paths (";" on Windows, ":" on Unix).
</para>
<para>This query method is available as both instance and class method.
</para>
</section>
<section id="mthFileRenameTo"><title>renameTo</title>
<indexterm><primary>renameTo method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>renameTo method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-renameTo(dest)----------------------------------------------><
]]>
</programlisting>
<para>Changes the name of the file/directory denoted by the absolute path of the target object.
The new name is <emphasis role="italic">dest</emphasis>.
</para>
<para>Returns .true ("1") if the renaming was successful, otherwise returns .false ("0").
</para>
<para>On Windows, this method calls <function>MoveFile</function> to perform the action.
</para>
<para>On Unix, this method calls <function>rename</function> to perform the action.
</para>
</section>
<section id="mthFileSeparator"><title>separator</title>
<indexterm><primary>separator method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>separator method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-separator---------------------------------------------------><
]]>
</programlisting>
<para>Returns the file name separator used by the file system ("\" on Windows, "/" on Unix).
</para>
<para>This query method is available as both instance and class method.
</para>
</section>
<section id="mthFileSetReadOnly"><title>setReadOnly</title>
<indexterm><primary>setReadOnly method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>setReadOnly method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-setReadOnly-------------------------------------------------><
]]>
</programlisting>
<para>Sets the read-only flag of the file/directory denoted by the absolute path of the target object.
</para>
<para>Returns .true ("1") if the attribute was set, otherwise returns .false ("0").
</para>
</section>
<section id="mthFileString"><title>string</title>
<indexterm><primary>string method</primary>
<secondary>of File class</secondary></indexterm>
<indexterm><primary>method</primary>
<secondary>string method</secondary>
<tertiary>of File class</tertiary></indexterm>
<programlisting>
<![CDATA[
>>-string------------------------------------------------------><
]]>
</programlisting>
<para>Returns a string that indicates the path used to create the File object.
</para>
</section>
</section>
</section>