Class Object

Object (class instance) type basic object model metaclass.

class Object \ from BOM

Summary

apply()Applies the values in a dictionary to the corresponding properties.
attributes()Returns a dictionary containing annotation attributes of the given object.
comp()Appends elements to this object through a filter.
getProperty()Returns the value of a property in an object.
getState()Return the current state of an object.
mcomp()Appends elements to this object through a filter.
mfcomp()Appends elements to this object through a filter.
properties()Returns all the properties in the object.
retrieve()Gets the values stored in the properties of this object.
setProperty()Sets the value of a proprety in this object
setState()Change the current active state of an object.

Inherited methods

__add from BOM Overrides binary addition operand.
__call from BOM Overrides call operator "self()".
__dec from BOM Overrides decrement unary prefix operand.
__decpost from BOM Overrides decrement unary postfix operand.
__div from BOM Overrides binary division operand.
__getIndex from BOM Overrides array access operator []
__inc from BOM Overrides increment unary prefix operand.
__incpost from BOM Overrides increment unary postifx operand.
__mod from BOM Overrides modulo operand.
__mul from BOM Overrides binary multiplication operand.
__pow from BOM Overrides power operand.
__setIndex from BOM Overrides array write operator []
__sub from BOM Overrides binary subtraction operand.
baseClass from BOM Returns the class item from which an object has been instantiated.
bound from BOM Determines if an item is bound or not.
className from BOM Returns the name of the class an instance is instantiated from.
clone from BOM Performs a deep copy of the item.
compare from BOM Performs a lexicographical comparison.
derivedFrom from BOM Checks if this item has a given parent.
describe from BOM Returns the deep contents of an item on a string representation.
isCallable from BOM Determines if an item is callable.
len from BOM Retrieves the length of a collection
metaclass from BOM Returns the metaclass associated with this item.
ptr from BOM Returns a raw memory pointer out of this data (as an integer).
serialize from BOM Serialize the item on a stream for persistent storage.
toString from BOM Coverts the object to string.
typeId from BOM Returns an integer indicating the type of this item.

Methods

apply()

Applies the values in a dictionary to the corresponding properties.

Object.apply( dict )

dictA "stamp" dictionary.
Returns:This same object.
Raises:
AccessErrorif some property listed in the dictionary is not defined.

This method applies a "stamp" on this object. The idea is that of copying the contents of all the items in the dictionary into the properties of this object. Dictionaries are more flexible than objects, at times they are preferred for i.e. network operations and key/value databases. With this method, you can transfer data from a dictionary in an object with a single VM step, paying just the cost of the copy; in other words, sparing the VM operations needed for looping over the dictionary and searching dynamically the required properties.

Note: Non-string keys in dict are simply skipped.

attributes()

Returns a dictionary containing annotation attributes of the given object.

Object.attributes( )

Returns:Nil if the object has no attributes, or a string-indexed dictionary.

If the object is a class instance, this method will return the attributes of the generator class.

comp()

Appends elements to this object through a filter.

Object.comp( source, [filter] )

sourceOne sequence, range or callable generating items.
filterA filtering function receiving one item at a time.
Returns:This object.

This method extracts one item at a time from the source, and calls repeatedly the append method of this object.

Please, see the description of Sequence.comp.

getProperty()

Returns the value of a property in an object.

Object.getProperty( propName )

propNameA string representing the name of a property or a method inside the object.
Returns:the property
Raises:
AccessErrorif the property can't be found.

An item representing the property is returned. The returned value is actually a copy of the property; assigning a new value to it won't have any effect on the original object.

If the property is a method, a callable method item is returned. If the property is not found, an error of class RangeError is raised.

getState()

Return the current state of an object.

Object.getState( )

Returns:A string representing the current state of an object, or nil if the object is stateless.

This function returns the current state in which an object is operating.

mcomp()

Appends elements to this object through a filter.

Object.mcomp( ... )

...One or more sequences, ranges or callables generating items.
Returns:This object.

This method sends the data generated from multiple comprehension, to the append method of this object.

Please, see the description of Sequence.comp.

mfcomp()

Appends elements to this object through a filter.

Object.mfcomp( filter, ... )

filterA filter function receiving each element before its insertion, or nil.
...One or more sequences, ranges or callables generating items.
Returns:This object.

This method performs a filtered multiple comprehension and and calls repeatedly the append method of this object, passing the output of the filter function to it each time. If the filter function returns an oob(1), the step is skipped and the append method is not called.

Please, see the description of Sequence.comp.

properties()

Returns all the properties in the object.

Object.properties( )

Returns:An array of strings representing property names.

This method returns all the properties in this object.

The property list includes properties that refer to any kind of data, including functions (that is, methods), but it doesn't include properties in the metaclass of this item (FBOM properties).

The returned list is ordered by UNICODE value of the property names.

Note: Subclasses are seen as properties, so they will returned in the list too.

retrieve()

Gets the values stored in the properties of this object.

Object.retrieve( [dict] )

dictA "stamp" dictionary.
Returns:A dictionary containing the contents of each property (stored as a key in the dictionary).
Raises:
AccessErrorif some property listed in the dictionary is not defined.

This method takes all the data values stored in the properties of this object (ignoring methods), and places them in a dictionary. Property names are used as keys under which to store flat copies of the property values.

If a dict parameter is passed, this method will take only the properties stored as keys, and eventually raise an AccessError if some of them are not found.

Otherwise, a new dictionary will be filled with all the properties in this object.

Note: In case of repeated activity, the same dictionary can be used to fetch new values to spare memory and CPU.

setProperty()

Sets the value of a proprety in this object

Object.setProperty( propName, value )

propNameA string representing the name of a property or a method inside the object.
valueThe property new value.
Raises:
AccessErrorIf the property can't be found.

Alters the value of the property in the given object. If the required property is not present, an AccessError is raised.

setState()

Change the current active state of an object.

Object.setState( nstate )

nstateThe new state into which the object is moved.
Returns:Return value of the __leave -> __enter sequence, if any, or nil
Raises:
CodeErrorif the state is not part of the object state.

This method changes the state of the object, applying a new set of function described in the state section.


Made with faldoc 2.2.0