/tools/nunit/nunit.framework.xml

http://github.com/joaofx/simpletemplate · XML · 10088 lines · 10069 code · 19 blank · 0 comment · 0 complexity · f12a93c9c401bf3d96484924713dcb1f MD5 · raw file

Large files are truncated click here to view the full file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>nunit.framework</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NUnit.Framework.Constraints.TypeConstraint">
  8. <summary>
  9. TypeConstraint is the abstract base for constraints
  10. that take a Type as their expected value.
  11. </summary>
  12. </member>
  13. <member name="T:NUnit.Framework.Constraints.Constraint">
  14. <summary>
  15. The Constraint class is the base of all built-in constraints
  16. within NUnit. It provides the operator overloads used to combine
  17. constraints.
  18. </summary>
  19. </member>
  20. <member name="T:NUnit.Framework.Constraints.IResolveConstraint">
  21. <summary>
  22. The IConstraintExpression interface is implemented by all
  23. complete and resolvable constraints and expressions.
  24. </summary>
  25. </member>
  26. <member name="M:NUnit.Framework.Constraints.IResolveConstraint.Resolve">
  27. <summary>
  28. Return the top-level constraint for this expression
  29. </summary>
  30. <returns></returns>
  31. </member>
  32. <member name="F:NUnit.Framework.Constraints.Constraint.UNSET">
  33. <summary>
  34. Static UnsetObject used to detect derived constraints
  35. failing to set the actual value.
  36. </summary>
  37. </member>
  38. <member name="F:NUnit.Framework.Constraints.Constraint.actual">
  39. <summary>
  40. The actual value being tested against a constraint
  41. </summary>
  42. </member>
  43. <member name="F:NUnit.Framework.Constraints.Constraint.displayName">
  44. <summary>
  45. The display name of this Constraint for use by ToString()
  46. </summary>
  47. </member>
  48. <member name="F:NUnit.Framework.Constraints.Constraint.argcnt">
  49. <summary>
  50. Argument fields used by ToString();
  51. </summary>
  52. </member>
  53. <member name="F:NUnit.Framework.Constraints.Constraint.builder">
  54. <summary>
  55. The builder holding this constraint
  56. </summary>
  57. </member>
  58. <member name="M:NUnit.Framework.Constraints.Constraint.#ctor">
  59. <summary>
  60. Construct a constraint with no arguments
  61. </summary>
  62. </member>
  63. <member name="M:NUnit.Framework.Constraints.Constraint.#ctor(System.Object)">
  64. <summary>
  65. Construct a constraint with one argument
  66. </summary>
  67. </member>
  68. <member name="M:NUnit.Framework.Constraints.Constraint.#ctor(System.Object,System.Object)">
  69. <summary>
  70. Construct a constraint with two arguments
  71. </summary>
  72. </member>
  73. <member name="M:NUnit.Framework.Constraints.Constraint.SetBuilder(NUnit.Framework.Constraints.ConstraintBuilder)">
  74. <summary>
  75. Sets the ConstraintBuilder holding this constraint
  76. </summary>
  77. </member>
  78. <member name="M:NUnit.Framework.Constraints.Constraint.WriteMessageTo(NUnit.Framework.Constraints.MessageWriter)">
  79. <summary>
  80. Write the failure message to the MessageWriter provided
  81. as an argument. The default implementation simply passes
  82. the constraint and the actual value to the writer, which
  83. then displays the constraint description and the value.
  84. Constraints that need to provide additional details,
  85. such as where the error occured can override this.
  86. </summary>
  87. <param name="writer">The MessageWriter on which to display the message</param>
  88. </member>
  89. <member name="M:NUnit.Framework.Constraints.Constraint.Matches(System.Object)">
  90. <summary>
  91. Test whether the constraint is satisfied by a given value
  92. </summary>
  93. <param name="actual">The value to be tested</param>
  94. <returns>True for success, false for failure</returns>
  95. </member>
  96. <member name="M:NUnit.Framework.Constraints.Constraint.Matches(NUnit.Framework.Constraints.ActualValueDelegate)">
  97. <summary>
  98. Test whether the constraint is satisfied by an
  99. ActualValueDelegate that returns the value to be tested.
  100. The default implementation simply evaluates the delegate
  101. but derived classes may override it to provide for delayed
  102. processing.
  103. </summary>
  104. <param name="del">An ActualValueDelegate</param>
  105. <returns>True for success, false for failure</returns>
  106. </member>
  107. <member name="M:NUnit.Framework.Constraints.Constraint.Matches``1(``0@)">
  108. <summary>
  109. Test whether the constraint is satisfied by a given reference.
  110. The default implementation simply dereferences the value but
  111. derived classes may override it to provide for delayed processing.
  112. </summary>
  113. <param name="actual">A reference to the value to be tested</param>
  114. <returns>True for success, false for failure</returns>
  115. </member>
  116. <member name="M:NUnit.Framework.Constraints.Constraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  117. <summary>
  118. Write the constraint description to a MessageWriter
  119. </summary>
  120. <param name="writer">The writer on which the description is displayed</param>
  121. </member>
  122. <member name="M:NUnit.Framework.Constraints.Constraint.WriteActualValueTo(NUnit.Framework.Constraints.MessageWriter)">
  123. <summary>
  124. Write the actual value for a failing constraint test to a
  125. MessageWriter. The default implementation simply writes
  126. the raw value of actual, leaving it to the writer to
  127. perform any formatting.
  128. </summary>
  129. <param name="writer">The writer on which the actual value is displayed</param>
  130. </member>
  131. <member name="M:NUnit.Framework.Constraints.Constraint.ToString">
  132. <summary>
  133. Default override of ToString returns the constraint DisplayName
  134. followed by any arguments within angle brackets.
  135. </summary>
  136. <returns></returns>
  137. </member>
  138. <member name="M:NUnit.Framework.Constraints.Constraint.op_BitwiseAnd(NUnit.Framework.Constraints.Constraint,NUnit.Framework.Constraints.Constraint)">
  139. <summary>
  140. This operator creates a constraint that is satisfied only if both
  141. argument constraints are satisfied.
  142. </summary>
  143. </member>
  144. <member name="M:NUnit.Framework.Constraints.Constraint.op_BitwiseOr(NUnit.Framework.Constraints.Constraint,NUnit.Framework.Constraints.Constraint)">
  145. <summary>
  146. This operator creates a constraint that is satisfied if either
  147. of the argument constraints is satisfied.
  148. </summary>
  149. </member>
  150. <member name="M:NUnit.Framework.Constraints.Constraint.op_LogicalNot(NUnit.Framework.Constraints.Constraint)">
  151. <summary>
  152. This operator creates a constraint that is satisfied if the
  153. argument constraint is not satisfied.
  154. </summary>
  155. </member>
  156. <member name="M:NUnit.Framework.Constraints.Constraint.After(System.Int32)">
  157. <summary>
  158. Returns a DelayedConstraint with the specified delay time.
  159. </summary>
  160. <param name="delayInMilliseconds">The delay in milliseconds.</param>
  161. <returns></returns>
  162. </member>
  163. <member name="M:NUnit.Framework.Constraints.Constraint.After(System.Int32,System.Int32)">
  164. <summary>
  165. Returns a DelayedConstraint with the specified delay time
  166. and polling interval.
  167. </summary>
  168. <param name="delayInMilliseconds">The delay in milliseconds.</param>
  169. <param name="pollingInterval">The interval at which to test the constraint.</param>
  170. <returns></returns>
  171. </member>
  172. <member name="P:NUnit.Framework.Constraints.Constraint.DisplayName">
  173. <summary>
  174. The display name of this Constraint for use by ToString().
  175. The default value is the name of the constraint with
  176. trailing "Constraint" removed. Derived classes may set
  177. this to another name in their constructors.
  178. </summary>
  179. </member>
  180. <member name="P:NUnit.Framework.Constraints.Constraint.And">
  181. <summary>
  182. Returns a ConstraintExpression by appending And
  183. to the current constraint.
  184. </summary>
  185. </member>
  186. <member name="P:NUnit.Framework.Constraints.Constraint.With">
  187. <summary>
  188. Returns a ConstraintExpression by appending And
  189. to the current constraint.
  190. </summary>
  191. </member>
  192. <member name="P:NUnit.Framework.Constraints.Constraint.Or">
  193. <summary>
  194. Returns a ConstraintExpression by appending Or
  195. to the current constraint.
  196. </summary>
  197. </member>
  198. <member name="T:NUnit.Framework.Constraints.Constraint.UnsetObject">
  199. <summary>
  200. Class used to detect any derived constraints
  201. that fail to set the actual value in their
  202. Matches override.
  203. </summary>
  204. </member>
  205. <member name="F:NUnit.Framework.Constraints.TypeConstraint.expectedType">
  206. <summary>
  207. The expected Type used by the constraint
  208. </summary>
  209. </member>
  210. <member name="M:NUnit.Framework.Constraints.TypeConstraint.#ctor(System.Type)">
  211. <summary>
  212. Construct a TypeConstraint for a given Type
  213. </summary>
  214. <param name="type"></param>
  215. </member>
  216. <member name="M:NUnit.Framework.Constraints.TypeConstraint.WriteActualValueTo(NUnit.Framework.Constraints.MessageWriter)">
  217. <summary>
  218. Write the actual value for a failing constraint test to a
  219. MessageWriter. TypeConstraints override this method to write
  220. the name of the type.
  221. </summary>
  222. <param name="writer">The writer on which the actual value is displayed</param>
  223. </member>
  224. <member name="T:NUnit.Framework.Constraints.ExactTypeConstraint">
  225. <summary>
  226. ExactTypeConstraint is used to test that an object
  227. is of the exact type provided in the constructor
  228. </summary>
  229. </member>
  230. <member name="M:NUnit.Framework.Constraints.ExactTypeConstraint.#ctor(System.Type)">
  231. <summary>
  232. Construct an ExactTypeConstraint for a given Type
  233. </summary>
  234. <param name="type">The expected Type.</param>
  235. </member>
  236. <member name="M:NUnit.Framework.Constraints.ExactTypeConstraint.Matches(System.Object)">
  237. <summary>
  238. Test that an object is of the exact type specified
  239. </summary>
  240. <param name="actual">The actual value.</param>
  241. <returns>True if the tested object is of the exact type provided, otherwise false.</returns>
  242. </member>
  243. <member name="M:NUnit.Framework.Constraints.ExactTypeConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  244. <summary>
  245. Write the description of this constraint to a MessageWriter
  246. </summary>
  247. <param name="writer">The MessageWriter to use</param>
  248. </member>
  249. <member name="T:NUnit.Framework.Constraints.InstanceOfTypeConstraint">
  250. <summary>
  251. InstanceOfTypeConstraint is used to test that an object
  252. is of the same type provided or derived from it.
  253. </summary>
  254. </member>
  255. <member name="M:NUnit.Framework.Constraints.InstanceOfTypeConstraint.#ctor(System.Type)">
  256. <summary>
  257. Construct an InstanceOfTypeConstraint for the type provided
  258. </summary>
  259. <param name="type">The expected Type</param>
  260. </member>
  261. <member name="M:NUnit.Framework.Constraints.InstanceOfTypeConstraint.Matches(System.Object)">
  262. <summary>
  263. Test whether an object is of the specified type or a derived type
  264. </summary>
  265. <param name="actual">The object to be tested</param>
  266. <returns>True if the object is of the provided type or derives from it, otherwise false.</returns>
  267. </member>
  268. <member name="M:NUnit.Framework.Constraints.InstanceOfTypeConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  269. <summary>
  270. Write a description of this constraint to a MessageWriter
  271. </summary>
  272. <param name="writer">The MessageWriter to use</param>
  273. </member>
  274. <member name="T:NUnit.Framework.Constraints.AssignableFromConstraint">
  275. <summary>
  276. AssignableFromConstraint is used to test that an object
  277. can be assigned from a given Type.
  278. </summary>
  279. </member>
  280. <member name="M:NUnit.Framework.Constraints.AssignableFromConstraint.#ctor(System.Type)">
  281. <summary>
  282. Construct an AssignableFromConstraint for the type provided
  283. </summary>
  284. <param name="type"></param>
  285. </member>
  286. <member name="M:NUnit.Framework.Constraints.AssignableFromConstraint.Matches(System.Object)">
  287. <summary>
  288. Test whether an object can be assigned from the specified type
  289. </summary>
  290. <param name="actual">The object to be tested</param>
  291. <returns>True if the object can be assigned a value of the expected Type, otherwise false.</returns>
  292. </member>
  293. <member name="M:NUnit.Framework.Constraints.AssignableFromConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  294. <summary>
  295. Write a description of this constraint to a MessageWriter
  296. </summary>
  297. <param name="writer">The MessageWriter to use</param>
  298. </member>
  299. <member name="T:NUnit.Framework.Constraints.AssignableToConstraint">
  300. <summary>
  301. AssignableToConstraint is used to test that an object
  302. can be assigned to a given Type.
  303. </summary>
  304. </member>
  305. <member name="M:NUnit.Framework.Constraints.AssignableToConstraint.#ctor(System.Type)">
  306. <summary>
  307. Construct an AssignableToConstraint for the type provided
  308. </summary>
  309. <param name="type"></param>
  310. </member>
  311. <member name="M:NUnit.Framework.Constraints.AssignableToConstraint.Matches(System.Object)">
  312. <summary>
  313. Test whether an object can be assigned to the specified type
  314. </summary>
  315. <param name="actual">The object to be tested</param>
  316. <returns>True if the object can be assigned a value of the expected Type, otherwise false.</returns>
  317. </member>
  318. <member name="M:NUnit.Framework.Constraints.AssignableToConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  319. <summary>
  320. Write a description of this constraint to a MessageWriter
  321. </summary>
  322. <param name="writer">The MessageWriter to use</param>
  323. </member>
  324. <member name="T:NUnit.Framework.Constraints.ConstraintBuilder">
  325. <summary>
  326. ConstraintBuilder maintains the stacks that are used in
  327. processing a ConstraintExpression. An OperatorStack
  328. is used to hold operators that are waiting for their
  329. operands to be reognized. a ConstraintStack holds
  330. input constraints as well as the results of each
  331. operator applied.
  332. </summary>
  333. </member>
  334. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.#ctor">
  335. <summary>
  336. Initializes a new instance of the <see cref="T:ConstraintBuilder"/> class.
  337. </summary>
  338. </member>
  339. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.Append(NUnit.Framework.Constraints.ConstraintOperator)">
  340. <summary>
  341. Appends the specified operator to the expression by first
  342. reducing the operator stack and then pushing the new
  343. operator on the stack.
  344. </summary>
  345. <param name="op">The operator to push.</param>
  346. </member>
  347. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.Append(NUnit.Framework.Constraints.Constraint)">
  348. <summary>
  349. Appends the specified constraint to the expresson by pushing
  350. it on the constraint stack.
  351. </summary>
  352. <param name="constraint">The constraint to push.</param>
  353. </member>
  354. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.SetTopOperatorRightContext(System.Object)">
  355. <summary>
  356. Sets the top operator right context.
  357. </summary>
  358. <param name="rightContext">The right context.</param>
  359. </member>
  360. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.ReduceOperatorStack(System.Int32)">
  361. <summary>
  362. Reduces the operator stack until the topmost item
  363. precedence is greater than or equal to the target precedence.
  364. </summary>
  365. <param name="targetPrecedence">The target precedence.</param>
  366. </member>
  367. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.Resolve">
  368. <summary>
  369. Resolves this instance, returning a Constraint. If the builder
  370. is not currently in a resolvable state, an exception is thrown.
  371. </summary>
  372. <returns>The resolved constraint</returns>
  373. </member>
  374. <member name="P:NUnit.Framework.Constraints.ConstraintBuilder.IsResolvable">
  375. <summary>
  376. Gets a value indicating whether this instance is resolvable.
  377. </summary>
  378. <value>
  379. <c>true</c> if this instance is resolvable; otherwise, <c>false</c>.
  380. </value>
  381. </member>
  382. <member name="T:NUnit.Framework.Constraints.ConstraintBuilder.OperatorStack">
  383. <summary>
  384. OperatorStack is a type-safe stack for holding ConstraintOperators
  385. </summary>
  386. </member>
  387. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.OperatorStack.#ctor(NUnit.Framework.Constraints.ConstraintBuilder)">
  388. <summary>
  389. Initializes a new instance of the <see cref="T:OperatorStack"/> class.
  390. </summary>
  391. <param name="builder">The builder.</param>
  392. </member>
  393. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.OperatorStack.Push(NUnit.Framework.Constraints.ConstraintOperator)">
  394. <summary>
  395. Pushes the specified operator onto the stack.
  396. </summary>
  397. <param name="op">The op.</param>
  398. </member>
  399. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.OperatorStack.Pop">
  400. <summary>
  401. Pops the topmost operator from the stack.
  402. </summary>
  403. <returns></returns>
  404. </member>
  405. <member name="P:NUnit.Framework.Constraints.ConstraintBuilder.OperatorStack.Empty">
  406. <summary>
  407. Gets a value indicating whether this <see cref="T:OpStack"/> is empty.
  408. </summary>
  409. <value><c>true</c> if empty; otherwise, <c>false</c>.</value>
  410. </member>
  411. <member name="P:NUnit.Framework.Constraints.ConstraintBuilder.OperatorStack.Top">
  412. <summary>
  413. Gets the topmost operator without modifying the stack.
  414. </summary>
  415. <value>The top.</value>
  416. </member>
  417. <member name="T:NUnit.Framework.Constraints.ConstraintBuilder.ConstraintStack">
  418. <summary>
  419. ConstraintStack is a type-safe stack for holding Constraints
  420. </summary>
  421. </member>
  422. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.ConstraintStack.#ctor(NUnit.Framework.Constraints.ConstraintBuilder)">
  423. <summary>
  424. Initializes a new instance of the <see cref="T:ConstraintStack"/> class.
  425. </summary>
  426. <param name="builder">The builder.</param>
  427. </member>
  428. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.ConstraintStack.Push(NUnit.Framework.Constraints.Constraint)">
  429. <summary>
  430. Pushes the specified constraint. As a side effect,
  431. the constraint's builder field is set to the
  432. ConstraintBuilder owning this stack.
  433. </summary>
  434. <param name="constraint">The constraint.</param>
  435. </member>
  436. <member name="M:NUnit.Framework.Constraints.ConstraintBuilder.ConstraintStack.Pop">
  437. <summary>
  438. Pops this topmost constrait from the stack.
  439. As a side effect, the constraint's builder
  440. field is set to null.
  441. </summary>
  442. <returns></returns>
  443. </member>
  444. <member name="P:NUnit.Framework.Constraints.ConstraintBuilder.ConstraintStack.Empty">
  445. <summary>
  446. Gets a value indicating whether this <see cref="T:ConstraintStack"/> is empty.
  447. </summary>
  448. <value><c>true</c> if empty; otherwise, <c>false</c>.</value>
  449. </member>
  450. <member name="P:NUnit.Framework.Constraints.ConstraintBuilder.ConstraintStack.Top">
  451. <summary>
  452. Gets the topmost constraint without modifying the stack.
  453. </summary>
  454. <value>The topmost constraint</value>
  455. </member>
  456. <member name="T:NUnit.Framework.Constraints.ThrowsConstraint">
  457. <summary>
  458. ThrowsConstraint is used to test the exception thrown by
  459. a delegate by applying a constraint to it.
  460. </summary>
  461. </member>
  462. <member name="T:NUnit.Framework.Constraints.PrefixConstraint">
  463. <summary>
  464. Abstract base class used for prefixes
  465. </summary>
  466. </member>
  467. <member name="F:NUnit.Framework.Constraints.PrefixConstraint.baseConstraint">
  468. <summary>
  469. The base constraint
  470. </summary>
  471. </member>
  472. <member name="M:NUnit.Framework.Constraints.PrefixConstraint.#ctor(NUnit.Framework.Constraints.IResolveConstraint)">
  473. <summary>
  474. Construct given a base constraint
  475. </summary>
  476. <param name="resolvable"></param>
  477. </member>
  478. <member name="M:NUnit.Framework.Constraints.ThrowsConstraint.#ctor(NUnit.Framework.Constraints.Constraint)">
  479. <summary>
  480. Initializes a new instance of the <see cref="T:ThrowsConstraint"/> class,
  481. using a constraint to be applied to the exception.
  482. </summary>
  483. <param name="baseConstraint">A constraint to apply to the caught exception.</param>
  484. </member>
  485. <member name="M:NUnit.Framework.Constraints.ThrowsConstraint.Matches(System.Object)">
  486. <summary>
  487. Executes the code of the delegate and captures any exception.
  488. If a non-null base constraint was provided, it applies that
  489. constraint to the exception.
  490. </summary>
  491. <param name="actual">A delegate representing the code to be tested</param>
  492. <returns>True if an exception is thrown and the constraint succeeds, otherwise false</returns>
  493. </member>
  494. <member name="M:NUnit.Framework.Constraints.ThrowsConstraint.Matches(NUnit.Framework.Constraints.ActualValueDelegate)">
  495. <summary>
  496. Converts an ActualValueDelegate to a TestDelegate
  497. before calling the primary overload.
  498. </summary>
  499. <param name="del"></param>
  500. <returns></returns>
  501. </member>
  502. <member name="M:NUnit.Framework.Constraints.ThrowsConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  503. <summary>
  504. Write the constraint description to a MessageWriter
  505. </summary>
  506. <param name="writer">The writer on which the description is displayed</param>
  507. </member>
  508. <member name="M:NUnit.Framework.Constraints.ThrowsConstraint.WriteActualValueTo(NUnit.Framework.Constraints.MessageWriter)">
  509. <summary>
  510. Write the actual value for a failing constraint test to a
  511. MessageWriter. The default implementation simply writes
  512. the raw value of actual, leaving it to the writer to
  513. perform any formatting.
  514. </summary>
  515. <param name="writer">The writer on which the actual value is displayed</param>
  516. </member>
  517. <member name="M:NUnit.Framework.Constraints.ThrowsConstraint.ToString">
  518. <summary>
  519. Returns the string representation of this constraint
  520. </summary>
  521. </member>
  522. <member name="P:NUnit.Framework.Constraints.ThrowsConstraint.ActualException">
  523. <summary>
  524. Get the actual exception thrown - used by Assert.Throws.
  525. </summary>
  526. </member>
  527. <member name="T:NUnit.Framework.Constraints.ThrowsNothingConstraint">
  528. <summary>
  529. ThrowsNothingConstraint tests that a delegate does not
  530. throw an exception.
  531. </summary>
  532. </member>
  533. <member name="M:NUnit.Framework.Constraints.ThrowsNothingConstraint.Matches(System.Object)">
  534. <summary>
  535. Test whether the constraint is satisfied by a given value
  536. </summary>
  537. <param name="actual">The value to be tested</param>
  538. <returns>True if no exception is thrown, otherwise false</returns>
  539. </member>
  540. <member name="M:NUnit.Framework.Constraints.ThrowsNothingConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  541. <summary>
  542. Write the constraint description to a MessageWriter
  543. </summary>
  544. <param name="writer">The writer on which the description is displayed</param>
  545. </member>
  546. <member name="M:NUnit.Framework.Constraints.ThrowsNothingConstraint.WriteActualValueTo(NUnit.Framework.Constraints.MessageWriter)">
  547. <summary>
  548. Write the actual value for a failing constraint test to a
  549. MessageWriter. The default implementation simply writes
  550. the raw value of actual, leaving it to the writer to
  551. perform any formatting.
  552. </summary>
  553. <param name="writer">The writer on which the actual value is displayed</param>
  554. </member>
  555. <member name="T:NUnit.Framework.Constraints.CollectionConstraint">
  556. <summary>
  557. CollectionConstraint is the abstract base class for
  558. constraints that operate on collections.
  559. </summary>
  560. </member>
  561. <member name="M:NUnit.Framework.Constraints.CollectionConstraint.#ctor">
  562. <summary>
  563. Construct an empty CollectionConstraint
  564. </summary>
  565. </member>
  566. <member name="M:NUnit.Framework.Constraints.CollectionConstraint.#ctor(System.Object)">
  567. <summary>
  568. Construct a CollectionConstraint
  569. </summary>
  570. <param name="arg"></param>
  571. </member>
  572. <member name="M:NUnit.Framework.Constraints.CollectionConstraint.IsEmpty(System.Collections.IEnumerable)">
  573. <summary>
  574. Determines whether the specified enumerable is empty.
  575. </summary>
  576. <param name="enumerable">The enumerable.</param>
  577. <returns>
  578. <c>true</c> if the specified enumerable is empty; otherwise, <c>false</c>.
  579. </returns>
  580. </member>
  581. <member name="M:NUnit.Framework.Constraints.CollectionConstraint.Matches(System.Object)">
  582. <summary>
  583. Test whether the constraint is satisfied by a given value
  584. </summary>
  585. <param name="actual">The value to be tested</param>
  586. <returns>True for success, false for failure</returns>
  587. </member>
  588. <member name="M:NUnit.Framework.Constraints.CollectionConstraint.doMatch(System.Collections.IEnumerable)">
  589. <summary>
  590. Protected method to be implemented by derived classes
  591. </summary>
  592. <param name="collection"></param>
  593. <returns></returns>
  594. </member>
  595. <member name="T:NUnit.Framework.Constraints.CollectionItemsEqualConstraint">
  596. <summary>
  597. CollectionItemsEqualConstraint is the abstract base class for all
  598. collection constraints that apply some notion of item equality
  599. as a part of their operation.
  600. </summary>
  601. </member>
  602. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.#ctor">
  603. <summary>
  604. Construct an empty CollectionConstraint
  605. </summary>
  606. </member>
  607. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.#ctor(System.Object)">
  608. <summary>
  609. Construct a CollectionConstraint
  610. </summary>
  611. <param name="arg"></param>
  612. </member>
  613. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.Using(System.Collections.IComparer)">
  614. <summary>
  615. Flag the constraint to use the supplied IComparer object.
  616. </summary>
  617. <param name="comparer">The IComparer object to use.</param>
  618. <returns>Self.</returns>
  619. </member>
  620. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.Using``1(System.Collections.Generic.IComparer{``0})">
  621. <summary>
  622. Flag the constraint to use the supplied IComparer object.
  623. </summary>
  624. <param name="comparer">The IComparer object to use.</param>
  625. <returns>Self.</returns>
  626. </member>
  627. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.Using``1(System.Comparison{``0})">
  628. <summary>
  629. Flag the constraint to use the supplied Comparison object.
  630. </summary>
  631. <param name="comparer">The IComparer object to use.</param>
  632. <returns>Self.</returns>
  633. </member>
  634. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.Using(System.Collections.IEqualityComparer)">
  635. <summary>
  636. Flag the constraint to use the supplied IEqualityComparer object.
  637. </summary>
  638. <param name="comparer">The IComparer object to use.</param>
  639. <returns>Self.</returns>
  640. </member>
  641. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.Using``1(System.Collections.Generic.IEqualityComparer{``0})">
  642. <summary>
  643. Flag the constraint to use the supplied IEqualityComparer object.
  644. </summary>
  645. <param name="comparer">The IComparer object to use.</param>
  646. <returns>Self.</returns>
  647. </member>
  648. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.ItemsEqual(System.Object,System.Object)">
  649. <summary>
  650. Compares two collection members for equality
  651. </summary>
  652. </member>
  653. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.Tally(System.Collections.IEnumerable)">
  654. <summary>
  655. Return a new CollectionTally for use in making tests
  656. </summary>
  657. <param name="c">The collection to be included in the tally</param>
  658. </member>
  659. <member name="P:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.IgnoreCase">
  660. <summary>
  661. Flag the constraint to ignore case and return self.
  662. </summary>
  663. </member>
  664. <member name="T:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.CollectionTally">
  665. <summary>
  666. CollectionTally counts (tallies) the number of
  667. occurences of each object in one or more enumerations.
  668. </summary>
  669. </member>
  670. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.CollectionTally.#ctor(NUnit.Framework.Constraints.NUnitEqualityComparer,System.Collections.IEnumerable)">
  671. <summary>
  672. Construct a CollectionTally object from a comparer and a collection
  673. </summary>
  674. </member>
  675. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.CollectionTally.TryRemove(System.Object)">
  676. <summary>
  677. Try to remove an object from the tally
  678. </summary>
  679. <param name="o">The object to remove</param>
  680. <returns>True if successful, false if the object was not found</returns>
  681. </member>
  682. <member name="M:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.CollectionTally.TryRemove(System.Collections.IEnumerable)">
  683. <summary>
  684. Try to remove a set of objects from the tally
  685. </summary>
  686. <param name="c">The objects to remove</param>
  687. <returns>True if successful, false if any object was not found</returns>
  688. </member>
  689. <member name="P:NUnit.Framework.Constraints.CollectionItemsEqualConstraint.CollectionTally.Count">
  690. <summary>
  691. The number of objects remaining in the tally
  692. </summary>
  693. </member>
  694. <member name="T:NUnit.Framework.Constraints.EmptyCollectionConstraint">
  695. <summary>
  696. EmptyCollectionConstraint tests whether a collection is empty.
  697. </summary>
  698. </member>
  699. <member name="M:NUnit.Framework.Constraints.EmptyCollectionConstraint.doMatch(System.Collections.IEnumerable)">
  700. <summary>
  701. Check that the collection is empty
  702. </summary>
  703. <param name="collection"></param>
  704. <returns></returns>
  705. </member>
  706. <member name="M:NUnit.Framework.Constraints.EmptyCollectionConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  707. <summary>
  708. Write the constraint description to a MessageWriter
  709. </summary>
  710. <param name="writer"></param>
  711. </member>
  712. <member name="T:NUnit.Framework.Constraints.UniqueItemsConstraint">
  713. <summary>
  714. UniqueItemsConstraint tests whether all the items in a
  715. collection are unique.
  716. </summary>
  717. </member>
  718. <member name="M:NUnit.Framework.Constraints.UniqueItemsConstraint.doMatch(System.Collections.IEnumerable)">
  719. <summary>
  720. Check that all items are unique.
  721. </summary>
  722. <param name="actual"></param>
  723. <returns></returns>
  724. </member>
  725. <member name="M:NUnit.Framework.Constraints.UniqueItemsConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  726. <summary>
  727. Write a description of this constraint to a MessageWriter
  728. </summary>
  729. <param name="writer"></param>
  730. </member>
  731. <member name="T:NUnit.Framework.Constraints.CollectionContainsConstraint">
  732. <summary>
  733. CollectionContainsConstraint is used to test whether a collection
  734. contains an expected object as a member.
  735. </summary>
  736. </member>
  737. <member name="M:NUnit.Framework.Constraints.CollectionContainsConstraint.#ctor(System.Object)">
  738. <summary>
  739. Construct a CollectionContainsConstraint
  740. </summary>
  741. <param name="expected"></param>
  742. </member>
  743. <member name="M:NUnit.Framework.Constraints.CollectionContainsConstraint.doMatch(System.Collections.IEnumerable)">
  744. <summary>
  745. Test whether the expected item is contained in the collection
  746. </summary>
  747. <param name="actual"></param>
  748. <returns></returns>
  749. </member>
  750. <member name="M:NUnit.Framework.Constraints.CollectionContainsConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  751. <summary>
  752. Write a descripton of the constraint to a MessageWriter
  753. </summary>
  754. <param name="writer"></param>
  755. </member>
  756. <member name="T:NUnit.Framework.Constraints.CollectionEquivalentConstraint">
  757. <summary>
  758. CollectionEquivalentCOnstraint is used to determine whether two
  759. collections are equivalent.
  760. </summary>
  761. </member>
  762. <member name="M:NUnit.Framework.Constraints.CollectionEquivalentConstraint.#ctor(System.Collections.IEnumerable)">
  763. <summary>
  764. Construct a CollectionEquivalentConstraint
  765. </summary>
  766. <param name="expected"></param>
  767. </member>
  768. <member name="M:NUnit.Framework.Constraints.CollectionEquivalentConstraint.doMatch(System.Collections.IEnumerable)">
  769. <summary>
  770. Test whether two collections are equivalent
  771. </summary>
  772. <param name="actual"></param>
  773. <returns></returns>
  774. </member>
  775. <member name="M:NUnit.Framework.Constraints.CollectionEquivalentConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  776. <summary>
  777. Write a description of this constraint to a MessageWriter
  778. </summary>
  779. <param name="writer"></param>
  780. </member>
  781. <member name="T:NUnit.Framework.Constraints.CollectionSubsetConstraint">
  782. <summary>
  783. CollectionSubsetConstraint is used to determine whether
  784. one collection is a subset of another
  785. </summary>
  786. </member>
  787. <member name="M:NUnit.Framework.Constraints.CollectionSubsetConstraint.#ctor(System.Collections.IEnumerable)">
  788. <summary>
  789. Construct a CollectionSubsetConstraint
  790. </summary>
  791. <param name="expected">The collection that the actual value is expected to be a subset of</param>
  792. </member>
  793. <member name="M:NUnit.Framework.Constraints.CollectionSubsetConstraint.doMatch(System.Collections.IEnumerable)">
  794. <summary>
  795. Test whether the actual collection is a subset of
  796. the expected collection provided.
  797. </summary>
  798. <param name="actual"></param>
  799. <returns></returns>
  800. </member>
  801. <member name="M:NUnit.Framework.Constraints.CollectionSubsetConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  802. <summary>
  803. Write a description of this constraint to a MessageWriter
  804. </summary>
  805. <param name="writer"></param>
  806. </member>
  807. <member name="T:NUnit.Framework.Constraints.CollectionOrderedConstraint">
  808. <summary>
  809. CollectionOrderedConstraint is used to test whether a collection is ordered.
  810. </summary>
  811. </member>
  812. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.#ctor">
  813. <summary>
  814. Construct a CollectionOrderedConstraint
  815. </summary>
  816. </member>
  817. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.Using(System.Collections.IComparer)">
  818. <summary>
  819. Modifies the constraint to use an IComparer and returns self.
  820. </summary>
  821. </member>
  822. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.Using``1(System.Collections.Generic.IComparer{``0})">
  823. <summary>
  824. Modifies the constraint to use an IComparer&lt;T&gt; and returns self.
  825. </summary>
  826. </member>
  827. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.Using``1(System.Comparison{``0})">
  828. <summary>
  829. Modifies the constraint to use a Comparison&lt;T&gt; and returns self.
  830. </summary>
  831. </member>
  832. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.By(System.String)">
  833. <summary>
  834. Modifies the constraint to test ordering by the value of
  835. a specified property and returns self.
  836. </summary>
  837. </member>
  838. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.doMatch(System.Collections.IEnumerable)">
  839. <summary>
  840. Test whether the collection is ordered
  841. </summary>
  842. <param name="actual"></param>
  843. <returns></returns>
  844. </member>
  845. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  846. <summary>
  847. Write a description of the constraint to a MessageWriter
  848. </summary>
  849. <param name="writer"></param>
  850. </member>
  851. <member name="M:NUnit.Framework.Constraints.CollectionOrderedConstraint.ToString">
  852. <summary>
  853. Returns the string representation of the constraint.
  854. </summary>
  855. <returns></returns>
  856. </member>
  857. <member name="P:NUnit.Framework.Constraints.CollectionOrderedConstraint.Descending">
  858. <summary>
  859. If used performs a reverse comparison
  860. </summary>
  861. </member>
  862. <member name="T:NUnit.Framework.Constraints.EmptyDirectoryContraint">
  863. <summary>
  864. EmptyDirectoryConstraint is used to test that a directory is empty
  865. </summary>
  866. </member>
  867. <member name="M:NUnit.Framework.Constraints.EmptyDirectoryContraint.Matches(System.Object)">
  868. <summary>
  869. Test whether the constraint is satisfied by a given value
  870. </summary>
  871. <param name="actual">The value to be tested</param>
  872. <returns>True for success, false for failure</returns>
  873. </member>
  874. <member name="M:NUnit.Framework.Constraints.EmptyDirectoryContraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  875. <summary>
  876. Write the constraint description to a MessageWriter
  877. </summary>
  878. <param name="writer">The writer on which the description is displayed</param>
  879. </member>
  880. <member name="M:NUnit.Framework.Constraints.EmptyDirectoryContraint.WriteActualValueTo(NUnit.Framework.Constraints.MessageWriter)">
  881. <summary>
  882. Write the actual value for a failing constraint test to a
  883. MessageWriter. The default implementation simply writes
  884. the raw value of actual, leaving it to the writer to
  885. perform any formatting.
  886. </summary>
  887. <param name="writer">The writer on which the actual value is displayed</param>
  888. </member>
  889. <member name="T:NUnit.Framework.Constraints.SubDirectoryConstraint">
  890. <summary>
  891. SubDirectoryConstraint is used to test that one directory is a subdirectory of another.
  892. </summary>
  893. </member>
  894. <member name="M:NUnit.Framework.Constraints.SubDirectoryConstraint.#ctor(System.IO.DirectoryInfo)">
  895. <summary>
  896. Initializes a new instance of the <see cref="T:SubDirectoryConstraint"/> class.
  897. </summary>
  898. <param name="dirInfo">The dir info.</param>
  899. </member>
  900. <member name="M:NUnit.Framework.Constraints.SubDirectoryConstraint.Matches(System.Object)">
  901. <summary>
  902. Test whether the constraint is satisfied by a given value
  903. </summary>
  904. <param name="actual">The value to be tested</param>
  905. <returns>True for success, false for failure</returns>
  906. </member>
  907. <member name="M:NUnit.Framework.Constraints.SubDirectoryConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  908. <summary>
  909. Write the constraint description to a MessageWriter
  910. </summary>
  911. <param name="writer">The writer on which the description is displayed</param>
  912. </member>
  913. <member name="M:NUnit.Framework.Constraints.SubDirectoryConstraint.BuildDirectoryList(System.IO.DirectoryInfo)">
  914. <summary>
  915. Builds a list of DirectoryInfo objects, recursing where necessary
  916. </summary>
  917. <param name="StartingDirectory">directory to recurse</param>
  918. <returns>list of DirectoryInfo objects from the top level</returns>
  919. </member>
  920. <member name="M:NUnit.Framework.Constraints.SubDirectoryConstraint.IsDirectoryOnPath(System.IO.DirectoryInfo,System.IO.DirectoryInfo)">
  921. <summary>
  922. private method to determine whether a directory is within the path
  923. </summary>
  924. <param name="ParentDirectory">top-level directory to search</param>
  925. <param name="SearchDirectory">directory to search for</param>
  926. <returns>true if found, false if not</returns>
  927. </member>
  928. <member name="M:NUnit.Framework.Constraints.SubDirectoryConstraint.DirectoriesEqual(System.IO.DirectoryInfo,System.IO.DirectoryInfo)">
  929. <summary>
  930. Method to compare two DirectoryInfo objects
  931. </summary>
  932. <param name="expected">first directory to compare</param>
  933. <param name="actual">second directory to compare</param>
  934. <returns>true if equivalent, false if not</returns>
  935. </member>
  936. <member name="T:NUnit.Framework.Constraints.PathConstraint">
  937. <summary>
  938. PathConstraint serves as the abstract base of constraints
  939. that operate on paths and provides several helper methods.
  940. </summary>
  941. </member>
  942. <member name="F:NUnit.Framework.Constraints.PathConstraint.expected">
  943. <summary>
  944. The expected path used in the constraint
  945. </summary>
  946. </member>
  947. <member name="F:NUnit.Framework.Constraints.PathConstraint.caseInsensitive">
  948. <summary>
  949. Flag indicating whether a caseInsensitive comparison should be made
  950. </summary>
  951. </member>
  952. <member name="M:NUnit.Framework.Constraints.PathConstraint.#ctor(System.String)">
  953. <summary>
  954. Construct a PathConstraint for a give expected path
  955. </summary>
  956. <param name="expected">The expected path</param>
  957. </member>
  958. <member name="M:NUnit.Framework.Constraints.PathConstraint.ToString">
  959. <summary>
  960. Returns the string representation of this constraint
  961. </summary>
  962. </member>
  963. <member name="M:NUnit.Framework.Constraints.PathConstraint.Canonicalize(System.String)">
  964. <summary>
  965. Canonicalize the provided path
  966. </summary>
  967. <param name="path"></param>
  968. <returns>The path in standardized form</returns>
  969. </member>
  970. <member name="M:NUnit.Framework.Constraints.PathConstraint.IsSamePath(System.String,System.String)">
  971. <summary>
  972. Test whether two paths are the same
  973. </summary>
  974. <param name="path1">The first path</param>
  975. <param name="path2">The second path</param>
  976. <returns></returns>
  977. </member>
  978. <member name="M:NUnit.Framework.Constraints.PathConstraint.IsSamePathOrUnder(System.String,System.String)">
  979. <summary>
  980. Test whether one path is the same as or under another path
  981. </summary>
  982. <param name="path1">The first path - supposed to be the parent path</param>
  983. <param name="path2">The second path - supposed to be the child path</param>
  984. <returns></returns>
  985. </member>
  986. <member name="P:NUnit.Framework.Constraints.PathConstraint.IgnoreCase">
  987. <summary>
  988. Modifies the current instance to be case-insensitve
  989. and returns it.
  990. </summary>
  991. </member>
  992. <member name="P:NUnit.Framework.Constraints.PathConstraint.RespectCase">
  993. <summary>
  994. Modifies the current instance to be case-sensitve
  995. and returns it.
  996. </summary>
  997. </member>
  998. <member name="T:NUnit.Framework.Constraints.SamePathConstraint">
  999. <summary>
  1000. Summary description for SamePathConstraint.
  1001. </summary>
  1002. </member>
  1003. <member name="M:NUnit.Framework.Constraints.SamePathConstraint.#ctor(System.String)">
  1004. <summary>
  1005. Initializes a new instance of the <see cref="T:SamePathConstraint"/> class.
  1006. </summary>
  1007. <param name="expected">The expected path</param>
  1008. </member>
  1009. <member name="M:NUnit.Framework.Constraints.SamePathConstraint.Matches(System.Object)">
  1010. <summary>
  1011. Test whether the constraint is satisfied by a given value
  1012. </summary>
  1013. <param name="actual">The value to be tested</param>
  1014. <returns>True for success, false for failure</returns>
  1015. </member>
  1016. <member name="M:NUnit.Framework.Constraints.SamePathConstraint.WriteDescriptionTo(NUnit.Framework.Constraints.MessageWriter)">
  1017. <summary>
  1018. Write the constraint description to a M