Obj
abstract class Obj
Obj is the root class of all classes.
Obj constructor for subclasses
Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object
Write x.toStr to standard output followed by newline
Compare this object to the specified for equality
Return a unique hashcode for this object
Return if this Obj is immutable and safe to share between threads
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable
Return a string representation of this object
Trap a dynamic call for handling
Get the Type instance which represents this object's class
This method called whenever an it-block is applied to an object
virtual Int compare(Obj that)
Return a negative integer, zero, or a positive integer if this object is less than, equal to, or greater than the specified object:
this < that => <0
this == that => 0
this > that => >0
This method may also be accessed via the < <= <=> >= and >
shortcut operators. If not overridden the default implementation
compares the toStr representations. Also see
docLang.
Examples:
3.compare(8) => -1
8.compare(3) => 1
8.compare(8) => 0
3 <=> 8 => -1 // shortcut for 3.compare(8)
static Void echo(Obj? x := "")
Write x.toStr to standard output followed by newline. If x is
null then print "null". If no argument is provided then print
an empty line.
virtual Bool equals(Obj? that)
Compare this object to the specified for equality. This method may
be accessed via the == and != shortcut operators. If not overridden
the default implementation compares for reference equality using
the === operator. If this method is overridden, then hash() must
also be overridden such that any two objects which return true for
equals() must return the same value for hash(). This method must
accept null and return false.
virtual Int hash()
Return a unique hashcode for this object. If a class overrides hash() then it must ensure if equals() returns true for any two objects then they have same hash code.
Bool isImmutable()
Return if this Obj is immutable and safe to share between threads:
- an instance of a const class
- the result of toImmutable on List, Map, or Buf
- a Func object may or may not be immutable - see Func.
- other instances are assumed mutable and return false
new make()
Obj constructor for subclasses.
This toImmutable()
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
- if type is const, return this
- if already an immutable List, Map, Buf, or Func return this
- if a List, then attempt to perform a deep clone by calling toImmutable on all items
- if a Map, then attempt to perform a deep clone by calling toImmutable on all values (keys are already immutable)
- some Funcs can be made immutable - see Func
- if a Buf create immutable copy, see Buf
- any other object throws NotImmutableErr
virtual Str toStr()
Return a string representation of this object.
virtual Obj? trap(Str name, Obj?[]? args := null)
Trap a dynamic call for handling. Dynamic calls are invoked with the -> shortcut operator:
a->x a.trap("x", null)
a->x() a.trap("x", null)
a->x = b a.trap("x", [b])
a->x(b) a.trap("x", [b])
a->x(b, c) a.trap("x", [b, c])
The default implementation provided by Obj attempts to use
reflection. If name maps to a method, it is invoked with the
specified arguments. If name maps to a field and args.size
is zero, get the field. If name maps to a field and args.size
is one, set the field and return args[0]. Otherwise throw
UnknownSlotErr.
Type typeof()
Get the Type instance which represents this object's class.
Also seeType.of or Pod.of.
virtual This with(|This| f)
This method called whenever an it-block is applied to
an object. The default implementation calls the function
with this, and then returns this.