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)
Return the fandoc chapter for this pod or null if not available. To get the summary string for the pod use:
pod.meta["pod.summary"]
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.
Look up a resource file in this pod. The URI must start with the Pod's uri or be path absolute. If the file cannot be found then return null or throw UnresolvedErr based on checked flag.
Examples:
Pod.find("icons").file(`/x16/cut.png`)
Pod.find("icons").file(`fan://icons/x16/cut.png`)
`fan://icons/x16/cut.png`.get
Optionalchecked: booleanReturn 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.
Convenience for Env.locale using Locale.cur.
Optionaldef: stringReturn the log for this pod's name. This is a convenience
for Log.get(name).
Simple name of the pod such as "sys".
Get an immutable representation of this instance or throw NotImmutableErr if this object cannot be represented as an immutable:
Always return name().
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.
Find a type by name. If the type doesn't exist and checked is false then return null, otherwise throw UnknownTypeErr.
Optionalchecked: booleanUri for this pod which is always "fan://{name}".
Version number for this pod.
This method called whenever an it-block is applied to an
object. The default implementation calls the function with this,
and then returns this.
StaticechoWrite 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.
Optionalx: JsObjStaticfindFind a pod by name. If the pod doesn't exist and checked is false then return null, otherwise throw UnknownPodErr.
Optionalchecked: booleanStaticflattenExpand a set of pods to include all their recursive dependencies. This method does not order them; see orderByDepends.
StaticlistStaticloadLoad a pod into memory from the specified input stream. The
stream must contain a valid pod zip file with all the
definitions. The pod is completely loaded into memory and
the input stream is closed. The pod cannot have resources.
The pod name as defined by /pod.def must be uniquely named
or Err is thrown.
StaticofStaticorderOrder a list of pods by their dependencies. This method does not flatten dependencies - see flattenDepends.
Pod represents a module of Types. Pods serve as a type namespace as well as unit of deployment and versioning.