Class Method

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
Copy

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)
Copy

Return the raw fandoc for this slot or null if not available.

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.

Get a facet by its type. If not found on this slot then return null or throw UnknownFacetErr based on check flag. See Facets Doc for details.

Get the list of facets defined on this slot or return an empty list if no facets are defined. If looking up a facet by type, then use the facet method which will provide better performance. See Facets Doc for details.

Return if this type has the specified facet defined.

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.

Return if slot is abstract (no implementation provided).

Return if slot is constant and thread safe. A constant field is explicitly marked with the const modifier and guaranteed to always reference the same immutable object for the life of the VM. A const method is guaranteed to not capture any state from its thread, and is safe to execute on other threads. The compiler marks methods as const based on the following analysis:

• static methods are always automatically const
• instance methods are never const
• closures which don't capture any variables from their scope are automatically const
• partial apply methods which only capture const variables from their scope are automatically const

Return if slot is constructor method.

Return true if this is an instance of Field.

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 sys::Func.
• other instances are assumed mutable and return false

Return if slot has internal protection scope.

Return true if this is an instance of Method.

Return if slot is native.

Return if slot is an override (of parent's virtual method).

Return if slot has private protection scope.

Return if slot has protected protection scope.

Return if slot has public protection scope.

Return if slot is static (class based, rather than instance).

Return if this slot was generated by the compiler.

Return if slot is virtual (may be overridden in subclasses).

Simple name of the slot such as "size".

Parent type which defines this slot.

Qualified name such as "sys:Str.size".

Return a string representation of the Fantom code signature.

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 sys::Func
• if a Buf create immutable copy, see sys::Buf
• any other object throws NotImmutableErr

Always return qname().

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])
Copy

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.

Get the Type instance which represents this object's class. Also seeType.of or Pod.of.

This method called whenever an it-block is applied to an object. The default implementation calls the function with this, and then returns this.

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.

Find a Slot by its qualified name "pod::Type.slot". If the slot doesn't exist and checked is false then return null, otherwise throw UnknownSlotErr.

Convenience for (Field)find(qname, checked)

Convenience for findMethod(qname, checked).func

Convenience for (Method)find(qname, checked)