Fantom

 

const final class

sys::Pod

sys::Obj
  sys::Pod

Pod represents a module of Types. Pods serve as a type namespace as well as unit of deployment and versioning.

Slots

configSource

Str? config(Str name, Str? def := null)

Convenience for Env.config.

dependsSource

Depend[] depends()

Get the declared list of dependencies for this pod.

docSource

Str? doc()

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"]
fileSource

File? file(Uri uri, Bool checked := true)

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
filesSource

File[] files()

List all the resource files contained by this pod. Resources are any files included in the pod's zip file excluding fcode files. The URI of these files is rooted by uri. Use file or Uri.get to lookup a resource file.

findSource

static Pod? find(Str name, Bool checked := true)

Find a pod by name. If the pod doesn't exist and checked is false then return null, otherwise throw UnknownPodErr.

listSource

static Pod[] list()

Get a list of all the pods installed. Note that currently this method will load all of the pods into memory, so it is an expensive operation.

loadSource

static Pod load(InStream in)

Load a pod into memory from the specified input stream. The stream must contain a valid pod zip file with the 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.

localeSource

Str? locale(Str name, Str? def := "name")

Convenience for Env.locale using Locale.cur.

logSource

Log log()

Return the log for this pod's name. This is a convenience for Log.get(name).

metaSource

Str:Str meta()

Get the meta name/value pairs for this pod. See docLang.

nameSource

Str name()

Simple name of the pod such as "sys".

ofSource

static Pod? of(Obj obj)

Get the pod of the given instance which is convenience for Type.of(obj).pod. See Type.pod.

propsSource

Str:Str props(Uri uri, Duration maxAge)

Convenience for Env.props.

toStrSource

override Str toStr()

Overrides sys::Obj.toStr

Always return name().

typeSource

Type? type(Str name, Bool checked := true)

Find a type by name. If the type doesn't exist and checked is false then return null, otherwise throw UnknownTypeErr.

typesSource

Type[] types()

List of the all defined types.

uriSource

Uri uri()

Uri for this pod which is always "fan://{name}".

versionSource

Version version()

Version number for this pod.