| 1 | <!DOCTYPE html> <html> <head> <title>NullLoggable.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <div id="jump_to"> Jump To … <div id="jump_wrapper"> <div id="jump_page"> <a class="source" href="ByteIterable.html"> ByteIterable.coffee </a> <a class="source" href="ByteIterator.html"> ByteIterator.coffee </a> <a class="source" href="ArrayByteIterable.html"> ArrayByteIterable.coffee </a> <a class="source" href="ByteIterableBase.html"> ByteIterableBase.coffee </a> <a class="source" href="ByteIterableUtil.html"> ByteIterableUtil.coffee </a> <a class="source" href="LightOutputStream.html"> LightOutputStream.coffee </a> <a class="source" href="StoreConfiguration.html"> StoreConfiguration.coffee </a> <a class="source" href="Reader.html"> Reader.coffee </a> <a class="source" href="Writer.html"> Writer.coffee </a> <a class="source" href="List.html"> List.coffee </a> <a class="source" href="ListNode.html"> ListNode.coffee </a> <a class="source" href="Cursor.html"> Cursor.coffee </a> <a class="source" href="DatabaseRoot.html"> DatabaseRoot.coffee </a> <a class="source" href="Environment.html"> Environment.coffee </a> <a class="source" href="EnvironmentConfig.html"> EnvironmentConfig.coffee </a> <a class="source" href="Store.html"> Store.coffee </a> <a class="source" href="Transaction.html"> Transaction.coffee </a> <a class="source" href="Addr64.html"> Addr64.coffee </a> <a class="source" href="DataIterator.html"> DataIterator.coffee </a> <a class="source" href="Log.html"> Log.coffee </a> <a class="source" href="LogCache.html"> LogCache.coffee </a> <a class="source" href="LogConfig.html"> LogConfig.coffee </a> <a class="source" href="LogUtil.html"> LogUtil.coffee </a> <a class="source" href="Loggable.html"> Loggable.coffee </a> <a class="source" href="LoggableFactory.html"> LoggableFactory.coffee </a> <a class="source" href="LoggableIterator.html"> LoggableIterator.coffee </a> <a class="source" href="LoggableToWrite.html"> LoggableToWrite.coffee </a> <a class="source" href="NullLoggable.html"> NullLoggable.coffee </a> <a class="source" href="RandomAccessByteIterable.html"> RandomAccessByteIterable.coffee </a> <a class="source" href="RandomAccessLoggable.html"> RandomAccessLoggable.coffee </a> <a class="source" href="RandomAccessLoggableIterator.html"> RandomAccessLoggableIterator.coffee </a> <a class="source" href="StackList.html"> StackList.coffee </a> <a class="source" href="CompoundByteIterable.html"> CompoundByteIterable.coffee </a> <a class="source" href="CompoundByteIteratorBase.html"> CompoundByteIteratorBase.coffee </a> <a class="source" href="CompressedUnsignedLongByteIterable.html"> CompressedUnsignedLongByteIterable.coffee </a> <a class="source" href="FixedLengthByteIterable.html"> FixedLengthByteIterable.coffee </a> </div> </div> </div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> NullLoggable.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre><span class="nv">RandomAccessLoggable =</span>
|
| 2 | <span class="p">(</span><span class="nx">require</span> <span class="s1">'./RandomAccessLoggable.coffee'</span><span class="p">).</span><span class="nx">RandomAccessLoggable</span>
|
| 3 | <span class="nv">RandomAccessByteIterable =</span>
|
| 4 | <span class="p">(</span><span class="nx">require</span> <span class="s1">'./RandomAccessByteIterable.coffee'</span><span class="p">).</span><span class="nx">RandomAccessByteIterable</span>
|
| 5 | <span class="nv">IllegalStateError =</span>
|
| 6 | <span class="p">(</span><span class="nx">require</span> <span class="s1">'../errors/IllegalStateError.coffee'</span><span class="p">).</span><span class="nx">IllegalStateError</span></pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> <p>This class is a stub for empty logable. It has only type, no id and data.</p> </td> <td class="code"> <div class="highlight"><pre><span class="k">class</span> <span class="nx">NullLoggable</span> <span class="k">extends</span> <span class="nx">RandomAccessLoggable</span>
|
| 7 | <span class="vi">@TYPE: </span><span class="mi">0</span>
|
| 8 | <span class="vi">@LENGTH: </span><span class="mi">1</span></pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> <p>Constructor</p>
|
| 9 |
|
| 10 | <p>@param address the addres of this loggable.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@create</span><span class="nv">$Addr64: </span><span class="nf">(address, o) -></span>
|
| 11 | <span class="k">if</span> <span class="o">!</span><span class="nx">o</span><span class="o">?</span> <span class="k">then</span> <span class="nv">o = </span><span class="k">new</span> <span class="nx">NullLoggable</span>
|
| 12 | <span class="nv">o = </span><span class="nx">RandomAccessLoggable</span><span class="p">.</span>
|
| 13 | <span class="nx">create$Addr64$int$int$RandomAccessByteIterable$int$int</span><span class="p">(</span>
|
| 14 | <span class="nx">address</span><span class="p">,</span> <span class="nx">NullLoggable</span><span class="p">.</span><span class="nx">TYPE</span><span class="p">,</span> <span class="nx">NullLoggable</span><span class="p">.</span><span class="nx">LENGTH</span><span class="p">,</span>
|
| 15 | <span class="nx">RandomAccessByteIterable</span><span class="p">.</span><span class="nx">EMPTY</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="nx">NullLoggable</span><span class="p">.</span><span class="nx">NO_STRUCTURE_ID</span><span class="p">,</span> <span class="nx">o</span><span class="p">)</span>
|
| 16 | <span class="k">return</span> <span class="nx">o</span>
|
| 17 |
|
| 18 | <span class="nv">getData: </span><span class="nf">() -></span>
|
| 19 | <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalStateError</span><span class="p">(</span><span class="s2">"Can't access NullLoggable.getData()"</span><span class="p">)</span>
|
| 20 |
|
| 21 | <span class="nv">getDataLength: </span><span class="nf">() -></span>
|
| 22 | <span class="k">throw</span> <span class="k">new</span> <span class="nx">IllegalStateError</span><span class="p">(</span><span class="s2">"Can't access NullLoggable.getDataLength()"</span><span class="p">)</span></pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> <p>Create new NullLoggable.</p>
|
| 23 |
|
| 24 | <p>@return new NullLoggable.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="vi">@create: </span><span class="nf">() -></span>
|
| 25 | <span class="k">return</span> <span class="nx">NullLoggable</span><span class="p">.</span><span class="nx">create$Addr64</span> <span class="kc">undefined</span></pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> <p>Check whether loggable is NullLoggable.</p>
|
| 26 |
|
| 27 | <p>@param type the type to check.
|
| 28 | @return true is the loggable or type is NullLoggable and false otherwise.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@isNullLoggable</span><span class="nv">$int: </span><span class="nf">(type) -></span>
|
| 29 | <span class="k">return</span> <span class="nx">type</span> <span class="o">==</span> <span class="nx">NullLoggable</span><span class="p">.</span><span class="nx">TYPE</span></pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> <p>Check whether loggable is NullLoggable.</p>
|
| 30 |
|
| 31 | <p>@param loggable the loggable to check.
|
| 32 | @return true is the loggable or type is NullLoggable and false otherwise.</p> </td> <td class="code"> <div class="highlight"><pre> <span class="nx">@isNullLoggable</span><span class="nv">$Loggable: </span><span class="nf">(loggable) -></span>
|
| 33 | <span class="k">return</span> <span class="nx">NullLoggable</span><span class="p">.</span><span class="nx">isNullLoggable$int</span> <span class="nx">loggable</span><span class="p">.</span><span class="nx">getType</span><span class="p">()</span>
|
| 34 |
|
| 35 | <span class="nv">exports.NullLoggable = </span><span class="nx">NullLoggable</span>
|
| 36 |
|
| 37 | </pre></div> </td> </tr> </tbody> </table> </div> </body> </html> |
| \ | No newline at end of file |