abstract-object

AbtractObject

AbstractObject with Object State Events Supports and free method provides.

The derived class should overwrite the initialize and finalize methods.

• Methods:

  • create(class, ...): the create class method uses to create a new object instance(the util.createObject is the same function).
    • class: the class constructor to create a new instance.
    • ...: the left arguments will be passed into the class constructor.
  • createWith(class, arguments): the createWith class method uses to create a new object instance(the util.createObjectWith is the same function).
    • class: the class constructor to create a new instance.
    • arguments (array): the arguments will be passed into the class constructor.
  • initialize(...): abstract initialization method after a new instance creating.
    • ...: the constructor's arguments should be passed into initialize method.
  • finalize(...): abstract finalization method before the instance destroying.
    • ...: the free(destroy)'s arguments should be passed into finalize method.
  • (deprecated) init(...): abstract initialization method after a new instance creating.
    • init method is deprecated, pls use initialize method instead
    • ...: the constructor's arguments should be passed into init method.
  • (deprecated) final(...): abstract finalization method before the instance destroying.
    • final method is deprecated, pls use finalize instead
    • ...: the free(destroy)'s arguments should be passed into final method.
  • free(...): free the class instance.
    • ...: optional arguments will be passed into final method to process.
  • dispatch(event, args[, callback]): dispath an event or callback
    • event: the event name
    • args: the args are passed to event or callback
    • callback: optional, it will not dispatch event if the callback is exists, unless the callback return false.
  • dispatchError(error[, callback]):
    • error: the error instance.
    • callback: optional, it will not dispatch 'error' event if the callback is exists, unless the callback return false.
  • isIniting(), isInited(),isDestroying(), isDestroyed() object state testing methods:
    • to test object state

• Events:

  • 'initing': emit before the initialize method
  • 'inited': emit after the initialize method
  • 'destroying': emit before the finalize method
  • 'destroyed': emit after the finalize method

RefObject

The RefObject is derived from AbstractObject. and add the RefCount and AddRef/Release Supports.

• methods:
  • release/free: Decrements reference count for this instance. If it is becoming less than 0, the object would be (self) destroyed.
  • addRef: Increments the reference count for this instance and returns the new reference count.

Usage:

AbstractObject = require('abstract-object')
RefObject = require('abstract-object/RefObject')
inherits = require('abstract-object/lib/util/inherits')
createObject = AbstractObject.createObject

class MyObject
  inherits MyObject, RefObject
  initialize: (@a,@b)->
    super

myObj = createObject(MyObject, 1, 2)

# if you do not wanna use `AbstractObject.create`, you MUST remember this:
# even the constructor is empty, you should call the parent's constructor manually.
# myObj = new MyObject()

class MyObject
  inherits MyObject, RefObject
  constructor: ->
    # must call super method here:
    super
  initialize: (@a,@b)->
    # must call super method here for RefObject initialization:
    super

the javascript:

var AbstractObject = require('abstract-object')
var RefObject = require('abstract-object/RefObject')
var util = require('abstract-object/lib/util')
var createObject = AbstractObject.createObject

//if you do not wanna to use the 'AbstractObject.create'(createObject):
var MyObject = function() {
  //super call
  MyObject.__super__.constructor.apply(this, arguments);
}
// or, this MUST use 'AbstractObject.create'
var MyObject = function(){}


util.inherits(MyObject, RefObject)


MyObject.prototype.initialize = function(a,b) {
  //super call
  MyObject.__super__.initialize.call(this);
  this.a = a
  this.b = b
}


var myObj = createObject(MyObject, 1, 2)
//or this,  must overwrite the constructor and call the super constructor.
var myObj = new MyObject(1,2)

AbstractError Classes

AbstractError

All Errors are derived from the AbstractError.

• Members:
  • message: the error message.
  • code: the error code.
• Methods:
  • ok()
  • notFound()
  • ....
  • invalidFormat()
• Class Methods:
  • AbstractError.isOk(err)
  • AbstractError.isNotFound(err)
  • ...

the error codes:

• AbstractError.Ok = 0
• AbstractError.NotFound = 1
• AbstractError.Corruption = 2
• AbstractError.NotSupported = 3
• AbstractError.InvalidArgument = 4
• AbstractError.IO = 5
• AbstractError.NotOpened = 6
• AbstractError.InvalidType = 7
• AbstractError.InvalidFormat = 8

Other Error Classes:

• NotFoundError
• CorruptionError
• NotSupportedError/NotImplementedError
• InvalidArgumentError
• IOError
• NotOpenedError
• InvalidTypeError
• InvalidFormatError

Extends the AbstractError

use the createError function can extend the AbstractError.

createError(typeName, errorCode[, parentErrorClass])

arguments

• typeName (string): the error type name, the first character must be upper case.
• errorCode: (number): the error code, it should be greater than 1000.
• parentErrorClass: (class): the optional parent error class. defaults to AbstractError.

return

• the error class

Usage

var Errors = require("abstract-object/Error")
var AbstractError = Errors.AbstractError
var createError = Errors.createError


var AlreadyReadError = createError('AlreadyRead', 10000)

var err = new AlreadyReadError("already read over error.")

assert.ok(AbstractError.isAlreadyRead(err))
assert.ok(AlreadyReadError.isAlreadyRead(err))
assert.ok(err.alreadyRead())
assert.equal(err.message, "already read over error.")
assert.equal(err.code, 10000)