|
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
2 <html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#"> |
|
3 <head> |
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
|
5 <title>API: test Assert.Error (YUI Library)</title> |
|
6 |
|
7 <link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" /> |
|
8 <link rel="stylesheet" type="text/css" href="assets/api.css" /> |
|
9 |
|
10 <script type="text/javascript" src="assets/api-js"></script> |
|
11 <script type="text/javascript" src="assets/ac-js"></script> |
|
12 </head> |
|
13 |
|
14 <body id="yahoo-com"> |
|
15 |
|
16 <div id="doc3" class="yui-t2"> |
|
17 <div id="hd"> |
|
18 <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1> |
|
19 <h3>test <span class="subtitle">3.0.0b1</span></h3> |
|
20 <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> |
|
21 > <a href="./module_test.html" title="test">test</a> |
|
22 > Assert.Error |
|
23 |
|
24 <form onsubmit="return false"> |
|
25 <div id="propertysearch"> |
|
26 Search: <input autocomplete="off" id="searchinput" /> |
|
27 <div id="searchresults"> |
|
28 |
|
29 </div> |
|
30 </div> |
|
31 </form> |
|
32 </div> |
|
33 |
|
34 <div id="bd"> |
|
35 <div id="yui-main"> |
|
36 <div class="yui-b"> |
|
37 <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form"> |
|
38 <fieldset> |
|
39 <legend>Filters</legend> |
|
40 <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span> |
|
41 <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span> |
|
42 <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span> |
|
43 </fieldset> |
|
44 </form> |
|
45 |
|
46 <h2> |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 Class <b property="yui:name">Assert.Error</b> |
|
52 <span class="extends"> |
|
53 </span> |
|
54 |
|
55 </h2> |
|
56 <!-- class tree goes here --> |
|
57 |
|
58 <dl class="subclasses" rel="yui:subclasses"> |
|
59 <dt>Known Subclasses:</dt> |
|
60 <dd> |
|
61 <span rel="yui:subclass" resource="Assert.ShouldError.html"> |
|
62 <a href="Assert.ShouldError.html" property="yui:name" title="Assert.ShouldError">Assert.ShouldError</a> |
|
63 </span> |
|
64 <span rel="yui:subclass" resource="Assert.UnexpectedError.html"> |
|
65 <a href="Assert.UnexpectedError.html" property="yui:name" title="Assert.UnexpectedError">Assert.UnexpectedError</a> |
|
66 </span> |
|
67 <span rel="yui:subclass" resource="Assert.UnexpectedValue.html"> |
|
68 <a href="Assert.UnexpectedValue.html" property="yui:name" title="Assert.UnexpectedValue">Assert.UnexpectedValue</a> |
|
69 </span> |
|
70 <span rel="yui:subclass" resource="Assert.ShouldFail.html"> |
|
71 <a href="Assert.ShouldFail.html" property="yui:name" title="Assert.ShouldFail">Assert.ShouldFail</a> |
|
72 </span> |
|
73 <span rel="yui:subclass" resource="Assert.ComparisonFailure.html"> |
|
74 <a href="Assert.ComparisonFailure.html" property="yui:name" title="Assert.ComparisonFailure">Assert.ComparisonFailure</a> |
|
75 </span> |
|
76 </dd> |
|
77 </dl> |
|
78 |
|
79 |
|
80 |
|
81 <div class="summary description" property="yui:description"> |
|
82 Error is thrown whenever an assertion fails. It provides methods |
|
83 to more easily get at error information and also provides a base class |
|
84 from which more specific assertion errors can be derived. |
|
85 </div> |
|
86 |
|
87 <div class="section constructor details" rel="yui:constructor" resource="#constructor"> |
|
88 <h3 id="constructor">Constructor</h3> |
|
89 <div class="content"> |
|
90 <div class="detail"> |
|
91 <strong property="yui:name">Assert.Error</strong> |
|
92 <code> |
|
93 ( |
|
94 |
|
95 |
|
96 |
|
97 message |
|
98 ) |
|
99 </code> |
|
100 <div class="description"> |
|
101 <dl rel="yui:parameters"> |
|
102 <dt>Parameters:</dt> |
|
103 <dd rel="yui:parameter"> |
|
104 <code><span property="yui:name">message</span> |
|
105 <<span property="yui:type">String</span>> |
|
106 </code> |
|
107 <span property="yui:description"> The message to display when the error occurs.</span> |
|
108 </dd> |
|
109 </dl> |
|
110 |
|
111 |
|
112 </div> |
|
113 </div> |
|
114 </div> |
|
115 </div> |
|
116 |
|
117 <div rel="yui:properties" resource="#properties"> |
|
118 <div class="section field details"> |
|
119 <h3 id="properties">Properties</h3> |
|
120 <div class="content"> |
|
121 <div class="" rel="yui:property" resource="#property_name"> |
|
122 <h4><a name="property_name" property="yui:name">name</a> |
|
123 - <code><span property="yui:type">String</span></code> |
|
124 </h4> |
|
125 <div class="detail"> |
|
126 <div class="description" property="yui:description"> |
|
127 The name of the error that occurred. |
|
128 </div> |
|
129 </div> |
|
130 |
|
131 |
|
132 |
|
133 |
|
134 <hr /> |
|
135 </div> |
|
136 </div> |
|
137 </div> |
|
138 |
|
139 </div> |
|
140 |
|
141 <div rel="yui:methods" resource="#methods"> |
|
142 <div class="section method details"> |
|
143 <h3 id="methods">Methods</h3> |
|
144 <div class="content"> |
|
145 <div class="" rel="yui:method" resource="#method_getMessage"> |
|
146 <h4> |
|
147 <a name="method_getMessage">getMessage</a></h4> |
|
148 <div class="detail" > |
|
149 <code> |
|
150 |
|
151 |
|
152 |
|
153 String |
|
154 <strong property="yui:name">getMessage</strong> |
|
155 ( |
|
156 ) |
|
157 </code> |
|
158 |
|
159 <div class="description" property="yui:description"> |
|
160 Returns a fully formatted error for an assertion failure. This should |
|
161 be overridden by all subclasses to provide specific information. |
|
162 </div> |
|
163 |
|
164 <div class="description"> |
|
165 |
|
166 |
|
167 <dl> |
|
168 <dt>Returns: |
|
169 <code property="yui:return"> |
|
170 String |
|
171 </code></dt> |
|
172 <dd property="yui:returnInfo">A string describing the error.</dd> |
|
173 </dl> |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 </div> |
|
179 |
|
180 </div> |
|
181 <hr /> |
|
182 </div> |
|
183 <div class="" rel="yui:method" resource="#method_toString"> |
|
184 <h4> |
|
185 <a name="method_toString">toString</a></h4> |
|
186 <div class="detail" > |
|
187 <code> |
|
188 |
|
189 |
|
190 |
|
191 String |
|
192 <strong property="yui:name">toString</strong> |
|
193 ( |
|
194 ) |
|
195 </code> |
|
196 |
|
197 <div class="description" property="yui:description"> |
|
198 Returns a string representation of the error. |
|
199 </div> |
|
200 |
|
201 <div class="description"> |
|
202 |
|
203 |
|
204 <dl> |
|
205 <dt>Returns: |
|
206 <code property="yui:return"> |
|
207 String |
|
208 </code></dt> |
|
209 <dd property="yui:returnInfo">A string representation of the error.</dd> |
|
210 </dl> |
|
211 |
|
212 |
|
213 |
|
214 |
|
215 </div> |
|
216 |
|
217 </div> |
|
218 <hr /> |
|
219 </div> |
|
220 <div class="" rel="yui:method" resource="#method_valueOf"> |
|
221 <h4> |
|
222 <a name="method_valueOf">valueOf</a></h4> |
|
223 <div class="detail" > |
|
224 <code> |
|
225 |
|
226 |
|
227 |
|
228 String |
|
229 <strong property="yui:name">valueOf</strong> |
|
230 ( |
|
231 ) |
|
232 </code> |
|
233 |
|
234 <div class="description" property="yui:description"> |
|
235 Returns a primitive value version of the error. Same as toString(). |
|
236 </div> |
|
237 |
|
238 <div class="description"> |
|
239 |
|
240 |
|
241 <dl> |
|
242 <dt>Returns: |
|
243 <code property="yui:return"> |
|
244 String |
|
245 </code></dt> |
|
246 <dd property="yui:returnInfo">A primitive value version of the error.</dd> |
|
247 </dl> |
|
248 |
|
249 |
|
250 |
|
251 |
|
252 </div> |
|
253 |
|
254 </div> |
|
255 <hr /> |
|
256 </div> |
|
257 </div> |
|
258 </div> |
|
259 |
|
260 </div> |
|
261 |
|
262 <div rel="yui:events" resource="#events"> |
|
263 |
|
264 |
|
265 </div> |
|
266 |
|
267 <div rel="yui:attributes" resource="#configattributes"> |
|
268 |
|
269 </div> |
|
270 |
|
271 </div> |
|
272 </div> |
|
273 <div class="yui-b"> |
|
274 <div class="nav"> |
|
275 |
|
276 <div id="moduleList" class="module"> |
|
277 <h4>Modules</h4> |
|
278 <ul class="content"> |
|
279 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
280 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
281 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
282 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
283 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
284 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
285 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
286 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
287 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
288 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
289 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
290 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
291 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
292 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
293 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
294 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
295 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
296 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
297 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
298 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
299 <li class=""><a href="module_io.html" title="io">io</a></li> |
|
300 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
301 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
302 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
303 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
304 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
305 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
306 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
307 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
308 <li class=""><a href="module_queue.html" title="queue">queue</a></li> |
|
309 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
310 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
311 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
312 <li class="selected"><a href="module_test.html" title="test">test</a></li> |
|
313 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
314 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
315 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
316 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
317 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
318 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
319 </ul> |
|
320 </div> |
|
321 |
|
322 <div id="classList" class="module"> |
|
323 <h4>Classes</h4> |
|
324 <ul class="content"> |
|
325 <li class=""><a href="Assert.html" title="Assert">Assert</a></li> |
|
326 <li class=""><a href="Assert.ComparisonFailure.html" title="Assert.ComparisonFailure">Assert.ComparisonFailure</a></li> |
|
327 <li class="selected"><a href="Assert.Error.html" title="Assert.Error">Assert.Error</a></li> |
|
328 <li class=""><a href="Assert.ObjectAssert.html" title="Assert.ObjectAssert">Assert.ObjectAssert</a></li> |
|
329 <li class=""><a href="Assert.ShouldError.html" title="Assert.ShouldError">Assert.ShouldError</a></li> |
|
330 <li class=""><a href="Assert.ShouldFail.html" title="Assert.ShouldFail">Assert.ShouldFail</a></li> |
|
331 <li class=""><a href="Assert.UnexpectedError.html" title="Assert.UnexpectedError">Assert.UnexpectedError</a></li> |
|
332 <li class=""><a href="Assert.UnexpectedValue.html" title="Assert.UnexpectedValue">Assert.UnexpectedValue</a></li> |
|
333 <li class=""><a href="Test.ArrayAssert.html" title="Test.ArrayAssert">Test.ArrayAssert</a></li> |
|
334 <li class=""><a href="Test.Case.html" title="Test.Case">Test.Case</a></li> |
|
335 <li class=""><a href="Test.DateAssert.html" title="Test.DateAssert">Test.DateAssert</a></li> |
|
336 <li class=""><a href="Test.Format.Mock.html" title="Test.Format.Mock">Test.Format.Mock</a></li> |
|
337 <li class=""><a href="Test.Manager.html" title="Test.Manager">Test.Manager</a></li> |
|
338 <li class=""><a href="Test.Reporter.html" title="Test.Reporter">Test.Reporter</a></li> |
|
339 <li class=""><a href="Test.Runner.html" title="Test.Runner">Test.Runner</a></li> |
|
340 <li class=""><a href="Test.Suite.html" title="Test.Suite">Test.Suite</a></li> |
|
341 <li class=""><a href="Test.TestNode.html" title="Test.TestNode">Test.TestNode</a></li> |
|
342 <li class=""><a href="Test.Wait.html" title="Test.Wait">Test.Wait</a></li> |
|
343 </ul> |
|
344 </div> |
|
345 |
|
346 <div id="fileList" class="module"> |
|
347 <h4>Files</h4> |
|
348 <ul class="content"> |
|
349 <li class=""><a href="ArrayAssert.js.html" title="ArrayAssert.js">ArrayAssert.js</a></li> |
|
350 <li class=""><a href="Assert.js.html" title="Assert.js">Assert.js</a></li> |
|
351 <li class=""><a href="DateAssert.js.html" title="DateAssert.js">DateAssert.js</a></li> |
|
352 <li class=""><a href="Mock.js.html" title="Mock.js">Mock.js</a></li> |
|
353 <li class=""><a href="ObjectAssert.js.html" title="ObjectAssert.js">ObjectAssert.js</a></li> |
|
354 <li class=""><a href="TestCase.js.html" title="TestCase.js">TestCase.js</a></li> |
|
355 <li class=""><a href="TestFormat.js.html" title="TestFormat.js">TestFormat.js</a></li> |
|
356 <li class=""><a href="TestManager.js.html" title="TestManager.js">TestManager.js</a></li> |
|
357 <li class=""><a href="TestReporter.js.html" title="TestReporter.js">TestReporter.js</a></li> |
|
358 <li class=""><a href="TestRunner.js.html" title="TestRunner.js">TestRunner.js</a></li> |
|
359 <li class=""><a href="TestSuite.js.html" title="TestSuite.js">TestSuite.js</a></li> |
|
360 </ul> |
|
361 </div> |
|
362 |
|
363 <div id="propertyList" class="module"> |
|
364 <h4>Properties</h4> |
|
365 <ul class="content"> |
|
366 <li class=""><a href="#property_name" title="name">name</a></li> |
|
367 </ul> |
|
368 </div> |
|
369 |
|
370 <div id="methodsList" class="module"> |
|
371 <h4>Methods</h4> |
|
372 <ul class="content"> |
|
373 <li class=""><a href="#method_getMessage" title="getMessage">getMessage</a></li> |
|
374 <li class=""><a href="#method_toString" title="toString">toString</a></li> |
|
375 <li class=""><a href="#method_valueOf" title="valueOf">valueOf</a></li> |
|
376 </ul> |
|
377 </div> |
|
378 |
|
379 |
|
380 |
|
381 </div> |
|
382 </div> |
|
383 </div> |
|
384 <div id="ft"> |
|
385 <hr /> |
|
386 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
387 </div> |
|
388 </div> |
|
389 <script type="text/javascript"> |
|
390 ALL_YUI_PROPS = [{"access": "", "host": "Assert", "name": "areEqual", "url": "Assert.html#method_areEqual", "type": "method"}, {"access": "", "host": "Assert", "name": "areNotEqual", "url": "Assert.html#method_areNotEqual", "type": "method"}, {"access": "", "host": "Assert", "name": "areNotSame", "url": "Assert.html#method_areNotSame", "type": "method"}, {"access": "", "host": "Assert", "name": "areSame", "url": "Assert.html#method_areSame", "type": "method"}, {"access": "private", "host": "Assert", "name": "_asserts", "url": "Assert.html#property__asserts", "type": "property"}, {"access": "", "host": "Assert", "name": "fail", "url": "Assert.html#method_fail", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_formatMessage", "url": "Assert.html#method__formatMessage", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_getCount", "url": "Assert.html#method__getCount", "type": "method"}, {"access": "", "host": "Assert.Error", "name": "getMessage", "url": "Assert.Error.html#method_getMessage", "type": "method"}, {"access": "protected", "host": "Assert", "name": "_increment", "url": "Assert.html#method__increment", "type": "method"}, {"access": "", "host": "Assert", "name": "isArray", "url": "Assert.html#method_isArray", "type": "method"}, {"access": "", "host": "Assert", "name": "isBoolean", "url": "Assert.html#method_isBoolean", "type": "method"}, {"access": "", "host": "Assert", "name": "isFalse", "url": "Assert.html#method_isFalse", "type": "method"}, {"access": "", "host": "Assert", "name": "isFunction", "url": "Assert.html#method_isFunction", "type": "method"}, {"access": "", "host": "Assert", "name": "isInstanceOf", "url": "Assert.html#method_isInstanceOf", "type": "method"}, {"access": "", "host": "Assert", "name": "isNaN", "url": "Assert.html#method_isNaN", "type": "method"}, {"access": "", "host": "Assert", "name": "isNotNaN", "url": "Assert.html#method_isNotNaN", "type": "method"}, {"access": "", "host": "Assert", "name": "isNotNull", "url": "Assert.html#method_isNotNull", "type": "method"}, {"access": "", "host": "Assert", "name": "isNotUndefined", "url": "Assert.html#method_isNotUndefined", "type": "method"}, {"access": "", "host": "Assert", "name": "isNull", "url": "Assert.html#method_isNull", "type": "method"}, {"access": "", "host": "Assert", "name": "isNumber", "url": "Assert.html#method_isNumber", "type": "method"}, {"access": "", "host": "Assert", "name": "isObject", "url": "Assert.html#method_isObject", "type": "method"}, {"access": "", "host": "Assert", "name": "isString", "url": "Assert.html#method_isString", "type": "method"}, {"access": "", "host": "Assert", "name": "isTrue", "url": "Assert.html#method_isTrue", "type": "method"}, {"access": "", "host": "Assert", "name": "isTypeOf", "url": "Assert.html#method_isTypeOf", "type": "method"}, {"access": "", "host": "Assert", "name": "isUndefined", "url": "Assert.html#method_isUndefined", "type": "method"}, {"access": "", "host": "Assert.Error", "name": "name", "url": "Assert.Error.html#property_name", "type": "property"}, {"access": "protected", "host": "Assert", "name": "_reset", "url": "Assert.html#method__reset", "type": "method"}, {"access": "", "host": "Assert.Error", "name": "toString", "url": "Assert.Error.html#method_toString", "type": "method"}, {"access": "", "host": "Assert.Error", "name": "valueOf", "url": "Assert.Error.html#method_valueOf", "type": "method"}, {"access": "", "host": "Assert", "name": "Y.assert", "url": "Assert.html#method_Y.assert", "type": "method"}, {"access": "", "host": "Assert", "name": "Y.fail", "url": "Assert.html#method_Y.fail", "type": "method"}]; |
|
391 </script> |
|
392 </body> |
|
393 </html> |