HelpSource/Classes/Nil.schelp

   1 class::Nil
   2 categories::Core
   3 summary::Represents uninitialized data
   4
   5 description::
   6
   7 Nil has a single instance named nil and is used to represent uninitialized data,
   8 bad values, or terminal values such as end-of-stream.
   9
  10 instancemethods::
  11
  12 private::do, reverseDo, pairsDo, collect, select, reject, detect, collectAs, selectAs, rejectAs, pop, source, source_, changed,         addDependant, removeDependant, release, update, swapThisGroup, performMsg, remove, seconds_, throw, superclassesDo, !?, play, printOn, storeOn, archiveAsCompileString, set, addDependant
  13
  14
  15 method::isNil
  16 Answers true because this is nil. In class Object this message is defined to answer false.
  17
  18 method::notNil
  19 Answer false. In class Object this message answers true.
  20
  21 method::?
  22
  23 return first non-nil argument. Since this IS nil then return anObject.
  24 In class link::Classes/Object::, ? is defined to answer the receiver.
  25
  26 method::??
  27 If the receiver is nil, value the function and return the result.  Since this IS nil, then value the function and return the result. In class Object, ?? is defined to answer the receiver.
  28
  29 method::add
  30 Returns an array with the value. This makes it unecessary to initialize when adding to a variable.
  31
  32 method::addAll
  33 Returns an array with all the values. This makes it unecessary to initialize when adding to a variable.
  34
  35 method::remove
  36 Returns nil. This makes it unecessary to initialize when adding to a variable.
  37
  38 method::++
  39 Returns an array with all the values. This makes it unecessary to initialize when adding to a variable.
  40
  41 method::booleanValue
  42 Returns false.
  43
  44 method::rate
  45 Returns nil.
  46
  47 method::numChannels
  48 Returns nil.
  49
  50 method::isPlaying
  51 Returns false.
  52
  53 method::dependants
  54 Returns an empty IdentitySet.
  55
  56 method::transformEvent
  57 Return the argument.
  58
  59 method::awake
  60 Returns nil.
  61
  62 method::nextTimeOnGrid
  63 Returns clock.nextTimeOnGrid.
  64
  65 method::asQuant
  66 Returns Quant.default.
  67
  68 method::matchItem
  69 Returns true.
  70
  71 method::add
  72 Returns an array with item.
  73
  74 method::addAll
  75 Returns array.asArray.
  76
  77 method::++
  78 Returns array.
  79
  80 method::asCollection
  81 Returns empty array.
  82
  83 method::get
  84 Returns prevVal.
  85
  86 method::addFunc
  87 Returns the function or a FunctionList.
  88
  89 method::removeFunc
  90 Returns Nil.
  91
  92 method::asSpec
  93 Returns the default ControlSpec
  94
  95 method::handleError
  96 Either report error or inspect error and halt execution.
  97
  98 method::push
  99 Executes function.
 100
 101 method::appendStream
 102 Retuns stream.
 103
 104 subsection::Dependancy
 105
 106 All the messages for the Dependancy protocol (See class link::Classes/Object::) are defined in class Nil
 107 to do nothing. This eliminates the need to check for nil when sending dependancy messages.
 108
 109 subsection::Other Methods
 110
 111 Many other messages are defined in class Nil to do nothing. This eliminates the need to check for nil.
 112
 113