IStencil

References
public interface IStencil
Defines a somewhat mutable, fully allocated tree to be populated at leisure. In a way this interface acts as a TreeBuilder pattern, but it is not called TreeBuilder because the size of the tree it populates must be set at construction. Maybe at some point in the future a fully mutable builder pattern will be provided in the api.

Properties

StencilAccess

#
Access StencilAccess { get; }
Gets the access level for this stencil. Only those SetXXXX methods which are compatible with the access will work, the remainder will throw exceptions.

Methods

SetArray

#
void SetArray(int twigIndex, Array items, MetaData[] metas, bool[] nulls)
Set all items, meta data and null flags at the specified coverage.
Parameters:
twigIndex (int)
items (Array)
metas (MetaData[])
nulls (bool[])

SetArray

#
void SetArray(int twigIndex, Array items, MetaData[] metas)
Set all items and meta data at the specified coverage.
Parameters:
twigIndex (int)
items (Array)
metas (MetaData[])

SetArray

#
void SetArray(int twigIndex, Array items)
Set all items at the specified coverage.
Parameters:
twigIndex (int)
items (Array)

SetItem

#
void SetItem(int twigIndex, int itemIndex, object item, MetaData meta)
Set the item and meta data values at the specified coverage site.
Parameters:
twigIndex (int)
itemIndex (int)
item (object)
meta (MetaData)

SetItem

#
void SetItem(int twigIndex, int itemIndex, object item)
Set the item value at the specified coverage site.
Parameters:
twigIndex (int)
itemIndex (int)
item (object)

SetPear

#
void SetPear(int twigIndex, int itemIndex, IPear pear)
Set the item, meta data and null values at the specified coverage site.
Parameters:
twigIndex (int)
itemIndex (int)
pear (IPear)

SetTree

#
void SetTree(int pathIndex, ITree tree)
Set an entire tree at the specified coverage site.
Parameters:
pathIndex (int)
tree (ITree)

SetTwig

#
void SetTwig(int twigIndex, ITwig twig)
Set an entire twig at the specified coverage.
Parameters:
twigIndex (int)
twig (ITwig)

ToTree

#
ITree ToTree()
Gets the data tree representing the current state of the stencil.