Open Object Rexx™: Reference
PrevChapter 4. Objects and ClassesNext

Overview of Classes Provided by Rexx

This section gives a brief overview of the classes and methods Rexx defines.

Note that there might also be other classes in the system, depending on the operating system.

The Class Hierarchy

Rexx provides the following classes belonging to the object class:

(The classes are in a class hierarchy with subclasses indented below their superclasses.)

Note that there might also be other classes in the system.

The following figures show all the classes.

Figure 4-1. Classes and Inheritance (part 1 of 7)

Figure 4-2. Classes and Inheritance (part 2 of 7)

Figure 4-3. Classes and Inheritance (part 3 of 7)

Figure 4-4. Classes and Inheritance (part 4 of 7)

Figure 4-5. Classes and Inheritance (part 5 of 7)

Figure 4-6. Classes and Inheritance (part 6 of 7)

Figure 4-7. Classes and Inheritance (part 7 of 7)

Cross-reference of Methods

The following table lists all the methods and the classes that define them. All methods are instance methods except where noted.

Table 4-1. Summary of Methods and the Classes Defining Them

Method NameClass(es)
[] Array, Directory, List, Queue, Relation, Stem, Table
[]= Array, Bag, Collection, Directory, List, Properties, Queue, Relation, Stem, Stem, Table
abbrev String
abs String
addDays DateTime, TimeSpan
addHours DateTime, TimeSpan
addMicroseconds DateTime, TimeSpan
addMinutes DateTime, TimeSpan
addSeconds DateTime, TimeSpan
addWeeks DateTime, TimeSpan
addYears DateTime
allAt Relation
allIndex Relation
allIndexes Array, Collection, Directory, List, Queue, Stem, Supplier, Table
allItems Array, Collection, Directory, List, Queue, Relation, Stem, Supplier, Table
append Array, List, MutableBuffer, Ordered Collection, Queue
appendAll Ordered Collection,
arguments Message
arrayIn InputStream, Stream
arrayOut OutputStream, Stream
at Array, Directory, List, Queue, Relation, Stem, Table
available StreamSupplier, Supplier
baseClass Class (class and instance method)
baseDate DateTime
bitAnd String
bitOr String
bitXor String
b2x String
cancel Alarm
caselessChangeStr String
caselessAbbrev String
caselessCompare String
caselessCompareTo String
caselessCountStr String
caselessEquals String
caselessLastPos String
caselessMatch String
caselessMatchChar String
caselessPos String
center/centre String
changeStr String
charIn InputStream, OutputStream, Stream
charOut InputStream, OutputStream, Stream
chars InputStream, OutputStream, Stream
civilTime DateTime
class Object
close InputStream, OutputStream, Stream
command Stream
compare Comparator, CaselessColumnComparator, CaselessComparator, ColumnComparator, CaselessDescendingComparator, DescendingComparator, InvertingComparator, String
compareTo Comparable, DateTime, String, TimeSpan
completed Message
copies String
copy Object
countStr String
create RexxQueue (class method)
current Monitor
c2d String
c2x String
dataType String
date DateTime
day DateTime
dayMinutes DateTime
dayName DateTime
daySeconds DateTime
dayMicroseconds DateTime
days TimeSpan
daysInMonth DateTime
daysInYear DateTime
decodeBase64 String
defaultName Class (class and instance method), Object
define Class (class and instance method)
delete Class (class and instance method), MutableBuffer, RexxQueue (class method), RexxQueue
delStr String
delWord String
description Stream
destination Monitor
difference Collection, Bag, Ordered Collection, Relation,
dimension Array
duration TimeSpan
d2c String
d2x String
elapsed DateTime
empty Array, Directory, List, Queue, Relation, Stem, Table
encodeBase64 String
enhanced Class (class and instance method)
entry Directory
equals String
errorCondition Message
europeanDate DateTime
first Array, List. Queue
firstItem List
flush Stream
format String
fromBaseDate DateTime
fromCivilTime DateTime, TimeSpan
fromDays TimeSpan
fromEuropeanDate DateTime
fromHours TimeSpan
fromIsoDate DateTime
fromLongTime DateTime TimeSpan
fromMicroseconds TimeSpan
fromMinutes TimeSpan
fromNormalDate DateTime
fromNormalTime DateTime, TimeSpan
fromOrderedDate DateTime
fromSeconds TimeSpan
fromStandardDate DateTime
fromStringFormat TimeSpan
fromTicks DateTime
fromUsaDate DateTime
fullDate DateTime
get RexxQueue
getBufferSize MutableBuffer
getLogical Properties
getProperty Properties
getWhole Properties
hasEntry Directory
hasError Message
hashcode DateTime, TimeSpan
hasIndex Array, Collection, Directory, List, Queue, Relation, Stem, Table
hasItem Array, Collection, Directory, List, Queue, Relation, Stem, Table
hasMethod Object
hours DateTime, TimeSpan
id Class (class and instance method)
identityHash Object
index Array, Collection, Directory, List, Queue, Relation, Stem, Supplier, Table
inherit Class (class and instance method)
init Alarm, CaselessColumnComparator, ColumnComparator, CircularQueue, InvertingComparator, Monitor, Object, RegularExpression, RexxQueue, Stream, StreamSupplier, Supplier
insert List, MutableBuffer, Queue, String
instanceMethod Object
instanceMethods Object
instanceOf Object
intersection Bag, Collection, Ordered Collection, Relation, Set,
isA Object
isEmpty Array, Directory, List, Queue, Relation, Stem, Table
isoDate DateTime
isLeapYear DateTime
isSubclassOf Class (class and instance method)
item StreamSupplier, Supplier
items Array, Collection, Directory, List, Queue, Relation, Stem, Table
languageDate DateTime
last Array, List, Queue
lastItem List
lastPos MutableBuffer, String
left String
length MutableBuffer, String
lineIn InputStream, OutputStream, RexxQueue, Stream
lineOut InputStream, OutputStream, RexxQueue, Stream
lines InputStream, OutputStream, Stream
load Properties (class and instance method)
longTime DateTime
lower String
makeArray Array, Collection, CircularQueue, Directory, List, Queue, Relation, Stem, Stream, String, Table
makeString Array, String
match RegularExpression, String
matchChar String
max String
maxDate DateTime
messageName Message
metaClass Class (class and instance method)
method Class (class and instance method)
methods Class (class and instance method)
microseconds DateTime, TimeSpan
min String
minDate DateTime
minutes DateTime, TimeSpan
mixinClass Class (class and instance method)
month DateTime
monthName DateTime
new Array (class method), Class (class and instance method), Directory (class method), List (class method), Message (class method), Method (class method), MutableBuffer (class method), Object (class method), Properties (class method), Queue (class method), Relation (class method), Stem (class method), String (class method), Stream (class method), Supplier (class method), Table (class method)
newFile Method (class method)
next Array, List, Queue, StreamSupplier, Supplier
normalDate DateTime
normalTime DateTime
notify Message
objectName Object
objectName= Object
of Array (class method), Bag (class method), CircularQueue (class method), List (class method), Queue (class method), Set (class method)
open InputStream, OutputStream, Stream
Operator Methods (Arithmetic): +, -, *, /, %, //, **, prefix +, prefix - String
Operator Methods (Comparison): =, \=, ><, <>, ==, and \== Object, String
Operator Methods (Comparison): >, <, >=, \<, <=, \>, >>, <<, >>=, \<<, <<=, and \>> String
Operator Methods (Concatenation): "" (abuttal), ||, and " " (blank) String
Operator Methods (Logical): &, |, &&, and prefix \ String
Operator Methods (Other): == (unary) Object
orderedDate DateTime
overlay MutableBuffer, String
parse RegularExpression
peek Queue
pos MutableBuffer, RegularExpression, String
position InputStream, OutputStream, RegularExpression, Stream
previous Array, List, Queue
pull Queue, RexxQueue,
push CircularQueue, Queue, RexxQueue,
put Array, Bag, Collection, Directory, List, Properties, Queue, Relation, Set, Stem, Table
putAll Bag, Map Collection, Set,
qualify Stream
query Stream
queryMixinClass Class (class and instance method)
queue CircularQueue, Queue, RexxQueue
queued RexxQueue,
remove Array, Directory, List, Queue, Relation, Stem, Table
removeItem Array, Directory, List, Queue, Relation, Stem, Table
request MutableBuffer, Object, Stem
resize CircularQueue
result Message
reverse String
right String
run Object
save Properties
say RexxQueue, Stream
seconds DateTime, TimeSpan
section Array, List
seek Stream
send Message
set RexxQueue
setBufferSize MutableBuffer
setEntry Directory
setGuarded Method
setLogical Properties
setMethod Directory, Object
setPrivate Method
setProperty Properties
setProtected Method
setSecurityManager Method
setUnguarded Method
setWhole Properties
sign String, TimeSpan
size Array, CircularQueue
sort Array,
sortWith Array,
source Method
space String
stableSort Array,
stableSortWith Array,
standardDate DateTime
start Message, Object
state Stream
string CircularQueue, DateTime, MutableBuffer, Object, Stream, TimeSpan
strip String
subChar MutableBuffer. String
subClass Class (class and instance method)
subClasses Class (class and instance method)
subset Bag, Collection Ordered Collection, Relation, Set,
substr MutableBuffer, String
subWord String
superClasses Class (class and instance method)
supplier Array, CircularQueue, Collection, Directory, List, Queue, Relation, Stem, Stream, Supplier, Table
target Message
ticks DateTime
timeOfDay DateTime
today DateTime
toString Array,
totalDays TimeSpan
totalHours TimeSpan
totalMicroseconds TimeSpan
totalMinutes TimeSpan
totalSeconds TimeSpan
translate String
trunc String
uninherit Class (class and instance method)
uninit MutableBuffer, Stream
union Bag, Collection, Ordered CollectionArray, Relation, Set,
unknown Directory, Monitor, Stem
unsetMethod Directory, Object
upper String
usaDate DateTime
verify String
weekDay DateTime
word String
wordIndex String
wordLength String
wordPos String
words String
xor Bag, Collection, Ordered Collection, Relation, Set,
x2b String
x2c String
x2d String
year DateTime
yearDay DateTime

The chapters that follow describe the classes and other objects that Rexx provides and their available methods. Rexx provides the objects listed in these sections and they are generally available to all methods through environment symbols (see Environment Symbols).

Notes:

  1. In the method descriptions in the chapters that follow, methods that return a result begin with the word "returns".

  2. For [] and []= methods, the syntax diagrams include the index or indexes within the brackets. These diagrams are intended to show how you can use these methods. For example, to retrieve the first element of a one-dimensional array named Array1, you would typically use the syntax: 

    Array1[1]
    rather than: 
    Array1~"[]"(1)
    even though the latter is valid and equivalent. For more information, see Message Terms and Message Instructions.

  3. When the argument of a method must be a specific kind of object (such as array, class, method, or string) the variable you specify must be of the same class as the required object or be able to produce an object of the required kind in response to a conversion message. In particular, subclasses are acceptable in place of superclasses (unless overridden in a way that changes superclass behavior), because they inherit a suitable conversion method from their Rexx superclass.

    The REQUEST method of the Object class (see request) can perform this validation.

PrevHomeNext
Creating and Using Classes and MethodsUpThe Builtin Classes