Fantom

 

pod

sys

Pod Facets

@podBuildHost = "BLAZE"
@podResDirs = [`locale/`]
@podBuildTime = DateTime("2010-02-02T10:27:34.781-05:00 New_York")
@podIndexFacets = [@sys::uriScheme]
@docsrc
@podBuildUser = "Brian"
@podDepends = Depend[,]
@podSrcDirs = [`fan/`]

Symbols

collection

Bool collection := false

Collection is a Bool marker facet used to annotate serializable types as a collection of child objects. All types which implement this facet must follow these rules where Item is the item type:

  • Provide an add(Item) method to add child items during readObj
  • Provide an each(|Item| f) method to iterate children item during writeObj

See the Serialization Doc for details.

deprecated

Bool deprecated := false

Indicates that a type or slot is obsolete

docsrc

Bool docsrc := false

This facet is used on pods to indicate whether the source code should be included in the documentation. By default source code it not included.

js

Bool js := false

Used to annoate types and slots which should be compiled into JavaScript.

nodoc

Bool nodoc := false

This facet is used on pod, public types, and slots to indicate they should not be documented with automated tools such as Fandoc. As a developer you should avoid using these types and slots since they are explicitly marked as not part of the public API.

podBuildHost

Str podBuildHost := ""

Pod facet for host machine used to build pod Facet is set automatically by compiler.

podBuildTime

DateTime? podBuildTime := null

Pod facet for time target was pod was built local to build host. Facet is set automatically by compiler.

podBuildUser

Str podBuildUser := ""

Pod facet for account used to build pod. Facet is set automatically by compiler.

podDepends

Depend[] podDepends := Depend[,]

Dependencies of the pod.

podDotnetDirs

Uri[]? podDotnetDirs := null

List of Uris relative to "pod.fan" of directories containing the C# source files to compile for .NET native methods.

podIndexFacets

Symbol[] podIndexFacets := Symbol[,]

List of facet symbols to index for the type database.

See Facet Indexing for details.

podJavaDirs

Uri[]? podJavaDirs := null

List of Uris relative to "pod.fan" of directories containing the Java source files to compile for Java native methods.

podJsDirs

Uri[]? podJsDirs := null

List of Uris relative to "pod.fan" of directories containing the JavaScript source files to compile for JavaScript native methods.

podResDirs

Uri[]? podResDirs := null

List of Uris relative to "pod.fan" of directories of resources files to package into pod zip file. Optional.

podSrcDirs

Uri[]? podSrcDirs := null

List of Uris relative to "pod.fan" of directories containing the Fan source files to compile.

serializable

Bool serializable := false

Serializable is a Bool marker facet used to annotate types which can be serialized. Objects are serialized via sys::OutStream.writeObj and deserialized via sys::InStream.readObj. Types which implement this facet or inherit it are serialized as a complex. If a type should be serialized atomically as a simple then implement the simple facet (never implement both). See the Serialization Doc for details.

simple

Bool simple := false

Simple is a Bool marker facet used to annotate types which are serialized automatically via a string representation. All types which implement this facet must follow these rules:

  • Override sys::Obj.toStr to return a suitable string representation of the object.
  • Must declare a static method called fromStr which takes one Str parameter and returns an instance of the declaring type. The fromStr method may contain additional parameters if they declare defaults.
transient

Bool transient := false

Transient is a facet used to annotate fields which should not be serialized inside a serializable type. See the Serialization Doc for details.

uriScheme

Str uriScheme := ""

Used on UriScheme subclasses to implement a URI scheme handler. See docLang.