API for Tree version 0.4.0

These methods are implemented by Tree version 0.4.0

cd

change value of currentPath

syntax:

currentNode

send message to the node specified by currentPath

syntax:

forceRemoveNode

remove a node and all its children

syntax:

isMethod

determine whether this dictionary has the named method.

returns the full path to the executable that implements the method for this Dictionary

syntax: isMethod methodName

returns the name of the executable.

resolve in this order:

local method: methodName

common method: Dictionary.methodName

isNode

determine if a path represents a valid node

syntax:

path is either relative or absolute

if relative, is relative to currentPath

returns:

the absolute path if it exists, null string otherwise.

ls

list all nodes that are children of the specified one

syntax:

makeNode

create a node in a Tree

syntax:

path may be absolute or relative to currentPath. cloneOf specifies an optional dictionary to clone.

makeRootNode

create root node of a Tree

syntax:

cloneOf specifies an optional dictionary to clone.

node

reference a node in a Tree

syntax:

path is either relative or absolute

if relative, is relative to currentPath

parseMessage

For a dictionary, parses a message and converts it to a canonical form of method arguments

specifically (apart from the normal key syntactic sugar),

path message converts to node path message

syntax:

returns a message in the form method arguments

NOTE This uses a deprecated methodology which is no longer consistent with other Offsiders. Should just override sugar instead.

removeNode

remove a node only if there are no children

syntax: $ removeNode path

rootNode

reference the root node of a Tree

syntax:

upgradeMe

version

walk

walk through the tree structure, sending a particular message to each node in turn

syntax:

start at node path

if depthFirst is specified, descend down into each node's children before sending the message to that node.

The default is to send the message to a node before descending down into that node's children.

(20090617 20:25:57) This page was produced by rsml2html using the file TreeAPI-0.4.0 as its source document