/libs/NVelocity/NVelocity.xml

https://bitbucket.org/leitethiagon/crystal-quartznet · XML · 7323 lines · 7074 code · 248 blank · 1 comment · 0 complexity · b86ac9915774cee924c8c46c0ee38136 MD5 · raw file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NVelocity</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NVelocity.App.Events.EventCartridge">
  8. <summary>
  9. 'Package' of event handlers...
  10. </summary>
  11. </member>
  12. <member name="M:NVelocity.App.Events.EventCartridge.ReferenceInsert(System.Collections.Stack,System.String,System.Object)">
  13. <summary>
  14. Called during Velocity merge before a reference value will
  15. be inserted into the output stream.
  16. </summary>
  17. <param name="referenceStack">the stack of objects used to reach this reference</param>
  18. <param name="reference">reference from template about to be inserted</param>
  19. <param name="value"> value about to be inserted (after toString() )</param>
  20. <returns>
  21. Object on which toString() should be called for output.
  22. </returns>
  23. </member>
  24. <member name="M:NVelocity.App.Events.EventCartridge.ShouldLogOnNullSet(System.String,System.String)">
  25. <summary>
  26. Called during Velocity merge to determine if when
  27. a #set() results in a null assignment, a warning
  28. is logged.
  29. </summary>
  30. <returns>true if to be logged, false otherwise</returns>
  31. </member>
  32. <member name="M:NVelocity.App.Events.EventCartridge.HandleMethodException(System.Type,System.String,System.Exception)">
  33. <summary>
  34. Called during Velocity merge if a reference is null
  35. </summary>
  36. <param name="type">Class that is causing the exception</param>
  37. <param name="method">method called that causes the exception</param>
  38. <param name="e">Exception thrown by the method</param>
  39. <returns>Object to return as method result</returns>
  40. <exception cref="T:System.Exception">exception to be wrapped and propagated to app</exception>
  41. </member>
  42. <member name="M:NVelocity.App.Events.EventCartridge.AttachToContext(NVelocity.Context.IContext)">
  43. <summary>
  44. Attached the EventCartridge to the context
  45. </summary>
  46. <param name="context">context to attach to</param>
  47. <returns>true if successful, false otherwise</returns>
  48. </member>
  49. <member name="T:NVelocity.App.Events.EventHandler">
  50. <summary> Base interface for all event handlers
  51. *
  52. </summary>
  53. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  54. </author>
  55. <version> $Id: EventHandler.cs,v 1.3 2003/10/27 13:54:07 corts Exp $
  56. </version>
  57. </member>
  58. <member name="T:NVelocity.App.Events.NullSetEventHandler">
  59. <summary>
  60. Lets an app approve / veto writing a log message when RHS of #set() is null.
  61. </summary>
  62. </member>
  63. <member name="P:NVelocity.App.Events.NullSetEventArgs.LHS">
  64. <summary>
  65. Reference literal of left-hand-side of set statement
  66. </summary>
  67. </member>
  68. <member name="P:NVelocity.App.Events.NullSetEventArgs.RHS">
  69. <summary>
  70. reference literal of right-hand-side of set statement
  71. </summary>
  72. </member>
  73. <member name="T:NVelocity.App.Tools.VelocityFormatter">
  74. <summary>
  75. Formatting tool for inserting into the Velocity WebContext. Can
  76. format dates or lists of objects.
  77. <para>Here's an example of some uses:
  78. <code><pre>
  79. $formatter.formatShortDate($object.Date)
  80. $formatter.formatLongDate($db.getRecord(232).getDate())
  81. $formatter.formatArray($array)
  82. $formatter.limitLen(30, $object.Description)
  83. </pre></code>
  84. </para>
  85. </summary>
  86. <author><a href="mailto:sean@somacity.com">Sean Legassick</a></author>
  87. <author><a href="mailto:dlr@collab.net">Daniel Rall</a></author>
  88. <version>$Id: VelocityFormatter.cs,v 1.5 2003/11/05 04:15:02 corts Exp $</version>
  89. </member>
  90. <member name="M:NVelocity.App.Tools.VelocityFormatter.#ctor(NVelocity.Context.IContext)">
  91. <summary>
  92. Constructor needs a backPointer to the context.
  93. </summary>
  94. <param name="context">A Context.</param>
  95. </member>
  96. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatShortDate(System.DateTime)">
  97. <summary>
  98. Formats a date in 'short' style.
  99. </summary>
  100. <param name="date">A Date.</param>
  101. <returns>A String.</returns>
  102. </member>
  103. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatLongDate(System.DateTime)">
  104. <summary>
  105. Formats a date in 'long' style.
  106. </summary>
  107. <param name="date">A Date.</param>
  108. <returns>A String.</returns>
  109. </member>
  110. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatShortDateTime(System.DateTime)">
  111. <summary>
  112. Formats a date/time in 'short' style.
  113. </summary>
  114. <param name="date">A Date.</param>
  115. <returns>A String.</returns>
  116. </member>
  117. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatLongDateTime(System.DateTime)">
  118. <summary>
  119. Formats a date/time in 'long' style.
  120. </summary>
  121. <param name="date">A Date.</param>
  122. <returns>A String.</returns>
  123. </member>
  124. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatArray(System.Object)">
  125. <summary>
  126. Formats an array into the form "A, B and C".
  127. </summary>
  128. <param name="array">An Object.</param>
  129. <returns>A String.</returns>
  130. </member>
  131. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatArray(System.Object,System.String)">
  132. <summary>
  133. Formats an array into the form
  134. "A&lt;delim&gt;B&lt;delim&gt;C".
  135. </summary>
  136. <param name="array">An Object.</param>
  137. <param name="delim">A String.</param>
  138. <returns>A String.</returns>
  139. </member>
  140. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatArray(System.Object,System.String,System.String)">
  141. <summary>
  142. Formats an array into the form
  143. "A&lt;delim&gt;B&lt;finalDelimiter&gt;C".
  144. </summary>
  145. <param name="array">An Object.</param>
  146. <param name="delim">A String.</param>
  147. <param name="finalDelimiter">A String.</param>
  148. <returns>A String.</returns>
  149. </member>
  150. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatVector(System.Collections.IList)">
  151. <summary>
  152. Formats a list into the form "A, B and C".
  153. </summary>
  154. <param name="list">A list.</param>
  155. <returns>A String.</returns>
  156. </member>
  157. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatVector(System.Collections.IList,System.String)">
  158. <summary>
  159. Formats a list into the form "A&lt;delim&gt;B&lt;delim&gt;C".
  160. </summary>
  161. <param name="list">A list.</param>
  162. <param name="delim">A String.</param>
  163. <returns>A String.</returns>
  164. </member>
  165. <member name="M:NVelocity.App.Tools.VelocityFormatter.FormatVector(System.Collections.IList,System.String,System.String)">
  166. <summary>
  167. Formats a list into the form
  168. "Adelim&gt;B&lt;finalDelimiter&gt;C".
  169. </summary>
  170. <param name="list">A list.</param>
  171. <param name="delim">A String.</param>
  172. <param name="finalDelimiter">A String.</param>
  173. <returns>A String.</returns>
  174. </member>
  175. <member name="M:NVelocity.App.Tools.VelocityFormatter.LimitLen(System.Int32,System.String)">
  176. <summary>
  177. Limits 'string' to 'maximumLength' characters. If the string gets
  178. curtailed, "..." is appended to it.
  179. </summary>
  180. <param name="maximumLength">An int with the maximum length.</param>
  181. <param name="value">A String.</param>
  182. <returns>A String.</returns>
  183. </member>
  184. <member name="M:NVelocity.App.Tools.VelocityFormatter.LimitLen(System.Int32,System.String,System.String)">
  185. <summary>
  186. Limits 'string' to 'maximumLength' character. If the string gets
  187. curtailed, 'suffix' is appended to it.
  188. </summary>
  189. <param name="maximumLength">An int with the maximum length.</param>
  190. <param name="value">A String.</param>
  191. <param name="suffix">A String.</param>
  192. <returns>A String.</returns>
  193. </member>
  194. <member name="M:NVelocity.App.Tools.VelocityFormatter.MakeAlternator(System.String,System.String,System.String)">
  195. <summary>
  196. Makes an alternator object that alternates between two values.
  197. <para>Example usage in a Velocity template:
  198. <code>
  199. &lt;table&gt;
  200. $formatter.makeAlternator("rowColor", "#c0c0c0", "#e0e0e0")
  201. #foreach $item in $items
  202. &lt;tr&gt;&lt;td bgcolor="$rowColor"&gt;$item.Name&lt;/td&gt;&lt;/tr&gt;
  203. $rowColor.alternate()
  204. #end
  205. &lt;/table&gt;
  206. </code>
  207. </para>
  208. </summary>
  209. <param name="name">The name for the alternator int the context.</param>
  210. <param name="alt1">The first alternate.</param>
  211. <param name="alt2">The second alternate.</param>
  212. <returns>The newly created instance.</returns>
  213. </member>
  214. <member name="M:NVelocity.App.Tools.VelocityFormatter.MakeAlternator(System.String,System.String,System.String,System.String)">
  215. <summary>
  216. Makes an alternator object that alternates between three values.
  217. </summary>
  218. </member>
  219. <member name="M:NVelocity.App.Tools.VelocityFormatter.MakeAlternator(System.String,System.String,System.String,System.String,System.String)">
  220. <summary>
  221. Makes an alternator object that alternates between four values.
  222. </summary>
  223. </member>
  224. <member name="M:NVelocity.App.Tools.VelocityFormatter.MakeAutoAlternator(System.String,System.String,System.String)">
  225. <summary>
  226. Makes an alternator object that alternates between two values
  227. automatically.
  228. </summary>
  229. </member>
  230. <member name="M:NVelocity.App.Tools.VelocityFormatter.IsNull(System.Object,System.Object)">
  231. <summary>
  232. Returns a default value if the object passed is null.
  233. </summary>
  234. </member>
  235. <member name="T:NVelocity.App.Tools.VelocityFormatter.VelocityAlternator">
  236. <summary>
  237. Class that returns alternating values in a template. It stores
  238. a list of alternate Strings, whenever alternate() is called it
  239. switches to the next in the list. The current alternate is
  240. retrieved through toString() - i.e. just by referencing the
  241. object in a Velocity template. For an example of usage see the
  242. makeAlternator() method below.
  243. </summary>
  244. </member>
  245. <member name="M:NVelocity.App.Tools.VelocityFormatter.VelocityAlternator.#ctor(System.String[])">
  246. <summary>
  247. Constructor takes an array of Strings.
  248. </summary>
  249. <param name="alternates">A String[].
  250. </param>
  251. </member>
  252. <member name="M:NVelocity.App.Tools.VelocityFormatter.VelocityAlternator.Alternate">
  253. <summary>
  254. Alternates to the next in the list.
  255. </summary>
  256. <returns>The current alternate in the sequence.</returns>
  257. </member>
  258. <member name="M:NVelocity.App.Tools.VelocityFormatter.VelocityAlternator.ToString">
  259. <summary>
  260. Returns the current alternate.
  261. </summary>
  262. <returns>A String.</returns>
  263. </member>
  264. <member name="T:NVelocity.App.Tools.VelocityFormatter.VelocityAutoAlternator">
  265. <summary>
  266. As VelocityAlternator, but calls <code>alternate()</code>
  267. automatically on rendering in a template.
  268. </summary>
  269. </member>
  270. <member name="M:NVelocity.App.Tools.VelocityFormatter.VelocityAutoAlternator.#ctor(System.String[])">
  271. <summary>
  272. Constructor takes an array of Strings.
  273. </summary>
  274. <param name="alternates">A String[].
  275. </param>
  276. </member>
  277. <member name="M:NVelocity.App.Tools.VelocityFormatter.VelocityAutoAlternator.ToString">
  278. <summary>
  279. Returns the current alternate, and automatically alternates
  280. to the next alternate in its sequence (triggered upon
  281. rendering).
  282. </summary>
  283. <returns>The current alternate in the sequence.</returns>
  284. </member>
  285. <member name="T:NVelocity.App.FieldMethodizer">
  286. <summary>
  287. <para>This is a small utility class allow easy access to static fields in a class,
  288. such as string constants. Velocity will not introspect for class
  289. fields (and won't in the future :), but writing setter/getter methods to do
  290. this really is a pain, so use this if you really have
  291. to access fields.</para>
  292. <para>The idea it so enable access to the fields just like you would in Java.
  293. For example, in Java, you would access a static field like
  294. <blockquote><pre>
  295. MyClass.STRING_CONSTANT
  296. </pre></blockquote>
  297. and that is the same thing we are trying to allow here.</para>
  298. <para>So to use in your Java code, do something like this :
  299. <blockquote><pre>
  300. context.put("runtime", new FieldMethodizer( "NVelocity.Runtime.Runtime" ));
  301. </pre></blockquote>
  302. and then in your template, you can access any of your static fields in this way :
  303. <blockquote><pre>
  304. $runtime.RUNTIME_LOG_WARN_STACKTRACE
  305. </pre></blockquote></para>
  306. <para>Right now, this class only methodizes <code>public static</code> fields. It seems
  307. that anything else is too dangerous. This class is for convenience accessing
  308. 'constants'. If you have fields that aren't <code>static</code> it may be better
  309. to handle them by explicitly placing them into the context.</para>
  310. </summary>
  311. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  312. </author>
  313. <version>$Id: FieldMethodizer.cs,v 1.3 2003/10/27 13:54:07 corts Exp $</version>
  314. </member>
  315. <member name="F:NVelocity.App.FieldMethodizer.fieldHash">
  316. <summary>
  317. Hold the field objects by field name
  318. </summary>
  319. </member>
  320. <member name="F:NVelocity.App.FieldMethodizer.classHash">
  321. <summary>
  322. Hold the class objects by field name
  323. </summary>
  324. </member>
  325. <member name="M:NVelocity.App.FieldMethodizer.#ctor">
  326. <summary>
  327. Allow object to be initialized without any data. You would use
  328. addObject() to add data later.
  329. </summary>
  330. </member>
  331. <member name="M:NVelocity.App.FieldMethodizer.#ctor(System.String)">
  332. <summary>
  333. Constructor that takes as it's arg the name of the class
  334. to methodize.
  335. </summary>
  336. <param name="s">Name of class to methodize.</param>
  337. </member>
  338. <member name="M:NVelocity.App.FieldMethodizer.#ctor(System.Object)">
  339. <summary>
  340. Constructor that takes as it's arg a living
  341. object to methodize. Note that it will still
  342. only methodized the public static fields of
  343. the class.
  344. </summary>
  345. <param name="o">object to methodize.</param>
  346. </member>
  347. <member name="M:NVelocity.App.FieldMethodizer.AddObject(System.String)">
  348. <summary>
  349. Add the Name of the class to methodize
  350. </summary>
  351. </member>
  352. <member name="M:NVelocity.App.FieldMethodizer.AddObject(System.Object)">
  353. <summary> Add an Object to methodize
  354. </summary>
  355. </member>
  356. <member name="M:NVelocity.App.FieldMethodizer.Get(System.String)">
  357. <summary>
  358. Accessor method to get the fields by name.
  359. </summary>
  360. <param name="fieldName">Name of static field to retrieve</param>
  361. <returns>The value of the given field.</returns>
  362. </member>
  363. <member name="M:NVelocity.App.FieldMethodizer.Inspect(System.Type)">
  364. <summary> Method that retrieves all public static fields
  365. in the class we are methodizing.
  366. </summary>
  367. </member>
  368. <member name="T:NVelocity.App.Velocity">
  369. <summary>
  370. This class provides services to the application
  371. developer, such as :
  372. <ul>
  373. <li> Simple Velocity Runtime engine initialization methods.</li>
  374. <li> Functions to apply the template engine to streams and strings</li>
  375. to allow embedding and dynamic template generation.
  376. <li> Methods to access Velocimacros directly.</li>
  377. </ul>
  378. <br/><br/>
  379. While the most common way to use NVelocity is via templates, as
  380. Velocity is a general-purpose template engine, there are other
  381. uses that NVelocity is well suited for, such as processing dynamically
  382. created templates, or processing content streams.
  383. <br/><br/>
  384. The methods herein were developed to allow easy access to the NVelocity
  385. facilities without direct spelunking of the internals. If there is
  386. something you feel is necessary to add here, please, send a patch.
  387. </summary>
  388. </member>
  389. <member name="M:NVelocity.App.Velocity.Init">
  390. <summary>
  391. initialize the NVelocity runtime engine, using the default
  392. properties of the NVelocity distribution
  393. </summary>
  394. </member>
  395. <member name="M:NVelocity.App.Velocity.Init(System.String)">
  396. <summary>
  397. initialize the Velocity runtime engine, using default properties
  398. plus the properties in the properties file passed in as the arg
  399. </summary>
  400. <param name="propsFilename">
  401. file containing properties to use to initialize
  402. the Velocity runtime
  403. </param>
  404. </member>
  405. <member name="M:NVelocity.App.Velocity.Init(Commons.Collections.ExtendedProperties)">
  406. <summary>
  407. initialize the Velocity runtime engine, using default properties
  408. plus the properties in the passed in java.util.Properties object
  409. </summary>
  410. <param name="p">
  411. Proprties object containing initialization properties
  412. </param>
  413. </member>
  414. <member name="M:NVelocity.App.Velocity.SetProperty(System.String,System.Object)">
  415. <summary>
  416. Set a Velocity Runtime property.
  417. </summary>
  418. <param name="key">key</param>
  419. <param name="value">value</param>
  420. </member>
  421. <member name="M:NVelocity.App.Velocity.AddProperty(System.String,System.Object)">
  422. <summary>
  423. Add a Velocity Runtime property.
  424. </summary>
  425. <param name="key">key</param>
  426. <param name="value">value</param>
  427. </member>
  428. <member name="M:NVelocity.App.Velocity.ClearProperty(System.String)">
  429. <summary>
  430. Clear a NVelocity Runtime property.
  431. </summary>
  432. <param name="key">of property to clear</param>
  433. </member>
  434. <member name="M:NVelocity.App.Velocity.SetExtendedProperties(Commons.Collections.ExtendedProperties)">
  435. <summary>
  436. Set an entire configuration at once. This is
  437. useful in cases where the parent application uses
  438. the ExtendedProperties class and the velocity configuration
  439. is a subset of the parent application's configuration.
  440. </summary>
  441. </member>
  442. <member name="M:NVelocity.App.Velocity.GetProperty(System.String)">
  443. <summary>
  444. Get a Velocity Runtime property.
  445. </summary>
  446. <param name="key">property to retrieve</param>
  447. <returns>property value or null if the property not currently set</returns>
  448. </member>
  449. <member name="M:NVelocity.App.Velocity.Evaluate(NVelocity.Context.IContext,System.IO.TextWriter,System.String,System.String)">
  450. <summary>
  451. renders the input string using the context into the output writer.
  452. To be used when a template is dynamically constructed, or want to use
  453. Velocity as a token replacer.
  454. </summary>
  455. <param name="context">context to use in rendering input string</param>
  456. <param name="writer"> Writer in which to render the output</param>
  457. <param name="logTag"> string to be used as the template name for log messages in case of error</param>
  458. <param name="inString">input string containing the VTL to be rendered</param>
  459. <returns>true if successful, false otherwise. If false, see Velocity runtime log</returns>
  460. </member>
  461. <member name="M:NVelocity.App.Velocity.Evaluate(NVelocity.Context.IContext,System.IO.TextWriter,System.String,System.IO.Stream)">
  462. <summary>
  463. Renders the input stream using the context into the output writer.
  464. To be used when a template is dynamically constructed, or want to
  465. use Velocity as a token replacer.
  466. </summary>
  467. <param name="context">context to use in rendering input string</param>
  468. <param name="writer"> Writer in which to render the output</param>
  469. <param name="logTag"> string to be used as the template name for log messages in case of error</param>
  470. <param name="instream">input stream containing the VTL to be rendered</param>
  471. <returns>true if successful, false otherwise. If false, see Velocity runtime log</returns>
  472. </member>
  473. <member name="M:NVelocity.App.Velocity.Evaluate(NVelocity.Context.IContext,System.IO.TextWriter,System.String,System.IO.TextReader)">
  474. <summary>
  475. Renders the input reader using the context into the output writer.
  476. To be used when a template is dynamically constructed, or want to
  477. use Velocity as a token replacer.
  478. </summary>
  479. <param name="context">context to use in rendering input string</param>
  480. <param name="writer"> Writer in which to render the output</param>
  481. <param name="logTag"> string to be used as the template name for log messages in case of error</param>
  482. <param name="reader">Reader containing the VTL to be rendered</param>
  483. <returns>true if successful, false otherwise. If false, see Velocity runtime log</returns>
  484. </member>
  485. <member name="M:NVelocity.App.Velocity.InvokeVelocimacro(System.String,System.String,System.String[],NVelocity.Context.IContext,System.IO.TextWriter)">
  486. <summary>
  487. Invokes a currently registered Velocimacro with the parameters provided
  488. and places the rendered stream into the writer.
  489. Note : currently only accepts args to the VM if they are in the context.
  490. </summary>
  491. <param name="vmName">name of Velocimacro to call</param>
  492. <param name="logTag">string to be used for template name in case of error</param>
  493. <param name="parameters">args used to invoke Velocimacro. In context key format :
  494. eg "foo","bar" (rather than "$foo","$bar")
  495. </param>
  496. <param name="context">Context object containing data/objects used for rendering.</param>
  497. <param name="writer"> Writer for output stream</param>
  498. <returns>true if Velocimacro exists and successfully invoked, false otherwise.</returns>
  499. </member>
  500. <member name="M:NVelocity.App.Velocity.MergeTemplate(System.String,NVelocity.Context.IContext,System.IO.TextWriter)">
  501. <summary>
  502. merges a template and puts the rendered stream into the writer
  503. </summary>
  504. <param name="templateName">name of template to be used in merge</param>
  505. <param name="context"> filled context to be used in merge</param>
  506. <param name="writer"> writer to write template into</param>
  507. <returns>true if successful, false otherwise. Errors logged to velocity log.</returns>
  508. </member>
  509. <member name="M:NVelocity.App.Velocity.MergeTemplate(System.String,System.String,NVelocity.Context.IContext,System.IO.TextWriter)">
  510. <summary>
  511. merges a template and puts the rendered stream into the writer
  512. </summary>
  513. <param name="templateName">name of template to be used in merge</param>
  514. <param name="encoding">encoding used in template</param>
  515. <param name="context"> filled context to be used in merge</param>
  516. <param name="writer"> writer to write template into</param>
  517. <returns>true if successful, false otherwise. Errors logged to velocity log</returns>
  518. </member>
  519. <member name="M:NVelocity.App.Velocity.GetTemplate(System.String)">
  520. <summary>
  521. Returns a <code>Template</code> from the Velocity
  522. resource management system.
  523. </summary>
  524. <param name="name">The file name of the desired template.
  525. </param>
  526. <returns> The template.
  527. @throws ResourceNotFoundException if template not found
  528. from any available source.
  529. @throws ParseErrorException if template cannot be parsed due
  530. to syntax (or other) error.
  531. @throws Exception if an error occurs in template initialization
  532. </returns>
  533. </member>
  534. <member name="M:NVelocity.App.Velocity.GetTemplate(System.String,System.String)">
  535. <summary>
  536. Returns a <code>Template</code> from the Velocity
  537. resource management system.
  538. </summary>
  539. <param name="name">The file name of the desired template.</param>
  540. <param name="encoding">The character encoding to use for the template.</param>
  541. <returns>The <see cref="T:NVelocity.Template"/> instance.</returns>
  542. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  543. If template is not found from any available source.
  544. </exception>
  545. <exception cref="T:NVelocity.Exception.ParseErrorException">
  546. If template cannot be parsed due to syntax (or other) error.
  547. </exception>
  548. <exception cref="T:System.Exception">
  549. If an error occurs in template initialization.
  550. </exception>
  551. </member>
  552. <member name="M:NVelocity.App.Velocity.ResourceExists(System.String)">
  553. <summary>
  554. <p>Determines whether a resource is accessible via the
  555. currently configured resource loaders. <see cref="T:NVelocity.Runtime.Resource.Resource"/>
  556. is the generic description of templates, static content, etc.</p>
  557. <p>Note that the current implementation will <b>not</b> change
  558. the state of the system in any real way - so this cannot be
  559. used to pre-load the resource cache, as the previous
  560. implementation did as a side-effect.</p>
  561. </summary>
  562. <param name="templateName"> name of the template to search for</param>
  563. <returns>Whether the resource was located.</returns>
  564. </member>
  565. <member name="M:NVelocity.App.Velocity.Warn(System.Object)">
  566. <summary>
  567. Log a warning message.
  568. </summary>
  569. <param name="message">message to log
  570. </param>
  571. </member>
  572. <member name="M:NVelocity.App.Velocity.Info(System.Object)">
  573. <summary>
  574. Log an info message.
  575. </summary>
  576. <param name="message">message to log</param>
  577. </member>
  578. <member name="M:NVelocity.App.Velocity.Error(System.Object)">
  579. <summary>
  580. Log an error message.
  581. </summary>
  582. <param name="message">message to log</param>
  583. </member>
  584. <member name="M:NVelocity.App.Velocity.Debug(System.Object)">
  585. <summary>
  586. Log a debug message.
  587. </summary>
  588. <param name="message">message to log</param>
  589. </member>
  590. <member name="M:NVelocity.App.Velocity.SetApplicationAttribute(System.Object,System.Object)">
  591. <summary>
  592. <p>
  593. Set the an ApplicationAttribute, which is an Object
  594. set by the application which is accessible from
  595. any component of the system that gets a RuntimeServices.
  596. This allows communication between the application
  597. environment and custom pluggable components of the
  598. Velocity engine, such as loaders and loggers.
  599. </p>
  600. <p>
  601. Note that there is no enforcement or rules for the key
  602. used - it is up to the application developer. However, to
  603. help make the intermixing of components possible, using
  604. the target Class name (e.g. com.foo.bar ) as the key
  605. might help avoid collision.
  606. </p>
  607. </summary>
  608. <param name="key">object 'name' under which the object is stored
  609. </param>
  610. <param name="value">object to store under this key
  611. </param>
  612. </member>
  613. <member name="M:NVelocity.App.Velocity.TemplateExists(System.String)">
  614. <summary>
  615. <see>#ResourceExists(String)</see>
  616. </summary>
  617. </member>
  618. <member name="T:NVelocity.App.VelocityEngine">
  619. <summary>
  620. This class provides a separate new-able instance of the
  621. Velocity template engine. The alternative model for use
  622. is using the Velocity class which employs the singleton
  623. model.
  624. Please ensure that you call one of the init() variants.
  625. This is critical for proper behavior.
  626. Coming soon : Velocity will call
  627. the parameter-less init() at the first use of this class
  628. if the init() wasn't explicitly called. While this will
  629. ensure that Velocity functions, it almost certainly won't
  630. function in the way you intend, so please make sure to
  631. call init().
  632. </summary>
  633. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  634. </member>
  635. <member name="M:NVelocity.App.VelocityEngine.#ctor">
  636. <summary>
  637. Init-less CTOR
  638. </summary>
  639. </member>
  640. <member name="M:NVelocity.App.VelocityEngine.#ctor(System.String)">
  641. <summary>
  642. CTOR that invokes an init(String), initializing
  643. the engine using the properties file specified
  644. </summary>
  645. <exception cref="T:System.Exception"></exception>
  646. <param name="propsFilename">name of properties file to init with</param>
  647. </member>
  648. <member name="M:NVelocity.App.VelocityEngine.#ctor(Commons.Collections.ExtendedProperties)">
  649. <summary>
  650. CTOR that invokes an init(String), initializing
  651. the engine using the Properties specified
  652. </summary>
  653. <param name="p">name of properties to init with</param>
  654. </member>
  655. <member name="M:NVelocity.App.VelocityEngine.SetExtendedProperties(Commons.Collections.ExtendedProperties)">
  656. <summary>
  657. Set an entire configuration at once. This is
  658. useful in cases where the parent application uses
  659. the ExtendedProperties class and the velocity configuration
  660. is a subset of the parent application's configuration.
  661. </summary>
  662. </member>
  663. <member name="M:NVelocity.App.VelocityEngine.Init">
  664. <summary>
  665. initialize the Velocity runtime engine, using the default
  666. properties of the Velocity distribution
  667. </summary>
  668. </member>
  669. <member name="M:NVelocity.App.VelocityEngine.Init(System.String)">
  670. <summary>
  671. initialize the Velocity runtime engine, using default properties
  672. plus the properties in the properties file passed in as the arg
  673. </summary>
  674. <param name="propsFilename">file containing properties to use to initialize
  675. the Velocity runtime</param>
  676. </member>
  677. <member name="M:NVelocity.App.VelocityEngine.Init(Commons.Collections.ExtendedProperties)">
  678. <summary>
  679. initialize the Velocity runtime engine, using default properties
  680. plus the properties in the passed in java.util.Properties object
  681. </summary>
  682. <param name="p"> Properties object containing initialization properties</param>
  683. </member>
  684. <member name="M:NVelocity.App.VelocityEngine.SetProperty(System.String,System.Object)">
  685. <summary>
  686. Set a Velocity Runtime property.
  687. </summary>
  688. </member>
  689. <member name="M:NVelocity.App.VelocityEngine.AddProperty(System.String,System.Object)">
  690. <summary>
  691. Add a Velocity Runtime property.
  692. </summary>
  693. </member>
  694. <member name="M:NVelocity.App.VelocityEngine.ClearProperty(System.String)">
  695. <summary>
  696. Clear a Velocity Runtime property.
  697. </summary>
  698. <param name="key">key of property to clear</param>
  699. </member>
  700. <member name="M:NVelocity.App.VelocityEngine.GetProperty(System.String)">
  701. <summary>
  702. Get a Velocity Runtime property.
  703. </summary>
  704. <param name="key">property to retrieve</param>
  705. <returns>
  706. property value or null if the property not currently set
  707. </returns>
  708. </member>
  709. <member name="M:NVelocity.App.VelocityEngine.Evaluate(NVelocity.Context.IContext,System.IO.TextWriter,System.String,System.String)">
  710. <summary>
  711. renders the input string using the context into the output writer.
  712. To be used when a template is dynamically constructed, or want to use
  713. Velocity as a token replacer.
  714. </summary>
  715. <param name="context">context to use in rendering input string</param>
  716. <param name="writer"> Writer in which to render the output</param>
  717. <param name="logTag"> string to be used as the template name for log messages in case of error</param>
  718. <param name="inString">input string containing the VTL to be rendered</param>
  719. <returns>true if successful, false otherwise. If false, see Velocity runtime log</returns>
  720. </member>
  721. <member name="M:NVelocity.App.VelocityEngine.Evaluate(NVelocity.Context.IContext,System.IO.TextWriter,System.String,System.IO.Stream)">
  722. <summary>
  723. Renders the input stream using the context into the output writer.
  724. To be used when a template is dynamically constructed, or want to
  725. use Velocity as a token replacer.
  726. </summary>
  727. <param name="context">context to use in rendering input string</param>
  728. <param name="writer"> Writer in which to render the output</param>
  729. <param name="logTag"> string to be used as the template name for log messages in case of error</param>
  730. <param name="instream">input stream containing the VTL to be rendered</param>
  731. <returns>true if successful, false otherwise. If false, see Velocity runtime log</returns>
  732. </member>
  733. <member name="M:NVelocity.App.VelocityEngine.Evaluate(NVelocity.Context.IContext,System.IO.TextWriter,System.String,System.IO.TextReader)">
  734. <summary>
  735. Renders the input reader using the context into the output writer.
  736. To be used when a template is dynamically constructed, or want to
  737. use Velocity as a token replacer.
  738. </summary>
  739. <param name="context">context to use in rendering input string</param>
  740. <param name="writer"> Writer in which to render the output</param>
  741. <param name="logTag"> string to be used as the template name for log messages in case of error</param>
  742. <param name="reader">Reader containing the VTL to be rendered</param>
  743. <returns>true if successful, false otherwise. If false, see Velocity runtime log</returns>
  744. </member>
  745. <member name="M:NVelocity.App.VelocityEngine.InvokeVelocimacro(System.String,System.String,System.String[],NVelocity.Context.IContext,System.IO.TextWriter)">
  746. <summary>
  747. Invokes a currently registered Velocimacro with the parameters provided
  748. and places the rendered stream into the writer.
  749. Note : currently only accepts args to the VM if they are in the context.
  750. </summary>
  751. <param name="vmName">name of Velocimacro to call</param>
  752. <param name="logTag">string to be used for template name in case of error</param>
  753. <param name="parameters">args used to invoke Velocimacro. In context key format :
  754. eg "foo","bar" (rather than "$foo","$bar")
  755. </param>
  756. <param name="context">Context object containing data/objects used for rendering.</param>
  757. <param name="writer"> Writer for output stream</param>
  758. <returns>true if Velocimacro exists and successfully invoked, false otherwise.</returns>
  759. </member>
  760. <member name="M:NVelocity.App.VelocityEngine.MergeTemplate(System.String,NVelocity.Context.IContext,System.IO.TextWriter)">
  761. <summary>
  762. merges a template and puts the rendered stream into the writer
  763. </summary>
  764. <param name="templateName">name of template to be used in merge</param>
  765. <param name="context"> filled context to be used in merge</param>
  766. <param name="writer"> writer to write template into</param>
  767. <returns>true if successful, false otherwise. Errors logged to velocity log.</returns>
  768. </member>
  769. <member name="M:NVelocity.App.VelocityEngine.MergeTemplate(System.String,System.String,NVelocity.Context.IContext,System.IO.TextWriter)">
  770. <summary>
  771. merges a template and puts the rendered stream into the writer
  772. </summary>
  773. <param name="templateName">name of template to be used in merge</param>
  774. <param name="encoding">encoding used in template</param>
  775. <param name="context"> filled context to be used in merge</param>
  776. <param name="writer"> writer to write template into</param>
  777. <returns>true if successful, false otherwise. Errors logged to velocity log</returns>
  778. </member>
  779. <member name="M:NVelocity.App.VelocityEngine.GetTemplate(System.String)">
  780. <summary>
  781. Returns a <code>Template</code> from the Velocity
  782. resource management system.
  783. </summary>
  784. <param name="name">The file name of the desired template.</param>
  785. <returns>The template.</returns>
  786. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  787. if template not found from any available source.
  788. </exception>
  789. <exception cref="T:NVelocity.Exception.ParseErrorException">
  790. if template cannot be parsed due
  791. to syntax (or other) error.
  792. </exception>
  793. <exception cref="T:System.Exception">
  794. if an error occurs in template initialization
  795. </exception>
  796. </member>
  797. <member name="M:NVelocity.App.VelocityEngine.GetTemplate(System.String,System.String)">
  798. <summary>
  799. Returns a <code>Template</code> from the Velocity
  800. resource management system.
  801. </summary>
  802. <param name="name">The file name of the desired template.</param>
  803. <param name="encoding">The character encoding to use for the template.</param>
  804. <returns>The template.</returns>
  805. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  806. if template not found from any available source.
  807. </exception>
  808. <exception cref="T:NVelocity.Exception.ParseErrorException">
  809. if template cannot be parsed due
  810. to syntax (or other) error.
  811. </exception>
  812. <exception cref="T:System.Exception">
  813. if an error occurs in template initialization
  814. </exception>
  815. </member>
  816. <member name="M:NVelocity.App.VelocityEngine.TemplateExists(System.String)">
  817. <summary>
  818. Determines if a template is accessible via the currently
  819. configured resource loaders.
  820. <br/><br/>
  821. Note that the current implementation will <b>not</b>
  822. change the state of the system in any real way - so this
  823. cannot be used to pre-load the resource cache, as the
  824. previous implementation did as a side-effect.
  825. <br/><br/>
  826. The previous implementation exhibited extreme laziness and
  827. sloth, and the author has been flogged.
  828. </summary>
  829. <param name="templateName"> name of the template to search for
  830. </param>
  831. <returns>true if found, false otherwise
  832. </returns>
  833. </member>
  834. <member name="M:NVelocity.App.VelocityEngine.Warn(System.Object)">
  835. <summary>
  836. Log a warning message.
  837. </summary>
  838. <param name="message">message to log</param>
  839. </member>
  840. <member name="M:NVelocity.App.VelocityEngine.Info(System.Object)">
  841. <summary>
  842. Log an info message.
  843. </summary>
  844. <param name="message">message to log</param>
  845. </member>
  846. <member name="M:NVelocity.App.VelocityEngine.Error(System.Object)">
  847. <summary>
  848. Log an error message.
  849. </summary>
  850. <param name="message">message to log</param>
  851. </member>
  852. <member name="M:NVelocity.App.VelocityEngine.Debug(System.Object)">
  853. <summary>
  854. Log a debug message.
  855. </summary>
  856. <param name="message">message to log</param>
  857. </member>
  858. <member name="M:NVelocity.App.VelocityEngine.SetApplicationAttribute(System.Object,System.Object)">
  859. <summary>
  860. <p>
  861. Set the an ApplicationAttribute, which is an Object
  862. set by the application which is accessible from
  863. any component of the system that gets a RuntimeServices.
  864. This allows communication between the application
  865. environment and custom pluggable components of the
  866. Velocity engine, such as loaders and loggers.
  867. </p>
  868. <p>
  869. Note that there is no enforcement or rules for the key
  870. used - it is up to the application developer. However, to
  871. help make the intermixing of components possible, using
  872. the target Class name (e.g. com.foo.bar ) as the key
  873. might help avoid collision.
  874. </p>
  875. </summary>
  876. <param name="key">object 'name' under which the object is stored</param>
  877. <param name="value">object to store under this key</param>
  878. </member>
  879. <member name="T:Commons.Collections.CollectionsUtil">
  880. <summary>
  881. Static utility methods for collections
  882. </summary>
  883. </member>
  884. <member name="T:Commons.Collections.ExtendedProperties">
  885. <summary>
  886. This class extends normal Java properties by adding the possibility
  887. to use the same key many times concatenating the value strings
  888. instead of overwriting them.
  889. <para>The Extended Properties syntax is explained here:
  890. <ul>
  891. <li>
  892. Each property has the syntax <code>key = value</code>
  893. </li>
  894. <li>
  895. The <i>key</i> may use any character but the equal sign '='.
  896. </li>
  897. <li>
  898. <i>value</i> may be separated on different lines if a backslash
  899. is placed at the end of the line that continues below.
  900. </li>
  901. <li>
  902. If <i>value</i> is a list of strings, each token is separated
  903. by a comma ','.
  904. </li>
  905. <li>
  906. Commas in each token are escaped placing a backslash right before
  907. the comma.
  908. </li>
  909. <li>
  910. If a <i>key</i> is used more than once, the values are appended
  911. like if they were on the same line separated with commas.
  912. </li>
  913. <li>
  914. Blank lines and lines starting with character '#' are skipped.
  915. </li>
  916. <li>
  917. If a property is named "include" (or whatever is defined by
  918. setInclude() and getInclude() and the value of that property is
  919. the full path to a file on disk, that file will be included into
  920. the ConfigurationsRepository. You can also pull in files relative
  921. to the parent configuration file. So if you have something
  922. like the following:
  923. include = additional.properties
  924. Then "additional.properties" is expected to be in the same
  925. directory as the parent configuration file.
  926. Duplicate name values will be replaced, so be careful.
  927. </li>
  928. </ul>
  929. </para>
  930. <para>Here is an example of a valid extended properties file:
  931. </para>
  932. <para><pre>
  933. # lines starting with # are comments
  934. # This is the simplest property
  935. key = value
  936. # A long property may be separated on multiple lines
  937. longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \
  938. aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
  939. # This is a property with many tokens
  940. tokens_on_a_line = first token, second token
  941. # This sequence generates exactly the same result
  942. tokens_on_multiple_lines = first token
  943. tokens_on_multiple_lines = second token
  944. # commas may be escaped in tokens
  945. commas.excaped = Hi\, what'up?
  946. </pre>
  947. </para>
  948. <para><b>NOTE</b>: this class has <b>not</b> been written for
  949. performance nor low memory usage. In fact, it's way slower than it
  950. could be and generates too much memory garbage. But since
  951. performance is not an issue during intialization (and there is not
  952. much time to improve it), I wrote it this way. If you don't like
  953. it, go ahead and tune it up!</para>
  954. </summary>
  955. </member>
  956. <member name="F:Commons.Collections.ExtendedProperties.defaults">
  957. <summary> Default configurations repository.
  958. </summary>
  959. </member>
  960. <member name="F:Commons.Collections.ExtendedProperties.file">
  961. <summary>
  962. The file connected to this repository (holding comments and such).
  963. </summary>
  964. </member>
  965. <member name="F:Commons.Collections.ExtendedProperties.basePath">
  966. <summary>
  967. Base path of the configuration file used to create
  968. this ExtendedProperties object.
  969. </summary>
  970. </member>
  971. <member name="F:Commons.Collections.ExtendedProperties.fileSeparator">
  972. <summary>
  973. File separator.
  974. </summary>
  975. </member>
  976. <member name="F:Commons.Collections.ExtendedProperties.isInitialized">
  977. <summary>
  978. Has this configuration been initialized.
  979. </summary>
  980. </member>
  981. <member name="F:Commons.Collections.ExtendedProperties.include">
  982. <summary>
  983. This is the name of the property that can point to other
  984. properties file for including other properties files.
  985. </summary>
  986. </member>
  987. <member name="F:Commons.Collections.ExtendedProperties.keysAsListed">
  988. <summary>
  989. These are the keys in the order they listed
  990. in the configuration file. This is useful when
  991. you wish to perform operations with configuration
  992. information in a particular order.
  993. </summary>
  994. </member>
  995. <member name="M:Commons.Collections.ExtendedProperties.#ctor">
  996. <summary>
  997. Creates an empty extended properties object.
  998. </summary>
  999. </member>
  1000. <member name="M:Commons.Collections.ExtendedProperties.#ctor(System.String)">
  1001. <summary>
  1002. Creates and loads the extended properties from the specified
  1003. file.
  1004. </summary>
  1005. <param name="file">A String.</param>
  1006. <exception cref="T:System.IO.IOException"/>
  1007. </member>
  1008. <member name="M:Commons.Collections.ExtendedProperties.#ctor(System.String,System.String)">
  1009. <summary>
  1010. Creates and loads the extended properties from the specified
  1011. file.
  1012. </summary>
  1013. <param name="file">A String.</param>
  1014. <param name="defaultFile">File to load defaults from.</param>
  1015. <exception cref="T:System.IO.IOException"/>
  1016. </member>
  1017. <member name="M:Commons.Collections.ExtendedProperties.IsInitialized">
  1018. <summary>
  1019. Indicate to client code whether property
  1020. resources have been initialized or not.
  1021. </summary>
  1022. </member>
  1023. <member name="M:Commons.Collections.ExtendedProperties.Load(System.IO.Stream,System.String)">
  1024. <summary>
  1025. Load the properties from the given input stream
  1026. and using the specified encoding.
  1027. </summary>
  1028. <param name="input">An InputStream.
  1029. </param>
  1030. <param name="encoding">An encoding.
  1031. </param>
  1032. <exception cref="T:System.IO.IOException"/>
  1033. </member>
  1034. <member name="M:Commons.Collections.ExtendedProperties.GetProperty(System.String)">
  1035. <summary> Gets a property from the configuration.
  1036. *
  1037. </summary>
  1038. <param name="key">property to retrieve
  1039. </param>
  1040. <returns>value as object. Will return user value if exists,
  1041. if not then default value if exists, otherwise null
  1042. </returns>
  1043. </member>
  1044. <member name="M:Commons.Collections.ExtendedProperties.AddProperty(System.String,System.Object)">
  1045. <summary> Add a property to the configuration. If it already
  1046. exists then the value stated here will be added
  1047. to the configuration entry. For example, if
  1048. *
  1049. resource.loader = file
  1050. *
  1051. is already present in the configuration and you
  1052. *
  1053. addProperty("resource.loader", "classpath")
  1054. *
  1055. Then you will end up with a Vector like the
  1056. following:
  1057. *
  1058. ["file", "classpath"]
  1059. *
  1060. </summary>
  1061. <param name="key"></param>
  1062. <param name="token"></param>
  1063. </member>
  1064. <member name="M:Commons.Collections.ExtendedProperties.AddPropertyDirect(System.String,System.Object)">
  1065. <summary> Adds a key/value pair to the map. This routine does
  1066. no magic morphing. It ensures the keyList is maintained
  1067. *
  1068. </summary>
  1069. <param name="key">key to use for mapping
  1070. </param>
  1071. <param name="obj">object to store
  1072. </param>
  1073. </member>
  1074. <member name="M:Commons.Collections.ExtendedProperties.AddStringProperty(System.String,System.String)">
  1075. <summary> Sets a string property w/o checking for commas - used
  1076. internally when a property has been broken up into
  1077. strings that could contain escaped commas to prevent
  1078. the inadvertent vectorization.
  1079. Thanks to Leon Messerschmidt for this one.
  1080. </summary>
  1081. </member>
  1082. <member name="M:Commons.Collections.ExtendedProperties.SetProperty(System.String,System.Object)">
  1083. <summary> Set a property, this will replace any previously
  1084. set values. Set values is implicitly a call
  1085. to clearProperty(key), addProperty(key,value).
  1086. </summary>
  1087. <param name="key"></param>
  1088. <param name="value"></param>
  1089. </member>
  1090. <member name="M:Commons.Collections.ExtendedProperties.Save(System.IO.TextWriter,System.String)">
  1091. <summary> Save the properties to the given outputStream.
  1092. </summary>
  1093. <param name="output">An OutputStream.
  1094. </param>
  1095. <param name="Header">A String.
  1096. </param>
  1097. <exception cref="T:System.IO.IOException">
  1098. </exception>
  1099. </member>
  1100. <member name="M:Commons.Collections.ExtendedProperties.Combine(Commons.Collections.ExtendedProperties)">
  1101. <summary> Combines an existing Hashtable with this Hashtable.
  1102. *
  1103. Warning: It will overwrite previous entries without warning.
  1104. *
  1105. </summary>
  1106. <param name="c">ExtendedProperties
  1107. </param>
  1108. </member>
  1109. <member name="M:Commons.Collections.ExtendedProperties.ClearProperty(System.String)">
  1110. <summary> Clear a property in the configuration.
  1111. *
  1112. </summary>
  1113. <param name="key">key to remove along with corresponding value.
  1114. </param>
  1115. </member>
  1116. <member name="M:Commons.Collections.ExtendedProperties.GetKeys(System.String)">
  1117. <summary> Get the list of the keys contained in the configuration
  1118. repository.
  1119. *
  1120. </summary>
  1121. <returns>An Iterator.
  1122. </returns>
  1123. <summary> Get the list of the keys contained in the configuration
  1124. repository that match the specified prefix.
  1125. *
  1126. </summary>
  1127. <param name="prefix">The prefix to test against.
  1128. </param>
  1129. <returns>An Iterator of keys that match the prefix.
  1130. </returns>
  1131. </member>
  1132. <member name="M:Commons.Collections.ExtendedProperties.Subset(System.String)">
  1133. <summary> Create an ExtendedProperties object that is a subset
  1134. of this one. Take into account duplicate keys
  1135. by using the setProperty() in ExtendedProperties.
  1136. *
  1137. </summary>
  1138. <param name="prefix">prefix
  1139. </param>
  1140. </member>
  1141. <member name="M:Commons.Collections.ExtendedProperties.ToString">
  1142. <summary> Display the configuration for debugging
  1143. purposes.
  1144. </summary>
  1145. </member>
  1146. <member name="M:Commons.Collections.ExtendedProperties.GetString(System.String)">
  1147. <summary> Get a string associated with the given configuration key.
  1148. *
  1149. </summary>
  1150. <param name="key">The configuration key.
  1151. </param>
  1152. <returns>The associated string.
  1153. </returns>
  1154. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1155. object that is not a String.
  1156. </exception>
  1157. </member>
  1158. <member name="M:Commons.Collections.ExtendedProperties.GetString(System.String,System.String)">
  1159. <summary> Get a string associated with the given configuration key.
  1160. *
  1161. </summary>
  1162. <param name="key">The configuration key.
  1163. </param>
  1164. <param name="defaultValue">The default value.
  1165. </param>
  1166. <returns>The associated string if key is found,
  1167. default value otherwise.
  1168. </returns>
  1169. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1170. object that is not a String.
  1171. </exception>
  1172. </member>
  1173. <member name="M:Commons.Collections.ExtendedProperties.GetProperties(System.String)">
  1174. <summary> Get a list of properties associated with the given
  1175. configuration key.
  1176. *
  1177. </summary>
  1178. <param name="key">The configuration key.
  1179. </param>
  1180. <returns>The associated properties if key is found.
  1181. </returns>
  1182. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1183. object that is not a String/Vector.
  1184. </exception>
  1185. <exception cref="T:System.ArgumentException"> if one of the tokens is
  1186. malformed (does not contain an equals sign).
  1187. </exception>
  1188. </member>
  1189. <member name="M:Commons.Collections.ExtendedProperties.GetProperties(System.String,System.Collections.Hashtable)">
  1190. <summary> Get a list of properties associated with the given
  1191. configuration key.
  1192. *
  1193. </summary>
  1194. <param name="key">The configuration key.
  1195. </param>
  1196. <param name="defaultProps">Default property values.
  1197. </param>
  1198. <returns>The associated properties if key is found.
  1199. </returns>
  1200. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1201. object that is not a String/Vector.
  1202. </exception>
  1203. <exception cref="T:System.ArgumentException"> if one of the tokens is
  1204. malformed (does not contain an equals sign).
  1205. </exception>
  1206. </member>
  1207. <member name="M:Commons.Collections.ExtendedProperties.GetStringArray(System.String)">
  1208. <summary> Get an array of strings associated with the given configuration
  1209. key.
  1210. *
  1211. </summary>
  1212. <param name="key">The configuration key.
  1213. </param>
  1214. <returns>The associated string array if key is found.
  1215. </returns>
  1216. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1217. object that is not a String/Vector.
  1218. </exception>
  1219. </member>
  1220. <member name="M:Commons.Collections.ExtendedProperties.GetVector(System.String)">
  1221. <summary> Get a Vector of strings associated with the given configuration
  1222. key.
  1223. *
  1224. </summary>
  1225. <param name="key">The configuration key.
  1226. </param>
  1227. <returns>The associated Vector.
  1228. </returns>
  1229. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1230. object that is not a Vector.
  1231. </exception>
  1232. </member>
  1233. <member name="M:Commons.Collections.ExtendedProperties.GetStringList(System.String)">
  1234. <summary>
  1235. Gets the string list.
  1236. </summary>
  1237. <param name="key">The key.</param>
  1238. <returns></returns>
  1239. </member>
  1240. <member name="M:Commons.Collections.ExtendedProperties.GetVector(System.String,System.Collections.ArrayList)">
  1241. <summary> Get a Vector of strings associated with the given configuration
  1242. key.
  1243. *
  1244. </summary>
  1245. <param name="key">The configuration key.
  1246. </param>
  1247. <param name="defaultValue">The default value.
  1248. </param>
  1249. <returns>The associated Vector.
  1250. </returns>
  1251. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1252. object that is not a Vector.
  1253. </exception>
  1254. </member>
  1255. <member name="M:Commons.Collections.ExtendedProperties.GetBoolean(System.String)">
  1256. <summary> Get a boolean associated with the given configuration key.
  1257. *
  1258. </summary>
  1259. <param name="key">The configuration key.
  1260. </param>
  1261. <returns>The associated boolean.
  1262. </returns>
  1263. <exception cref="T:System.Exception"> is thrown if the key doesn't
  1264. map to an existing object.
  1265. </exception>
  1266. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1267. object that is not a Boolean.
  1268. </exception>
  1269. </member>
  1270. <member name="M:Commons.Collections.ExtendedProperties.GetBoolean(System.String,System.Boolean)">
  1271. <summary> Get a boolean associated with the given configuration key.
  1272. *
  1273. </summary>
  1274. <param name="key">The configuration key.
  1275. </param>
  1276. <param name="defaultValue">The default value.
  1277. </param>
  1278. <returns>The associated boolean if key is found and has valid
  1279. format, default value otherwise.
  1280. </returns>
  1281. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1282. object that is not a Boolean.
  1283. </exception>
  1284. </member>
  1285. <member name="M:Commons.Collections.ExtendedProperties.TestBoolean(System.String)">
  1286. <summary> Test whether the string represent by value maps to a boolean
  1287. value or not. We will allow <code>true</code>, <code>on</code>,
  1288. and <code>yes</code> for a <code>true</code> boolean value, and
  1289. <code>false</code>, <code>off</code>, and <code>no</code> for
  1290. <code>false</code> boolean values. Case of value to test for
  1291. boolean status is ignored.
  1292. *
  1293. </summary>
  1294. <param name="value">The value to test for boolean state.
  1295. </param>
  1296. <returns><code>true</code> or <code>false</code> if the supplied
  1297. text maps to a boolean value, or <code>null</code> otherwise.
  1298. </returns>
  1299. </member>
  1300. <member name="M:Commons.Collections.ExtendedProperties.GetByte(System.String)">
  1301. <summary> Get a byte associated with the given configuration key.
  1302. *
  1303. </summary>
  1304. <param name="key">The configuration key.
  1305. </param>
  1306. <returns>The associated byte if key is found and has valid
  1307. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_BYTE"/> otherwise.
  1308. </returns>
  1309. <exception cref="T:System.Exception"> is thrown if the key doesn't
  1310. map to an existing object.
  1311. </exception>
  1312. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1313. object that is not a Byte.
  1314. </exception>
  1315. </member>
  1316. <member name="M:Commons.Collections.ExtendedProperties.GetByte(System.String,System.SByte)">
  1317. <summary> Get a byte associated with the given configuration key.
  1318. *
  1319. </summary>
  1320. <param name="key">The configuration key.
  1321. </param>
  1322. <param name="defaultValue">The default value.
  1323. </param>
  1324. <returns>The associated byte if key is found and has valid
  1325. format, default value otherwise.
  1326. </returns>
  1327. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1328. object that is not a Byte.
  1329. </exception>
  1330. </member>
  1331. <member name="M:Commons.Collections.ExtendedProperties.GetByte(System.String,System.Byte)">
  1332. <summary> Get a byte associated with the given configuration key.
  1333. *
  1334. </summary>
  1335. <param name="key">The configuration key.
  1336. </param>
  1337. <param name="defaultValue">The default value.
  1338. </param>
  1339. <returns>The associated byte if key is found and has valid
  1340. format, default value otherwise.
  1341. </returns>
  1342. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1343. object that is not a Byte.
  1344. </exception>
  1345. </member>
  1346. <member name="M:Commons.Collections.ExtendedProperties.GetInt(System.String)">
  1347. <summary> The purpose of this method is to get the configuration resource
  1348. with the given name as an integer.
  1349. *
  1350. </summary>
  1351. <param name="name">The resource name.
  1352. </param>
  1353. <returns>The value of the resource as an integer.
  1354. </returns>
  1355. </member>
  1356. <member name="M:Commons.Collections.ExtendedProperties.GetInt(System.String,System.Int32)">
  1357. <summary> The purpose of this method is to get the configuration resource
  1358. with the given name as an integer, or a default value.
  1359. *
  1360. </summary>
  1361. <param name="name">The resource name
  1362. </param>
  1363. <param name="def">The default value of the resource.
  1364. </param>
  1365. <returns>The value of the resource as an integer.
  1366. </returns>
  1367. </member>
  1368. <member name="M:Commons.Collections.ExtendedProperties.GetInteger(System.String)">
  1369. <summary> Get a int associated with the given configuration key.
  1370. *
  1371. </summary>
  1372. <param name="key">The configuration key.
  1373. </param>
  1374. <returns>The associated int if key is found and has valid
  1375. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_INT32"/> otherwise.
  1376. </returns>
  1377. <exception cref="T:System.Exception"> is thrown if the key doesn't
  1378. map to an existing object.
  1379. </exception>
  1380. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1381. object that is not a Integer.
  1382. </exception>
  1383. </member>
  1384. <member name="M:Commons.Collections.ExtendedProperties.GetInteger(System.String,System.Int32)">
  1385. <summary> Get a int associated with the given configuration key.
  1386. *
  1387. </summary>
  1388. <param name="key">The configuration key.
  1389. </param>
  1390. <param name="defaultValue">The default value.
  1391. </param>
  1392. <returns>The associated int if key is found and has valid
  1393. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_INT32"/> otherwise.
  1394. </returns>
  1395. <returns>The associated int if key is found and has valid
  1396. format, default value otherwise.
  1397. </returns>
  1398. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1399. object that is not a Integer.
  1400. </exception>
  1401. </member>
  1402. <member name="M:Commons.Collections.ExtendedProperties.GetLong(System.String)">
  1403. <summary> Get a long associated with the given configuration key.
  1404. *
  1405. </summary>
  1406. <param name="key">The configuration key.
  1407. </param>
  1408. <returns>The associated long if key is found and has valid
  1409. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_INT64"/> otherwise.
  1410. </returns>
  1411. <exception cref="T:System.Exception"> is thrown if the key doesn't
  1412. map to an existing object.
  1413. </exception>
  1414. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1415. object that is not a Long.
  1416. </exception>
  1417. </member>
  1418. <member name="M:Commons.Collections.ExtendedProperties.GetLong(System.String,System.Int64)">
  1419. <summary> Get a long associated with the given configuration key.
  1420. *
  1421. </summary>
  1422. <param name="key">The configuration key.
  1423. </param>
  1424. <param name="defaultValue">The default value.
  1425. </param>
  1426. <returns>The associated long if key is found and has valid
  1427. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_INT64"/> otherwise.
  1428. </returns>
  1429. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1430. object that is not a Long.
  1431. </exception>
  1432. </member>
  1433. <member name="M:Commons.Collections.ExtendedProperties.GetFloat(System.String)">
  1434. <summary> Get a float associated with the given configuration key.
  1435. *
  1436. </summary>
  1437. <param name="key">The configuration key.
  1438. </param>
  1439. <returns>The associated float if key is found and has valid
  1440. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_SINGLE"/> otherwise.
  1441. </returns>
  1442. <exception cref="T:System.Exception"> is thrown if the key doesn't
  1443. map to an existing object.
  1444. </exception>
  1445. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1446. object that is not a Float.
  1447. </exception>
  1448. </member>
  1449. <member name="M:Commons.Collections.ExtendedProperties.GetFloat(System.String,System.Single)">
  1450. <summary> Get a float associated with the given configuration key.
  1451. *
  1452. </summary>
  1453. <param name="key">The configuration key.
  1454. </param>
  1455. <param name="defaultValue">The default value.
  1456. </param>
  1457. <returns>The associated float if key is found and has valid
  1458. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_SINGLE"/> otherwise.
  1459. </returns>
  1460. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1461. object that is not a Float.
  1462. </exception>
  1463. </member>
  1464. <member name="M:Commons.Collections.ExtendedProperties.GetDouble(System.String)">
  1465. <summary> Get a double associated with the given configuration key.
  1466. *
  1467. </summary>
  1468. <param name="key">The configuration key.
  1469. </param>
  1470. <returns>The associated double if key is found and has valid
  1471. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_DOUBLE"/> otherwise.
  1472. </returns>
  1473. <exception cref="T:System.Exception"> is thrown if the key doesn't
  1474. map to an existing object.
  1475. </exception>
  1476. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1477. object that is not a Double.
  1478. </exception>
  1479. </member>
  1480. <member name="M:Commons.Collections.ExtendedProperties.GetDouble(System.String,System.Double)">
  1481. <summary> Get a double associated with the given configuration key.
  1482. *
  1483. </summary>
  1484. <param name="key">The configuration key.
  1485. </param>
  1486. <param name="defaultValue">The default value.
  1487. </param>
  1488. <returns>The associated double if key is found and has valid
  1489. format, <see cref="F:Commons.Collections.ExtendedProperties.DEFAULT_DOUBLE"/> otherwise.
  1490. </returns>
  1491. <exception cref="T:System.InvalidCastException"> is thrown if the key maps to an
  1492. object that is not a Double.
  1493. </exception>
  1494. </member>
  1495. <member name="M:Commons.Collections.ExtendedProperties.ConvertProperties(Commons.Collections.ExtendedProperties)">
  1496. <summary>
  1497. Convert a standard properties class into a configuration class.
  1498. </summary>
  1499. <param name="p">properties object to convert into a ExtendedProperties object.</param>
  1500. <returns>ExtendedProperties configuration created from the properties object.</returns>
  1501. </member>
  1502. <member name="T:Commons.Collections.LRUMap">
  1503. <summary>
  1504. A keyed list with a fixed maximum size which removes
  1505. the least recently used entry if an entry is added when full.
  1506. </summary>
  1507. </member>
  1508. <member name="F:Commons.Collections.LRUMap.DEFAULT_MAX_SIZE">
  1509. <summary>
  1510. Default maximum size
  1511. </summary>
  1512. </member>
  1513. <member name="F:Commons.Collections.LRUMap.maxSize">
  1514. <summary>
  1515. Maximum size
  1516. </summary>
  1517. </member>
  1518. <member name="M:Commons.Collections.LRUMap.RemoveLRU">
  1519. <summary>
  1520. Remove the least recently used entry (the last one in the list)
  1521. </summary>
  1522. </member>
  1523. <member name="P:Commons.Collections.LRUMap.MaxSize">
  1524. <summary>
  1525. Gets the maximum size of the map (the bound).
  1526. </summary>
  1527. </member>
  1528. <member name="T:Commons.Collections.PropertiesReader">
  1529. <summary>
  1530. This class is used to read properties lines. These lines do
  1531. not terminate with new-line chars but rather when there is no
  1532. backslash sign a the end of the line. This is used to
  1533. concatenate multiple lines for readability.
  1534. </summary>
  1535. </member>
  1536. <member name="M:Commons.Collections.PropertiesReader.#ctor(System.IO.StreamReader)">
  1537. <summary>
  1538. Constructor.
  1539. </summary>
  1540. <param name="reader">A Reader.</param>
  1541. </member>
  1542. <member name="M:Commons.Collections.PropertiesReader.ReadProperty">
  1543. <summary>
  1544. Read a property.
  1545. </summary>
  1546. <returns>A String.</returns>
  1547. </member>
  1548. <member name="T:Commons.Collections.PropertiesTokenizer">
  1549. <summary>
  1550. This class divides into tokens a property value. Token
  1551. separator is "," but commas into the property value are escaped
  1552. using the backslash in front.
  1553. </summary>
  1554. </member>
  1555. <member name="F:Commons.Collections.PropertiesTokenizer.DELIMITER">
  1556. <summary>
  1557. The property delimiter used while parsing (a comma).
  1558. </summary>
  1559. </member>
  1560. <member name="M:Commons.Collections.PropertiesTokenizer.#ctor(System.String)">
  1561. <summary>
  1562. Constructor.
  1563. </summary>
  1564. <param name="str">A String</param>
  1565. </member>
  1566. <member name="M:Commons.Collections.PropertiesTokenizer.NextToken">
  1567. <summary>
  1568. Get next token.
  1569. </summary>
  1570. <returns>A String</returns>
  1571. </member>
  1572. <member name="T:NVelocity.Context.AbstractContext">
  1573. <summary> This class is the abstract base class for all conventional
  1574. Velocity Context implementations. Simply extend this class
  1575. and implement the abstract routines that access your preferred
  1576. storage method.
  1577. *
  1578. Takes care of context chaining.
  1579. *
  1580. Also handles / enforces policy on null keys and values :
  1581. *
  1582. <ul>
  1583. <li> Null keys and values are accepted and basically dropped.</li>
  1584. <li> If you place an object into the context with a null key, it
  1585. will be ignored and logged.</li>
  1586. <li> If you try to place a null into the context with any key, it
  1587. will be dropped and logged.</li>
  1588. </ul>
  1589. *
  1590. The default implementation of this for application use is
  1591. org.apache.velocity.VelocityContext.
  1592. *
  1593. All thanks to Fedor for the chaining idea.
  1594. *
  1595. </summary>
  1596. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  1597. </author>
  1598. <author> <a href="mailto:fedor.karpelevitch@home.com">Fedor Karpelevitch</a>
  1599. </author>
  1600. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  1601. </author>
  1602. <version> $Id: AbstractContext.cs,v 1.4 2003/10/27 13:54:08 corts Exp $
  1603. </version>
  1604. </member>
  1605. <member name="T:NVelocity.Context.InternalContextBase">
  1606. <summary> class to encapsulate the 'stuff' for internal operation of velocity.
  1607. We use the context as a thread-safe storage : we take advantage of the
  1608. fact that it's a visitor of sorts to all nodes (that matter) of the
  1609. AST during init() and render().
  1610. Currently, it carries the template name for namespace
  1611. support, as well as node-local context data introspection caching.
  1612. *
  1613. Note that this is not a public class. It is for package access only to
  1614. keep application code from accessing the internals, as AbstractContext
  1615. is derived from this.
  1616. *
  1617. </summary>
  1618. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  1619. </author>
  1620. <version> $Id: InternalContextBase.cs,v 1.4 2003/10/27 13:54:08 corts Exp $
  1621. </version>
  1622. </member>
  1623. <member name="T:NVelocity.Context.IInternalHousekeepingContext">
  1624. <summary>
  1625. interface to encapsulate the 'stuff' for internal operation of velocity.
  1626. We use the context as a thread-safe storage : we take advantage of the
  1627. fact that it's a visitor of sorts to all nodes (that matter) of the
  1628. AST during init() and render().
  1629. Currently, it carries the template name for namespace
  1630. support, as well as node-local context data introspection caching.
  1631. </summary>
  1632. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  1633. <author> <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a></author>
  1634. <version> $Id: InternalHousekeepingContext.cs,v 1.4 2003/10/27 13:54:08 corts Exp $</version>
  1635. </member>
  1636. <member name="M:NVelocity.Context.IInternalHousekeepingContext.PushCurrentTemplateName(System.String)">
  1637. <summary>
  1638. set the current template name on top of stack
  1639. </summary>
  1640. <param name="s">current template name</param>
  1641. </member>
  1642. <member name="M:NVelocity.Context.IInternalHousekeepingContext.PopCurrentTemplateName">
  1643. <summary>
  1644. remove the current template name from stack
  1645. </summary>
  1646. </member>
  1647. <member name="M:NVelocity.Context.IInternalHousekeepingContext.ICacheGet(System.Object)">
  1648. <summary>
  1649. Gets the <see cref="T:NVelocity.Util.Introspection.IntrospectionCacheData"/> object if exists
  1650. for the key
  1651. </summary>
  1652. <param name="key">key to find in cache</param>
  1653. <returns>cache object</returns>
  1654. </member>
  1655. <member name="M:NVelocity.Context.IInternalHousekeepingContext.ICachePut(System.Object,NVelocity.Util.Introspection.IntrospectionCacheData)">
  1656. <summary>
  1657. Sets the <see cref="T:NVelocity.Util.Introspection.IntrospectionCacheData"/> object
  1658. for the key
  1659. </summary>
  1660. <param name="key"> key </param>
  1661. <param name="o"> IntrospectionCacheData object to place in cache</param>
  1662. </member>
  1663. <member name="P:NVelocity.Context.IInternalHousekeepingContext.CurrentTemplateName">
  1664. <summary>
  1665. get the current template name
  1666. </summary>
  1667. <returns>String current template name</returns>
  1668. </member>
  1669. <member name="P:NVelocity.Context.IInternalHousekeepingContext.TemplateNameStack">
  1670. <summary>
  1671. Returns the template name stack in form of an array.
  1672. </summary>
  1673. <returns>Object[] with the template name stack contents.</returns>
  1674. </member>
  1675. <member name="P:NVelocity.Context.IInternalHousekeepingContext.CurrentResource">
  1676. <summary>
  1677. temporary fix to enable #include() to figure out
  1678. current encoding.
  1679. </summary>
  1680. </member>
  1681. <member name="T:NVelocity.Context.IInternalEventContext">
  1682. <summary>
  1683. Interface for event support. Note that this is a public internal
  1684. interface, as it is something that will be accessed from outside
  1685. of the .context package.
  1686. </summary>
  1687. </member>
  1688. <member name="F:NVelocity.Context.InternalContextBase.introspectionCache">
  1689. <summary>
  1690. cache for node/context specific introspection information
  1691. </summary>
  1692. </member>
  1693. <member name="F:NVelocity.Context.InternalContextBase.templateNameStack">
  1694. <summary>
  1695. Template name stack. The stack top contains the current template name.
  1696. </summary>
  1697. </member>
  1698. <member name="F:NVelocity.Context.InternalContextBase.eventCartridge">
  1699. <summary>
  1700. EventCartridge we are to carry. Set by application
  1701. </summary>
  1702. </member>
  1703. <member name="F:NVelocity.Context.InternalContextBase.currentResource">
  1704. <summary>
  1705. Current resource - used for carrying encoding and other
  1706. information down into the rendering process
  1707. </summary>
  1708. </member>
  1709. <member name="M:NVelocity.Context.InternalContextBase.PushCurrentTemplateName(System.String)">
  1710. <summary>
  1711. set the current template name on top of stack
  1712. </summary>
  1713. <param name="s">current template name</param>
  1714. </member>
  1715. <member name="M:NVelocity.Context.InternalContextBase.PopCurrentTemplateName">
  1716. <summary>remove the current template name from stack</summary>
  1717. </member>
  1718. <member name="T:NVelocity.Context.IContext">
  1719. <summary>
  1720. Interface describing the application data context. This set of
  1721. routines is used by the application to set and remove 'named' data
  1722. object to pass them to the template engine to use when rendering
  1723. a template.
  1724. This is the same set of methods supported by the original Context
  1725. class
  1726. </summary>
  1727. <seealso cref="T:NVelocity.Context.AbstractContext"/>
  1728. <seealso cref="T:NVelocity.VelocityContext"/>
  1729. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  1730. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  1731. </member>
  1732. <member name="M:NVelocity.Context.IContext.Put(System.String,System.Object)">
  1733. <summary>
  1734. Adds a name/value pair to the context.
  1735. </summary>
  1736. <param name="key">The name to key the provided value with.</param>
  1737. <param name="value">The corresponding value.</param>
  1738. </member>
  1739. <member name="M:NVelocity.Context.IContext.Get(System.String)">
  1740. <summary>
  1741. Gets the value corresponding to the provided key from the context.
  1742. </summary>
  1743. <param name="key">The name of the desired value.</param>
  1744. <returns>The value corresponding to the provided key.</returns>
  1745. </member>
  1746. <member name="M:NVelocity.Context.IContext.ContainsKey(System.Object)">
  1747. <summary>
  1748. Indicates whether the specified key is in the context.
  1749. </summary>
  1750. <param name="key">The key to look for.</param>
  1751. <returns>Whether the key is in the context.</returns>
  1752. </member>
  1753. <member name="M:NVelocity.Context.IContext.Remove(System.Object)">
  1754. <summary>
  1755. Removes the value associated with the specified key from the context.
  1756. </summary>
  1757. <param name="key">The name of the value to remove.</param>
  1758. <returns>The value that the key was mapped to, or <code>null</code> if unmapped.</returns>
  1759. </member>
  1760. <member name="P:NVelocity.Context.IContext.Count">
  1761. <summary>
  1762. Returns the number of elements in this context
  1763. </summary>
  1764. <value>The count.</value>
  1765. </member>
  1766. <member name="P:NVelocity.Context.IContext.Keys">
  1767. <summary>
  1768. Get all the keys for the values in the context
  1769. </summary>
  1770. </member>
  1771. <member name="F:NVelocity.Context.AbstractContext.innerContext">
  1772. <summary> the chained Context if any
  1773. </summary>
  1774. </member>
  1775. <member name="M:NVelocity.Context.AbstractContext.#ctor">
  1776. <summary> default CTOR
  1777. </summary>
  1778. </member>
  1779. <member name="M:NVelocity.Context.AbstractContext.#ctor(NVelocity.Context.IContext)">
  1780. <summary> Chaining constructor accepts a Context argument.
  1781. It will relay get() operations into this Context
  1782. in the even the 'local' get() returns null.
  1783. </summary>
  1784. <param name="inner">context to be chained
  1785. </param>
  1786. </member>
  1787. <member name="M:NVelocity.Context.AbstractContext.InternalGet(System.String)">
  1788. <summary> Implement to return a value from the context storage.
  1789. <br/><br/>
  1790. The implementation of this method is required for proper
  1791. operation of a Context implementation in general
  1792. Velocity use.
  1793. </summary>
  1794. <param name="key">key whose associated value is to be returned
  1795. </param>
  1796. <returns>object stored in the context
  1797. </returns>
  1798. </member>
  1799. <member name="M:NVelocity.Context.AbstractContext.InternalPut(System.String,System.Object)">
  1800. <summary> Implement to put a value into the context storage.
  1801. <br/><br/>
  1802. The implementation of this method is required for
  1803. proper operation of a Context implementation in
  1804. general Velocity use.
  1805. *
  1806. </summary>
  1807. <param name="key">key with which to associate the value
  1808. </param>
  1809. <param name="value">value to be associated with the key
  1810. </param>
  1811. <returns>previously stored value if exists, or null
  1812. </returns>
  1813. </member>
  1814. <member name="M:NVelocity.Context.AbstractContext.InternalContainsKey(System.Object)">
  1815. <summary> Implement to determine if a key is in the storage.
  1816. <br/><br/>
  1817. Currently, this method is not used internally by
  1818. the Velocity core.
  1819. *
  1820. </summary>
  1821. <param name="key">key to test for existance
  1822. </param>
  1823. <returns>true if found, false if not
  1824. </returns>
  1825. </member>
  1826. <member name="M:NVelocity.Context.AbstractContext.InternalGetKeys">
  1827. <summary> Implement to return an object array of key
  1828. strings from your storage.
  1829. <br/><br/>
  1830. Currently, this method is not used internally by
  1831. the Velocity core.
  1832. *
  1833. </summary>
  1834. <returns>array of keys
  1835. </returns>
  1836. </member>
  1837. <member name="M:NVelocity.Context.AbstractContext.InternalRemove(System.Object)">
  1838. <summary> Implement to remove an item from your storage.
  1839. <br/><br/>
  1840. Currently, this method is not used internally by
  1841. the Velocity core.
  1842. *
  1843. </summary>
  1844. <param name="key">key to remove
  1845. </param>
  1846. <returns>object removed if exists, else null
  1847. </returns>
  1848. </member>
  1849. <member name="M:NVelocity.Context.AbstractContext.Put(System.String,System.Object)">
  1850. <summary> Adds a name/value pair to the context.
  1851. </summary>
  1852. <param name="key"> The name to key the provided value with.
  1853. </param>
  1854. <param name="value">The corresponding value.
  1855. </param>
  1856. <returns>Object that was replaced in the the Context if
  1857. applicable or null if not.
  1858. </returns>
  1859. </member>
  1860. <member name="M:NVelocity.Context.AbstractContext.Get(System.String)">
  1861. <summary> Gets the value corresponding to the provided key from the context.
  1862. *
  1863. Supports the chaining context mechanism. If the 'local' context
  1864. doesn't have the value, we try to get it from the chained context.
  1865. *
  1866. </summary>
  1867. <param name="key">The name of the desired value.
  1868. </param>
  1869. <returns> The value corresponding to the provided key or null if
  1870. the key param is null.
  1871. </returns>
  1872. </member>
  1873. <member name="M:NVelocity.Context.AbstractContext.ContainsKey(System.Object)">
  1874. <summary> Indicates whether the specified key is in the context. Provided for
  1875. debugging purposes.
  1876. *
  1877. </summary>
  1878. <param name="key">The key to look for.
  1879. </param>
  1880. <returns>true if the key is in the context, false if not.
  1881. </returns>
  1882. </member>
  1883. <member name="M:NVelocity.Context.AbstractContext.Remove(System.Object)">
  1884. <summary> Get all the keys for the values in the context
  1885. </summary>
  1886. <returns>Object[] of keys in the Context. Does not return
  1887. keys in chained context.
  1888. </returns>
  1889. <summary> Removes the value associated with the specified key from the context.
  1890. *
  1891. </summary>
  1892. <param name="key">The name of the value to remove.
  1893. </param>
  1894. <returns> The value that the key was mapped to, or <code>null</code>
  1895. if unmapped.
  1896. </returns>
  1897. </member>
  1898. <member name="T:NVelocity.Context.IInternalContextAdapter">
  1899. <summary> interface to bring all necessary internal and user contexts together.
  1900. this is what the AST expects to deal with. If anything new comes
  1901. along, add it here.
  1902. *
  1903. I will rename soon :)
  1904. *
  1905. </summary>
  1906. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  1907. </author>
  1908. <version> $Id: InternalContextAdapter.cs,v 1.3 2003/10/27 13:54:08 corts Exp $
  1909. </version>
  1910. </member>
  1911. <member name="T:NVelocity.Context.IInternalWrapperContext">
  1912. <summary>
  1913. interface for internal context wrapping functionality
  1914. </summary>
  1915. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  1916. <version> $Id: InternalWrapperContext.cs,v 1.4 2003/10/27 13:54:08 corts Exp $ </version>
  1917. </member>
  1918. <member name="P:NVelocity.Context.IInternalWrapperContext.InternalUserContext">
  1919. <summary>
  1920. returns the wrapped user context
  1921. </summary>
  1922. </member>
  1923. <member name="P:NVelocity.Context.IInternalWrapperContext.BaseContext">
  1924. <summary>
  1925. returns the base full context impl
  1926. </summary>
  1927. </member>
  1928. <member name="M:NVelocity.Context.IInternalContextAdapter.Remove(System.Object)">
  1929. <summary>
  1930. Need to define this method here otherwise since both <see cref="T:System.Collections.IDictionary"/> and <see cref="T:NVelocity.Context.IContext"/>
  1931. contains a Remove(Object key) method we will need to cast the object to either interface
  1932. before calling this method, for backward compatibility we make the IContext.Remove the default
  1933. </summary>
  1934. <param name="key"></param>
  1935. <returns></returns>
  1936. </member>
  1937. <member name="T:NVelocity.Context.InternalContextAdapterImpl">
  1938. <summary> This adapter class is the container for all context types for internal
  1939. use. The AST now uses this class rather than the app-level Context
  1940. interface to allow flexibility in the future.
  1941. *
  1942. Currently, we have two context interfaces which must be supported :
  1943. <ul>
  1944. <li> Context : used for application/template data access</li>
  1945. <li> InternalHousekeepingContext : used for internal housekeeping and caching</li>
  1946. <li> InternalWrapperContext : used for getting root cache context and other
  1947. such.</li>
  1948. <li> InternalEventContext : for event handling.</li>
  1949. </ul>
  1950. *
  1951. This class implements the two interfaces to ensure that all methods are
  1952. supported. When adding to the interfaces, or adding more context
  1953. functionality, the interface is the primary definition, so alter that first
  1954. and then all classes as necessary. As of this writing, this would be
  1955. the only class affected by changes to InternalContext
  1956. *
  1957. This class ensures that an InternalContextBase is available for internal
  1958. use. If an application constructs their own Context-implementing
  1959. object w/o sub-classing AbstractContext, it may be that support for
  1960. InternalContext is not available. Therefore, InternalContextAdapter will
  1961. create an InternalContextBase if necessary for this support. Note that
  1962. if this is necessary, internal information such as node-cache data will be
  1963. lost from use to use of the context. This may or may not be important,
  1964. depending upon application.
  1965. *
  1966. </summary>
  1967. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  1968. </author>
  1969. <version> $Id: InternalContextAdapterImpl.cs,v 1.4 2003/10/27 13:54:08 corts Exp $
  1970. </version>
  1971. </member>
  1972. <member name="F:NVelocity.Context.InternalContextAdapterImpl.context">
  1973. <summary> the user data Context that we are wrapping
  1974. </summary>
  1975. </member>
  1976. <member name="F:NVelocity.Context.InternalContextAdapterImpl.internalHousekeepingContext">
  1977. <summary> the ICB we are wrapping. We may need to make one
  1978. if the user data context implementation doesn't
  1979. support one. The default AbstractContext-derived
  1980. VelocityContext does, and it's recommended that
  1981. people derive new contexts from AbstractContext
  1982. rather than piecing things together
  1983. </summary>
  1984. </member>
  1985. <member name="F:NVelocity.Context.InternalContextAdapterImpl.internalEventContext">
  1986. <summary> The InternalEventContext that we are wrapping. If
  1987. the context passed to us doesn't support it, no
  1988. biggie. We don't make it for them - since its a
  1989. user context thing, nothing gained by making one
  1990. for them now
  1991. </summary>
  1992. </member>
  1993. <member name="M:NVelocity.Context.InternalContextAdapterImpl.#ctor(NVelocity.Context.IContext)">
  1994. <summary> CTOR takes a Context and wraps it, delegating all 'data' calls
  1995. to it.
  1996. For support of internal contexts, it will create an InternalContextBase
  1997. if need be.
  1998. </summary>
  1999. </member>
  2000. <member name="M:NVelocity.Context.InternalContextAdapterImpl.AttachEventCartridge(NVelocity.App.Events.EventCartridge)">
  2001. <summary> returns the user data context that
  2002. we are wrapping
  2003. </summary>
  2004. <summary> Returns the base context that we are
  2005. wrapping. Here, its this, but for other thing
  2006. like VM related context contortions, it can
  2007. be something else
  2008. </summary>
  2009. </member>
  2010. <member name="T:NVelocity.Context.VMContext">
  2011. <summary> This is a special, internal-use-only context implementation to be
  2012. used for the new Velocimacro implementation.
  2013. *
  2014. The main distinguishing feature is the management of the VMProxyArg objects
  2015. in the put() and get() methods.
  2016. *
  2017. Further, this context also supports the 'VM local context' mode, where
  2018. any get() or put() of references that aren't args to the VM are considered
  2019. local to the vm, protecting the global context.
  2020. </summary>
  2021. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2022. </author>
  2023. <version> $Id: VMContext.cs,v 1.4 2003/10/27 13:54:08 corts Exp $
  2024. </version>
  2025. </member>
  2026. <member name="F:NVelocity.Context.VMContext.vmProxyHash">
  2027. <summary>container for our VMProxy Objects
  2028. </summary>
  2029. </member>
  2030. <member name="F:NVelocity.Context.VMContext.localContext">
  2031. <summary>container for any local or constant VMProxy items
  2032. </summary>
  2033. </member>
  2034. <member name="F:NVelocity.Context.VMContext.innerContext">
  2035. <summary>the base context store. This is the 'global' context
  2036. </summary>
  2037. </member>
  2038. <member name="F:NVelocity.Context.VMContext.wrappedContext">
  2039. <summary>context that we are wrapping
  2040. </summary>
  2041. </member>
  2042. <member name="F:NVelocity.Context.VMContext.localContextScope">
  2043. <summary>support for local context scope feature, where all references are local
  2044. </summary>
  2045. </member>
  2046. <member name="M:NVelocity.Context.VMContext.#ctor(NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.IRuntimeServices)">
  2047. <summary> CTOR, wraps an ICA
  2048. </summary>
  2049. </member>
  2050. <member name="M:NVelocity.Context.VMContext.AddVMProxyArg(NVelocity.Runtime.Directive.VMProxyArg)">
  2051. <summary> return the inner / user context
  2052. </summary>
  2053. <summary> Used to put VMProxyArgs into this context. It separates
  2054. the VMProxyArgs into constant and non-constant types
  2055. pulling out the value of the constant types so they can
  2056. be modified w/o damaging the VMProxyArg, and leaving the
  2057. dynamic ones, as they modify context rather than their own
  2058. state
  2059. </summary>
  2060. <param name="vmpa">VMProxyArg to add
  2061. </param>
  2062. </member>
  2063. <member name="M:NVelocity.Context.VMContext.Put(System.String,System.Object)">
  2064. <summary> Impl of the Context.put() method.
  2065. *
  2066. </summary>
  2067. <param name="key">name of item to set
  2068. </param>
  2069. <param name="value">object to set to key
  2070. </param>
  2071. <returns>old stored object
  2072. </returns>
  2073. </member>
  2074. <member name="M:NVelocity.Context.VMContext.Get(System.String)">
  2075. <summary> Impl of the Context.gut() method.
  2076. *
  2077. </summary>
  2078. <param name="key">name of item to get
  2079. </param>
  2080. <returns> stored object or null
  2081. </returns>
  2082. </member>
  2083. <member name="M:NVelocity.Context.VMContext.ContainsKey(System.Object)">
  2084. <summary> not yet impl
  2085. </summary>
  2086. </member>
  2087. <member name="M:NVelocity.Context.VMContext.Remove(System.Object)">
  2088. <summary> impl badly
  2089. </summary>
  2090. <summary> impl badly
  2091. </summary>
  2092. </member>
  2093. <member name="T:NVelocity.Exception.MethodInvocationException">
  2094. <summary>
  2095. Application-level exception thrown when a reference method is
  2096. invoked and an exception is thrown.
  2097. <br/>
  2098. When this exception is thrown, a best effort will be made to have
  2099. useful information in the exception's message. For complete
  2100. information, consult the runtime log.
  2101. </summary>
  2102. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  2103. <version> $Id: MethodInvocationException.cs,v 1.3 2003/10/27 13:54:08 corts Exp $ </version>
  2104. </member>
  2105. <member name="T:NVelocity.Exception.VelocityException">
  2106. <summary>
  2107. Base class for Velocity exceptions thrown to the
  2108. application layer.
  2109. </summary>
  2110. </member>
  2111. <member name="M:NVelocity.Exception.MethodInvocationException.#ctor(System.String,System.Exception,System.String)">
  2112. <summary>
  2113. Wraps the passed in exception for examination later
  2114. </summary>
  2115. </member>
  2116. <member name="T:NVelocity.Exception.ParseErrorException">
  2117. <summary> Application-level exception thrown when a resource of any type
  2118. has a syntax or other error which prevents it from being parsed.
  2119. <br/>
  2120. When this resource is thrown, a best effort will be made to have
  2121. useful information in the exception's message. For complete
  2122. information, consult the runtime log.
  2123. *
  2124. </summary>
  2125. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2126. </author>
  2127. <version> $Id: ParseErrorException.cs,v 1.3 2003/10/27 13:54:08 corts Exp $
  2128. </version>
  2129. </member>
  2130. <member name="T:NVelocity.Exception.ResourceNotFoundException">
  2131. <summary>
  2132. Application-level exception thrown when a resource of any type
  2133. isn't found by the Velocity engine.
  2134. <br/>
  2135. When this exception is thrown, a best effort will be made to have
  2136. useful information in the exception's message. For complete
  2137. information, consult the runtime log.
  2138. </summary>
  2139. </member>
  2140. <member name="T:NVelocity.Runtime.Directive.Directive">
  2141. <summary> Base class for all directives used in Velocity.</summary>
  2142. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2143. <version> $Id: Directive.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2144. </member>
  2145. <member name="M:NVelocity.Runtime.Directive.Directive.Init(NVelocity.Runtime.IRuntimeServices,NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.Parser.Node.INode)">
  2146. <summary>
  2147. How this directive is to be initialized.
  2148. </summary>
  2149. </member>
  2150. <member name="M:NVelocity.Runtime.Directive.Directive.SetLocation(System.Int32,System.Int32)">
  2151. <summary>
  2152. Allows the template location to be set
  2153. </summary>
  2154. </member>
  2155. <member name="M:NVelocity.Runtime.Directive.Directive.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2156. <summary>
  2157. How this directive is to be rendered
  2158. </summary>
  2159. </member>
  2160. <member name="P:NVelocity.Runtime.Directive.Directive.Name">
  2161. <summary>
  2162. Return the name of this directive
  2163. </summary>
  2164. </member>
  2165. <member name="P:NVelocity.Runtime.Directive.Directive.Type">
  2166. <summary>
  2167. Get the directive type BLOCK/LINE
  2168. </summary>
  2169. </member>
  2170. <member name="P:NVelocity.Runtime.Directive.Directive.Line">
  2171. <summary>
  2172. for log msg purposes
  2173. </summary>
  2174. </member>
  2175. <member name="P:NVelocity.Runtime.Directive.Directive.Column">
  2176. <summary>
  2177. for log msg purposes
  2178. </summary>
  2179. </member>
  2180. <member name="T:NVelocity.Runtime.Directive.DirectiveType">
  2181. <summary>
  2182. Directive Types
  2183. </summary>
  2184. </member>
  2185. <member name="T:NVelocity.Runtime.Directive.Foreach">
  2186. <summary>
  2187. Foreach directive used for moving through arrays,
  2188. or objects that provide an Iterator.
  2189. </summary>
  2190. </member>
  2191. <member name="F:NVelocity.Runtime.Directive.Foreach.counterName">
  2192. <summary>
  2193. The name of the variable to use when placing
  2194. the counter value into the context. Right
  2195. now the default is $velocityCount.
  2196. </summary>
  2197. </member>
  2198. <member name="F:NVelocity.Runtime.Directive.Foreach.counterInitialValue">
  2199. <summary>
  2200. What value to start the loop counter at.
  2201. </summary>
  2202. </member>
  2203. <member name="F:NVelocity.Runtime.Directive.Foreach.elementKey">
  2204. <summary>
  2205. The reference name used to access each
  2206. of the elements in the list object. It
  2207. is the $item in the following:
  2208. #foreach ($item in $list)
  2209. This can be used class wide because
  2210. it is immutable.
  2211. </summary>
  2212. </member>
  2213. <member name="M:NVelocity.Runtime.Directive.Foreach.Init(NVelocity.Runtime.IRuntimeServices,NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.Parser.Node.INode)">
  2214. <summary>
  2215. simple init - init the tree and get the elementKey from
  2216. the AST
  2217. </summary>
  2218. </member>
  2219. <member name="M:NVelocity.Runtime.Directive.Foreach.GetIterator(NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.Parser.Node.INode)">
  2220. <summary>
  2221. returns an Iterator to the collection in the #foreach()
  2222. </summary>
  2223. <param name="context"> current context </param>
  2224. <param name="node"> AST node </param>
  2225. <returns>Iterator to do the dataset </returns>
  2226. </member>
  2227. <member name="M:NVelocity.Runtime.Directive.Foreach.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2228. <summary>
  2229. renders the #foreach() block
  2230. </summary>
  2231. </member>
  2232. <member name="P:NVelocity.Runtime.Directive.Foreach.Name">
  2233. <summary>
  2234. Return name of this directive.
  2235. </summary>
  2236. </member>
  2237. <member name="P:NVelocity.Runtime.Directive.Foreach.Type">
  2238. <summary>
  2239. Return type of this directive.
  2240. </summary>
  2241. </member>
  2242. <member name="T:NVelocity.Runtime.Directive.Include">
  2243. <summary>
  2244. Pluggable directive that handles the #include() statement in VTL.
  2245. This #include() can take multiple arguments of either
  2246. StringLiteral or Reference.
  2247. Notes:
  2248. -----
  2249. 1) The included source material can only come from somewhere in
  2250. the TemplateRoot tree for security reasons. There is no way
  2251. around this. If you want to include content from elsewhere on
  2252. your disk, use a link from somewhere under Template Root to that
  2253. content.
  2254. 2) By default, there is no output to the render stream in the event of
  2255. a problem. You can override this behavior with two property values :
  2256. include.output.errormsg.start
  2257. include.output.errormsg.end
  2258. If both are defined in velocity.properties, they will be used to
  2259. in the render output to bracket the arg string that caused the
  2260. problem.
  2261. Ex. : if you are working in html then
  2262. include.output.errormsg.start=<!-- #include error :
  2263. include.output.errormsg.end= -->
  2264. might be an excellent way to start...
  2265. 3) As noted above, #include() can take multiple arguments.
  2266. Ex : #include( "foo.vm" "bar.vm" $foo )
  2267. will simply include all three if valid to output w/o any
  2268. special separator.
  2269. </summary>
  2270. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2271. </author>
  2272. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  2273. </author>
  2274. <author> <a href="mailto:kav@kav.dk">Kasper Nielsen</a>
  2275. </author>
  2276. <version> $Id: Include.cs,v 1.3 2003/10/27 13:54:10 corts Exp $
  2277. </version>
  2278. </member>
  2279. <member name="M:NVelocity.Runtime.Directive.Include.Init(NVelocity.Runtime.IRuntimeServices,NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.Parser.Node.INode)">
  2280. <summary>
  2281. simple init - init the tree and get the elementKey from
  2282. the AST
  2283. </summary>
  2284. </member>
  2285. <member name="M:NVelocity.Runtime.Directive.Include.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2286. <summary>
  2287. iterates through the argument list and renders every
  2288. argument that is appropriate. Any non appropriate
  2289. arguments are logged, but render() continues.
  2290. </summary>
  2291. </member>
  2292. <member name="M:NVelocity.Runtime.Directive.Include.RenderOutput(NVelocity.Runtime.Parser.Node.INode,NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter)">
  2293. <summary>
  2294. does the actual rendering of the included file
  2295. </summary>
  2296. <param name="node">AST argument of type StringLiteral or Reference</param>
  2297. <param name="context">valid context so we can render References</param>
  2298. <param name="writer">output Writer</param>
  2299. <returns>boolean success or failure. failures are logged</returns>
  2300. </member>
  2301. <member name="M:NVelocity.Runtime.Directive.Include.OutputErrorToStream(System.IO.TextWriter,System.String)">
  2302. <summary>
  2303. Puts a message to the render output stream if ERRORMSG_START / END
  2304. are valid property strings. Mainly used for end-user template
  2305. debugging.
  2306. </summary>
  2307. </member>
  2308. <member name="P:NVelocity.Runtime.Directive.Include.Name">
  2309. <summary>
  2310. Return name of this directive.
  2311. </summary>
  2312. </member>
  2313. <member name="P:NVelocity.Runtime.Directive.Include.Type">
  2314. <summary> Return type of this directive.</summary>
  2315. </member>
  2316. <member name="T:NVelocity.Runtime.Directive.Literal">
  2317. <summary>
  2318. A very simple directive that leverages the Node.literal()
  2319. to grab the literal rendition of a node. We basically
  2320. grab the literal value on init(), then repeatedly use
  2321. that during render().
  2322. </summary>
  2323. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2324. <version> $Id: Literal.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2325. </member>
  2326. <member name="M:NVelocity.Runtime.Directive.Literal.Init(NVelocity.Runtime.IRuntimeServices,NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.Parser.Node.INode)">
  2327. <summary>
  2328. Store the literal rendition of a node using
  2329. the Node.literal().
  2330. </summary>
  2331. </member>
  2332. <member name="M:NVelocity.Runtime.Directive.Literal.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2333. <summary> Throw the literal rendition of the block between
  2334. #literal()/#end into the writer.
  2335. </summary>
  2336. </member>
  2337. <member name="P:NVelocity.Runtime.Directive.Literal.Name">
  2338. <summary>Return name of this directive.</summary>
  2339. </member>
  2340. <member name="P:NVelocity.Runtime.Directive.Literal.Type">
  2341. <summary> Return type of this directive. </summary>
  2342. </member>
  2343. <member name="T:NVelocity.Runtime.Directive.Macro">
  2344. <summary>
  2345. Macro implements the macro definition directive of VTL.
  2346. example :
  2347. #macro( isnull $i )
  2348. #if( $i )
  2349. $i
  2350. #end
  2351. #end
  2352. This object is used at parse time to mainly process and register the
  2353. macro. It is used inline in the parser when processing a directive.
  2354. </summary>
  2355. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  2356. <version> $Id: Macro.cs,v 1.3 2003/10/27 13:54:10 corts Exp $</version>
  2357. </member>
  2358. <member name="M:NVelocity.Runtime.Directive.Macro.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2359. <summary> Return name of this directive.
  2360. </summary>
  2361. <summary> Return type of this directive.
  2362. </summary>
  2363. <summary> render() doesn't do anything in the final output rendering.
  2364. There is no output from a #macro() directive.
  2365. </summary>
  2366. </member>
  2367. <member name="M:NVelocity.Runtime.Directive.Macro.processAndRegister(NVelocity.Runtime.IRuntimeServices,NVelocity.Runtime.Parser.Node.INode,System.String)">
  2368. <summary>
  2369. Used by Parser.java to process VMs within the parsing process
  2370. processAndRegister() doesn't actually render the macro to the output
  2371. Processes the macro body into the internal representation used by the
  2372. VelocimacroProxy objects, and if not currently used, adds it
  2373. to the macro Factory
  2374. </summary>
  2375. </member>
  2376. <member name="M:NVelocity.Runtime.Directive.Macro.getArgArray(NVelocity.Runtime.Parser.Node.INode)">
  2377. <summary> creates an array containing the literal
  2378. strings in the macro argument
  2379. </summary>
  2380. </member>
  2381. <member name="M:NVelocity.Runtime.Directive.Macro.getASTAsStringArray(NVelocity.Runtime.Parser.Node.INode)">
  2382. <summary> Returns an array of the literal rep of the AST
  2383. </summary>
  2384. </member>
  2385. <member name="T:NVelocity.Runtime.Directive.Parse">
  2386. <summary>
  2387. Pluggable directive that handles the #parse() statement in VTL.
  2388. Notes:
  2389. -----
  2390. 1) The parsed source material can only come from somewhere in
  2391. the TemplateRoot tree for security reasons. There is no way
  2392. around this. If you want to include content from elsewhere on
  2393. your disk, use a link from somewhere under Template Root to that
  2394. content.
  2395. 2) There is a limited parse depth. It is set as a property
  2396. "parse_directive.maxdepth = 10" for example. There is a 20 iteration
  2397. safety in the event that the parameter isn't set.
  2398. </summary>
  2399. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  2400. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2401. <author> <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a> </author>
  2402. <version> $Id: Parse.cs,v 1.4 2003/10/27 13:54:10 corts Exp $ </version>
  2403. </member>
  2404. <member name="M:NVelocity.Runtime.Directive.Parse.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2405. <summary>
  2406. iterates through the argument list and renders every
  2407. argument that is appropriate. Any non appropriate
  2408. arguments are logged, but render() continues.
  2409. </summary>
  2410. </member>
  2411. <member name="M:NVelocity.Runtime.Directive.Parse.AssertTemplateStack(NVelocity.Context.IInternalContextAdapter)">
  2412. <summary>
  2413. See if we have exceeded the configured depth.
  2414. If it isn't configured, put a stop at 20 just in case.
  2415. </summary>
  2416. </member>
  2417. <member name="P:NVelocity.Runtime.Directive.Parse.Name">
  2418. <summary>
  2419. Return name of this directive.
  2420. </summary>
  2421. </member>
  2422. <member name="P:NVelocity.Runtime.Directive.Parse.Type">
  2423. <summary> Return type of this directive. </summary>
  2424. </member>
  2425. <member name="T:NVelocity.Runtime.Directive.ParseDirectiveException">
  2426. <summary> Exception for #parse() problems
  2427. *
  2428. </summary>
  2429. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2430. </author>
  2431. <version> $Id: ParseDirectiveException.cs,v 1.3 2003/10/27 13:54:10 corts Exp $
  2432. </version>
  2433. </member>
  2434. <member name="M:NVelocity.Runtime.Directive.ParseDirectiveException.#ctor(System.String,System.Int32)">
  2435. <summary> Constructor
  2436. </summary>
  2437. </member>
  2438. <member name="M:NVelocity.Runtime.Directive.ParseDirectiveException.addFile(System.String)">
  2439. <summary> Get a message.
  2440. </summary>
  2441. <summary> Add a file to the filename stack
  2442. </summary>
  2443. </member>
  2444. <member name="T:NVelocity.Runtime.Directive.VelocimacroProxy">
  2445. <summary>
  2446. VelocimacroProxy
  2447. a proxy Directive-derived object to fit with the current directive system
  2448. </summary>
  2449. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  2450. <version> $Id: VelocimacroProxy.cs,v 1.4 2003/10/27 13:54:10 corts Exp $ </version>
  2451. </member>
  2452. <member name="M:NVelocity.Runtime.Directive.VelocimacroProxy.Init(NVelocity.Runtime.IRuntimeServices,NVelocity.Context.IInternalContextAdapter,NVelocity.Runtime.Parser.Node.INode)">
  2453. <summary>
  2454. The major meat of VelocimacroProxy, init() checks the # of arguments,
  2455. patches the macro body, renders the macro into an AST, and then initiates
  2456. the AST, so it is ready for quick rendering. Note that this is only
  2457. AST dependant stuff. Not context.
  2458. </summary>
  2459. </member>
  2460. <member name="M:NVelocity.Runtime.Directive.VelocimacroProxy.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter,NVelocity.Runtime.Parser.Node.INode)">
  2461. <summary>
  2462. Renders the macro using the context
  2463. </summary>
  2464. </member>
  2465. <member name="M:NVelocity.Runtime.Directive.VelocimacroProxy.setupMacro(System.String[],System.Int32[])">
  2466. <summary>
  2467. basic VM setup. Sets up the proxy args for this
  2468. use, and parses the tree
  2469. </summary>
  2470. </member>
  2471. <member name="M:NVelocity.Runtime.Directive.VelocimacroProxy.parseTree(System.String[])">
  2472. <summary>
  2473. parses the macro. We need to do this here, at init time, or else
  2474. the local-scope template feature is hard to get to work :)
  2475. </summary>
  2476. </member>
  2477. <member name="M:NVelocity.Runtime.Directive.VelocimacroProxy.getArgArray(NVelocity.Runtime.Parser.Node.INode)">
  2478. <summary>
  2479. Gets the args to the VM from the instance-use AST
  2480. </summary>
  2481. </member>
  2482. <member name="P:NVelocity.Runtime.Directive.VelocimacroProxy.Name">
  2483. <summary>
  2484. The name of this Velocimacro.
  2485. </summary>
  2486. </member>
  2487. <member name="P:NVelocity.Runtime.Directive.VelocimacroProxy.Type">
  2488. <summary>
  2489. Velocimacros are always LINE
  2490. type directives.
  2491. </summary>
  2492. </member>
  2493. <member name="P:NVelocity.Runtime.Directive.VelocimacroProxy.ArgArray">
  2494. <summary>
  2495. Sets the array of arguments specified in the macro definition
  2496. </summary>
  2497. </member>
  2498. <member name="P:NVelocity.Runtime.Directive.VelocimacroProxy.NumArgs">
  2499. <summary>
  2500. Returns the number of arguments needed for this VM
  2501. </summary>
  2502. </member>
  2503. <member name="P:NVelocity.Runtime.Directive.VelocimacroProxy.MacroBody">
  2504. <summary>
  2505. Sets the original macro body. This is simply the cat of the
  2506. macroArray, but the Macro object creates this once during parsing,
  2507. and everyone shares it.
  2508. Note : it must not be modified.
  2509. </summary>
  2510. </member>
  2511. <member name="T:NVelocity.Runtime.Directive.VMProxyArg">
  2512. <summary>
  2513. The function of this class is to proxy for the calling parameter to the VM.
  2514. *
  2515. This class is designed to be used in conjunction with the VMContext class
  2516. which knows how to get and set values via it, rather than a simple get()
  2517. or put() from a hashtable-like object.
  2518. *
  2519. There is probably a lot of undocumented subtlety here, so step lightly.
  2520. *
  2521. We rely on the observation that an instance of this object has a constant
  2522. state throughout its lifetime as it's bound to the use-instance of a VM.
  2523. In other words, it's created by the VelocimacroProxy class, to represent
  2524. one of the arguments to a VM in a specific template. Since the template
  2525. is fixed (it's a file...), we don't have to worry that the args to the VM
  2526. will change. Yes, the VM will be called in other templates, or in other
  2527. places on the same template, bit those are different use-instances.
  2528. *
  2529. These arguments can be, in the lingo of
  2530. the parser, one of :
  2531. <ul>
  2532. <li> Reference() : anything that starts with '$'</li>
  2533. <li> StringLiteral() : something like "$foo" or "hello geir"</li>
  2534. <li> NumberLiteral() : 1, 2 etc</li>
  2535. <li> IntegerRange() : [ 1..2] or [$foo .. $bar]</li>
  2536. <li> ObjectArray() : [ "a", "b", "c"]</li>
  2537. <li> True() : true</li>
  2538. <li> False() : false</li>
  2539. <li>Word() : not likely - this is simply allowed by the parser so we can have
  2540. syntactical sugar like #foreach($a in $b) where 'in' is the Word</li>
  2541. </ul>
  2542. Now, Reference(), StringLit, NumberLit, IntRange, ObjArr are all dynamic things, so
  2543. their value is gotten with the use of a context. The others are constants. The trick
  2544. we rely on is that the context rather than this class really represents the
  2545. state of the argument. We are simply proxying for the thing, returning the proper value
  2546. when asked, and storing the proper value in the appropriate context when asked.
  2547. *
  2548. So, the hope here, so an instance of this can be shared across threads, is to
  2549. keep any dynamic stuff out of it, relying on trick of having the appropriate
  2550. context handed to us, and when a constant argument, letting VMContext punch that
  2551. into a local context.
  2552. </summary>
  2553. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2554. </author>
  2555. <version> $Id: VMProxyArg.cs,v 1.4 2003/10/27 13:54:10 corts Exp $
  2556. </version>
  2557. </member>
  2558. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.GENERALSTATIC">
  2559. <summary>in the event our type is switched - we don't care really what it is
  2560. </summary>
  2561. </member>
  2562. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.type">
  2563. <summary>type of arg I will have
  2564. </summary>
  2565. </member>
  2566. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.nodeTree">
  2567. <summary>the AST if the type is such that it's dynamic (ex. JJTREFERENCE )
  2568. </summary>
  2569. </member>
  2570. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.staticObject">
  2571. <summary>reference for the object if we proxy for a static arg like an NumberLiteral
  2572. </summary>
  2573. </member>
  2574. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.userContext">
  2575. <summary>not used in this impl : carries the appropriate user context
  2576. </summary>
  2577. </member>
  2578. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.numTreeChildren">
  2579. <summary>number of children in our tree if a reference
  2580. </summary>
  2581. </member>
  2582. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.contextReference">
  2583. <summary>our identity in the current context
  2584. </summary>
  2585. </member>
  2586. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.callerReference">
  2587. <summary>the reference we are proxying for
  2588. </summary>
  2589. </member>
  2590. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.singleLevelRef">
  2591. <summary>the 'de-dollared' reference if we are a ref but don't have a method attached
  2592. </summary>
  2593. </member>
  2594. <member name="F:NVelocity.Runtime.Directive.VMProxyArg.constant">
  2595. <summary>by default, we are dynamic. safest
  2596. </summary>
  2597. </member>
  2598. <member name="M:NVelocity.Runtime.Directive.VMProxyArg.#ctor(NVelocity.Runtime.IRuntimeServices,System.String,System.String,System.Int32)">
  2599. <summary> ctor for current impl
  2600. *
  2601. takes the reference literal we are proxying for, the literal
  2602. the VM we are for is called with...
  2603. *
  2604. </summary>
  2605. <param name="rs">
  2606. </param>
  2607. <param name="contextRef">reference arg in the definition of the VM, used in the VM
  2608. </param>
  2609. <param name="callerRef"> reference used by the caller as an arg to the VM
  2610. </param>
  2611. <param name="t"> type of arg : JJTREFERENCE, JJTTRUE, etc
  2612. </param>
  2613. </member>
  2614. <member name="M:NVelocity.Runtime.Directive.VMProxyArg.isConstant">
  2615. <summary> tells if arg we are proxying for is
  2616. dynamic or constant.
  2617. *
  2618. </summary>
  2619. <returns>true of constant, false otherwise
  2620. </returns>
  2621. </member>
  2622. <member name="M:NVelocity.Runtime.Directive.VMProxyArg.setObject(NVelocity.Context.IInternalContextAdapter,System.Object)">
  2623. <summary> Invoked by VMContext when Context.put() is called for a proxied reference.
  2624. *
  2625. </summary>
  2626. <param name="context">context to modify via direct placement, or AST.setValue()
  2627. </param>
  2628. <param name="o"> new value of reference
  2629. </param>
  2630. <returns>Object currently null
  2631. </returns>
  2632. </member>
  2633. <member name="M:NVelocity.Runtime.Directive.VMProxyArg.getObject(NVelocity.Context.IInternalContextAdapter)">
  2634. <summary> returns the value of the reference. Generally, this is only
  2635. called for dynamic proxies, as the static ones should have
  2636. been stored in the VMContext's localContext store
  2637. *
  2638. </summary>
  2639. <param name="context">Context to use for getting current value
  2640. </param>
  2641. <returns>Object value
  2642. *
  2643. </returns>
  2644. </member>
  2645. <member name="M:NVelocity.Runtime.Directive.VMProxyArg.setup">
  2646. <summary> does the housekeeping upon creating. If a dynamic type
  2647. it needs to make an AST for further get()/set() operations
  2648. Anything else is constant.
  2649. </summary>
  2650. </member>
  2651. <member name="M:NVelocity.Runtime.Directive.VMProxyArg.#ctor(NVelocity.Runtime.Directive.VMProxyArg,NVelocity.Context.IInternalContextAdapter)">
  2652. <summary> not used in current impl
  2653. *
  2654. Constructor for alternate impl where VelProxy class would make new
  2655. VMProxyArg objects, and use this constructor to avoid re-parsing the
  2656. reference args
  2657. *
  2658. that impl also had the VMProxyArg carry it's context
  2659. </summary>
  2660. </member>
  2661. <member name="T:NVelocity.Runtime.Exception.ReferenceException">
  2662. <summary> Exception thrown when a bad reference is found.
  2663. *
  2664. </summary>
  2665. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2666. </author>
  2667. <version> $Id: ReferenceException.cs,v 1.3 2003/10/27 13:54:10 corts Exp $
  2668. </version>
  2669. </member>
  2670. <member name="F:NVelocity.Runtime.Log.LogLevel.Debug">
  2671. <summary>
  2672. Prefix for debug messages.
  2673. </summary>
  2674. </member>
  2675. <member name="F:NVelocity.Runtime.Log.LogLevel.Info">
  2676. <summary>
  2677. Prefix for info messages.
  2678. </summary>
  2679. </member>
  2680. <member name="F:NVelocity.Runtime.Log.LogLevel.Warn">
  2681. <summary>
  2682. Prefix for warning messages.
  2683. </summary>
  2684. </member>
  2685. <member name="F:NVelocity.Runtime.Log.LogLevel.Error">
  2686. <summary>
  2687. Prefix for error messages.
  2688. </summary>
  2689. </member>
  2690. <member name="T:NVelocity.Runtime.Log.ILogSystem">
  2691. <summary>
  2692. Base interface that Logging systems need to implement.
  2693. </summary>
  2694. <author> <a href="mailto:jon@latchkey.com">Jon S. Stevens</a></author>
  2695. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  2696. </member>
  2697. <member name="M:NVelocity.Runtime.Log.ILogSystem.Init(NVelocity.Runtime.IRuntimeServices)">
  2698. <summary>
  2699. init()
  2700. </summary>
  2701. </member>
  2702. <member name="M:NVelocity.Runtime.Log.ILogSystem.LogVelocityMessage(NVelocity.Runtime.Log.LogLevel,System.String)">
  2703. <summary>
  2704. Send a log message from Velocity.
  2705. </summary>
  2706. </member>
  2707. <member name="T:NVelocity.Runtime.Log.LogManager">
  2708. <summary>
  2709. <p>
  2710. This class is responsible for instantiating the correct LoggingSystem
  2711. </p>
  2712. <p>
  2713. The approach is :
  2714. </p>
  2715. <ul>
  2716. <li>
  2717. First try to see if the user is passing in a living object
  2718. that is a LogSystem, allowing the app to give is living
  2719. custom loggers.
  2720. </li>
  2721. <li>
  2722. Next, run through the (possible) list of classes specified
  2723. specified as loggers, taking the first one that appears to
  2724. work. This is how we support finding either log4j or
  2725. logkit, whichever is in the classpath, as both are
  2726. listed as defaults.
  2727. </li>
  2728. <li>
  2729. Finally, we turn to 'faith-based' logging, and hope that
  2730. logkit is in the classpath, and try for an AvalonLogSystem
  2731. as a final gasp. After that, there is nothing we can do.
  2732. </li>
  2733. </ul>
  2734. </summary>
  2735. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  2736. <author> <a href="mailto:jon@latchkey.com">Jon S. Stevens</a></author>
  2737. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  2738. </member>
  2739. <member name="M:NVelocity.Runtime.Log.LogManager.CreateLogSystem(NVelocity.Runtime.IRuntimeServices)">
  2740. <summary> Creates a new logging system or returns an existing one
  2741. specified by the application.
  2742. </summary>
  2743. </member>
  2744. <member name="T:NVelocity.Runtime.Log.NullLogSystem">
  2745. <summary> Logger used in case of failure. Does nothing.
  2746. *
  2747. </summary>
  2748. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2749. </author>
  2750. <version> $Id: NullLogSystem.cs,v 1.4 2003/10/27 13:54:10 corts Exp $
  2751. </version>
  2752. </member>
  2753. <member name="M:NVelocity.Runtime.Log.NullLogSystem.LogVelocityMessage(NVelocity.Runtime.Log.LogLevel,System.String)">
  2754. <summary>
  2755. logs messages to the great Garbage Collector in the sky
  2756. </summary>
  2757. <param name="level">severity level</param>
  2758. <param name="message">complete error message</param>
  2759. </member>
  2760. <member name="T:NVelocity.Runtime.Parser.Node.AbstractExecutor">
  2761. <summary> Abstract class that is used to execute an arbitrary
  2762. method that is in introspected. This is the superclass
  2763. for the GetExecutor and PropertyExecutor.
  2764. </summary>
  2765. </member>
  2766. <member name="F:NVelocity.Runtime.Parser.Node.AbstractExecutor.method">
  2767. <summary>
  2768. Method to be executed.
  2769. </summary>
  2770. </member>
  2771. <member name="M:NVelocity.Runtime.Parser.Node.AbstractExecutor.Execute(System.Object)">
  2772. <summary>
  2773. Execute method against context.
  2774. </summary>
  2775. </member>
  2776. <member name="T:NVelocity.Runtime.Parser.Node.ASTAddNode">
  2777. <summary>
  2778. Handles integer addition of nodes
  2779. Please look at the Parser.jjt file which is
  2780. what controls the generation of this class.
  2781. </summary>
  2782. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2783. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  2784. <version> $Id: ASTAddNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2785. </member>
  2786. <member name="T:NVelocity.Runtime.Parser.Node.INode">
  2787. <summary> All AST nodes must implement this interface. It provides basic
  2788. machinery for constructing the parent and child relationships
  2789. between nodes.
  2790. </summary>
  2791. </member>
  2792. <member name="M:NVelocity.Runtime.Parser.Node.INode.Open">
  2793. <summary>
  2794. This method is called after the node has been made the current
  2795. node. It indicates that child nodes can now be added to it.
  2796. </summary>
  2797. </member>
  2798. <member name="M:NVelocity.Runtime.Parser.Node.INode.Close">
  2799. <summary>
  2800. This method is called after all the child nodes have been added.
  2801. </summary>
  2802. </member>
  2803. <member name="M:NVelocity.Runtime.Parser.Node.INode.AddChild(NVelocity.Runtime.Parser.Node.INode,System.Int32)">
  2804. <summary>
  2805. This method tells the node to add its argument to the node's
  2806. list of children.
  2807. </summary>
  2808. </member>
  2809. <member name="M:NVelocity.Runtime.Parser.Node.INode.GetChild(System.Int32)">
  2810. <summary>
  2811. This method returns a child node. The children are numbered
  2812. from zero, left to right.
  2813. </summary>
  2814. </member>
  2815. <member name="M:NVelocity.Runtime.Parser.Node.INode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2816. <summary>
  2817. Accept the visitor.
  2818. </summary>
  2819. </member>
  2820. <member name="M:NVelocity.Runtime.Parser.Node.SimpleNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2821. <summary>Accept the visitor. *
  2822. </summary>
  2823. </member>
  2824. <member name="M:NVelocity.Runtime.Parser.Node.SimpleNode.ChildrenAccept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2825. <summary>Accept the visitor. *
  2826. </summary>
  2827. </member>
  2828. <member name="M:NVelocity.Runtime.Parser.Node.ASTAddNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2829. <summary>
  2830. Accept the visitor.
  2831. </summary>
  2832. </member>
  2833. <member name="M:NVelocity.Runtime.Parser.Node.ASTAddNode.Value(NVelocity.Context.IInternalContextAdapter)">
  2834. <summary>
  2835. Computes the sum of the two nodes.
  2836. Currently only integer operations are supported.
  2837. </summary>
  2838. <returns>Integer object with value, or null</returns>
  2839. </member>
  2840. <member name="T:NVelocity.Runtime.Parser.Node.ASTAndNode">
  2841. <summary>
  2842. Please look at the Parser.jjt file which is
  2843. what controls the generation of this class.
  2844. </summary>
  2845. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2846. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  2847. <version> $Id: ASTAndNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2848. </member>
  2849. <member name="M:NVelocity.Runtime.Parser.Node.ASTAndNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2850. <summary>
  2851. Accept the visitor.
  2852. </summary>
  2853. </member>
  2854. <member name="M:NVelocity.Runtime.Parser.Node.ASTAndNode.Value(NVelocity.Context.IInternalContextAdapter)">
  2855. <summary> Returns the value of the expression.
  2856. Since the value of the expression is simply the boolean
  2857. result of evaluate(), lets return that.
  2858. </summary>
  2859. </member>
  2860. <member name="M:NVelocity.Runtime.Parser.Node.ASTAndNode.Evaluate(NVelocity.Context.IInternalContextAdapter)">
  2861. <summary>
  2862. logical and :
  2863. null &amp;&amp; right = false
  2864. left &amp;&amp; null = false
  2865. null &amp;&amp; null = false
  2866. </summary>
  2867. </member>
  2868. <member name="M:NVelocity.Runtime.Parser.Node.ASTAssignment.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2869. <summary>
  2870. Accept the visitor.
  2871. </summary>
  2872. </member>
  2873. <member name="M:NVelocity.Runtime.Parser.Node.ASTBlock.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2874. <summary>
  2875. Accept the visitor.
  2876. </summary>
  2877. </member>
  2878. <member name="M:NVelocity.Runtime.Parser.Node.ASTComment.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2879. <summary>
  2880. Accept the visitor.
  2881. </summary>
  2882. </member>
  2883. <member name="T:NVelocity.Runtime.Parser.Node.ASTDirective">
  2884. <summary>
  2885. This class is responsible for handling the pluggable
  2886. directives in VTL. ex. #foreach()
  2887. Please look at the Parser.jjt file which is
  2888. what controls the generation of this class.
  2889. </summary>
  2890. </member>
  2891. <member name="M:NVelocity.Runtime.Parser.Node.ASTDirective.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2892. <summary>
  2893. Accept the visitor.
  2894. </summary>
  2895. </member>
  2896. <member name="P:NVelocity.Runtime.Parser.Node.ASTDirective.DirectiveName">
  2897. <summary>
  2898. Gets or sets the directive name.
  2899. Used by the parser.
  2900. This keeps us from having to
  2901. dig it out of the token stream and gives the parse
  2902. the change to override.
  2903. </summary>
  2904. </member>
  2905. <member name="T:NVelocity.Runtime.Parser.Node.ASTDivNode">
  2906. <summary>
  2907. Handles integer division of nodes
  2908. Please look at the Parser.jjt file which is
  2909. what controls the generation of this class.
  2910. </summary>
  2911. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2912. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  2913. <version> $Id: ASTDivNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2914. </member>
  2915. <member name="M:NVelocity.Runtime.Parser.Node.ASTDivNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2916. <summary>
  2917. Accept the visitor.
  2918. </summary>
  2919. </member>
  2920. <member name="M:NVelocity.Runtime.Parser.Node.ASTDivNode.Value(NVelocity.Context.IInternalContextAdapter)">
  2921. <summary>
  2922. Computes the result of the division. Currently limited to Integers.
  2923. </summary>
  2924. <returns>Integer(value) or null</returns>
  2925. </member>
  2926. <member name="T:NVelocity.Runtime.Parser.Node.ASTElseIfStatement">
  2927. <summary> This class is responsible for handling the ElseIf VTL control statement.
  2928. Please look at the Parser.jjt file which is
  2929. what controls the generation of this class.
  2930. *
  2931. </summary>
  2932. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  2933. </author>
  2934. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  2935. </author>
  2936. <version> $Id: ASTElseIfStatement.cs,v 1.3 2003/10/27 13:54:10 corts Exp $
  2937. </version>
  2938. </member>
  2939. <member name="M:NVelocity.Runtime.Parser.Node.ASTElseIfStatement.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2940. <summary>
  2941. Accept the visitor.
  2942. </summary>
  2943. </member>
  2944. <member name="M:NVelocity.Runtime.Parser.Node.ASTElseIfStatement.Evaluate(NVelocity.Context.IInternalContextAdapter)">
  2945. <summary>
  2946. An ASTElseStatement is true if the expression
  2947. it contains evaluates to true. Expressions know
  2948. how to evaluate themselves, so we do that
  2949. here and return the value back to ASTIfStatement
  2950. where this node was originally asked to evaluate
  2951. itself.
  2952. </summary>
  2953. </member>
  2954. <member name="M:NVelocity.Runtime.Parser.Node.ASTElseIfStatement.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter)">
  2955. <summary>
  2956. renders the block
  2957. </summary>
  2958. </member>
  2959. <member name="T:NVelocity.Runtime.Parser.Node.ASTElseStatement">
  2960. <summary>
  2961. This class is responsible for handling the Else VTL control statement.
  2962. Please look at the Parser.jjt file which is
  2963. what controls the generation of this class.
  2964. </summary>
  2965. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  2966. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  2967. <version> $Id: ASTElseStatement.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2968. </member>
  2969. <member name="M:NVelocity.Runtime.Parser.Node.ASTElseStatement.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2970. <summary>
  2971. Accept the visitor.
  2972. </summary>
  2973. </member>
  2974. <member name="M:NVelocity.Runtime.Parser.Node.ASTElseStatement.Evaluate(NVelocity.Context.IInternalContextAdapter)">
  2975. <summary>
  2976. An ASTElseStatement always evaluates to
  2977. true. Basically behaves like an #if(true).
  2978. </summary>
  2979. </member>
  2980. <member name="T:NVelocity.Runtime.Parser.Node.ASTEQNode">
  2981. <summary>
  2982. Handles the equivalence operator
  2983. &lt;arg1&gt; == &lt;arg2&gt;
  2984. This operator requires that the LHS and RHS are both of the
  2985. same Class.
  2986. </summary>
  2987. <version> $Id: ASTEQNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  2988. </member>
  2989. <member name="M:NVelocity.Runtime.Parser.Node.ASTEQNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  2990. <summary>Accept the visitor. *
  2991. </summary>
  2992. </member>
  2993. <member name="M:NVelocity.Runtime.Parser.Node.ASTEQNode.Evaluate(NVelocity.Context.IInternalContextAdapter)">
  2994. <summary>
  2995. Calculates the value of the logical expression
  2996. arg1 == arg2
  2997. All class types are supported. Uses equals() to
  2998. determine equivalence. This should work as we represent
  2999. with the types we already support, and anything else that
  3000. implements equals() to mean more than identical references.
  3001. </summary>
  3002. <param name="context"> internal context used to evaluate the LHS and RHS </param>
  3003. <returns>
  3004. true if equivalent, false if not equivalent,
  3005. false if not compatible arguments, or false
  3006. if either LHS or RHS is null
  3007. </returns>
  3008. </member>
  3009. <member name="T:NVelocity.Runtime.Parser.Node.ASTEscape">
  3010. <summary> This class is responsible for handling Escapes
  3011. in VTL.
  3012. Please look at the Parser.jjt file which is
  3013. what controls the generation of this class.
  3014. *
  3015. </summary>
  3016. </member>
  3017. <member name="M:NVelocity.Runtime.Parser.Node.ASTEscape.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3018. <summary>Accept the visitor. *
  3019. </summary>
  3020. </member>
  3021. <member name="T:NVelocity.Runtime.Parser.Node.ASTEscapedDirective">
  3022. <summary>
  3023. This class is responsible for handling EscapedDirectives
  3024. in VTL.
  3025. Please look at the Parser.jjt file which is
  3026. what controls the generation of this class.
  3027. </summary>
  3028. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  3029. <version> $Id: ASTEscapedDirective.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  3030. </member>
  3031. <member name="M:NVelocity.Runtime.Parser.Node.ASTEscapedDirective.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3032. <summary>
  3033. Accept the visitor.
  3034. </summary>
  3035. </member>
  3036. <member name="M:NVelocity.Runtime.Parser.Node.ASTExpression.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3037. <summary>
  3038. Accept the visitor.
  3039. </summary>
  3040. </member>
  3041. <member name="M:NVelocity.Runtime.Parser.Node.ASTFalse.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3042. <summary>
  3043. Accept the visitor.
  3044. </summary>
  3045. </member>
  3046. <member name="M:NVelocity.Runtime.Parser.Node.ASTGENode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3047. <summary>
  3048. Accept the visitor.
  3049. </summary>
  3050. </member>
  3051. <member name="M:NVelocity.Runtime.Parser.Node.ASTGTNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3052. <summary>
  3053. Accept the visitor.
  3054. </summary>
  3055. </member>
  3056. <member name="T:NVelocity.Runtime.Parser.Node.ASTIdentifier">
  3057. <summary>
  3058. ASTIdentifier.java
  3059. Method support for identifiers : $foo
  3060. mainly used by ASTReference
  3061. Introspection is now moved to 'just in time' or at render / execution
  3062. time. There are many reasons why this has to be done, but the
  3063. primary two are thread safety, to remove any context-derived
  3064. information from class member variables.
  3065. </summary>
  3066. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  3067. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  3068. <version> $Id: ASTIdentifier.cs,v 1.5 2004/12/27 05:55:30 corts Exp $ </version>
  3069. </member>
  3070. <member name="M:NVelocity.Runtime.Parser.Node.ASTIdentifier.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3071. <summary>
  3072. Accept the visitor.
  3073. </summary>
  3074. </member>
  3075. <member name="M:NVelocity.Runtime.Parser.Node.ASTIdentifier.Init(NVelocity.Context.IInternalContextAdapter,System.Object)">
  3076. <summary>
  3077. simple init - don't do anything that is context specific.
  3078. just get what we need from the AST, which is static.
  3079. </summary>
  3080. </member>
  3081. <member name="M:NVelocity.Runtime.Parser.Node.ASTIdentifier.Execute(System.Object,NVelocity.Context.IInternalContextAdapter)">
  3082. <summary>
  3083. invokes the method on the object passed in
  3084. </summary>
  3085. </member>
  3086. <member name="M:NVelocity.Runtime.Parser.Node.ASTIfStatement.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3087. <summary>
  3088. Accept the visitor.
  3089. </summary>
  3090. </member>
  3091. <member name="M:NVelocity.Runtime.Parser.Node.ASTIncludeStatement.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3092. <summary>Accept the visitor.
  3093. </summary>
  3094. </member>
  3095. <member name="M:NVelocity.Runtime.Parser.Node.ASTIntegerRange.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3096. <summary>
  3097. Accept the visitor.
  3098. </summary>
  3099. </member>
  3100. <member name="M:NVelocity.Runtime.Parser.Node.ASTIntegerRange.Value(NVelocity.Context.IInternalContextAdapter)">
  3101. <summary>
  3102. does the real work. Creates an Vector of Integers with the
  3103. right value range
  3104. </summary>
  3105. <param name="context">app context used if Left or Right of .. is a ref</param>
  3106. <returns>Object array of Integers</returns>
  3107. </member>
  3108. <member name="M:NVelocity.Runtime.Parser.Node.ASTLENode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3109. <summary>Accept the visitor. *
  3110. </summary>
  3111. </member>
  3112. <member name="M:NVelocity.Runtime.Parser.Node.ASTLTNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3113. <summary>
  3114. Accept the visitor.
  3115. </summary>
  3116. </member>
  3117. <member name="T:NVelocity.Runtime.Parser.Node.ASTMap">
  3118. <summary>
  3119. AST Node for creating a map / dictionary.
  3120. This class was originally generated from Parset.jjt.
  3121. </summary>
  3122. <version>$Id: ASTMap.cs,v 1.2 2004/12/27 05:50:11 corts Exp $</version>
  3123. </member>
  3124. <member name="M:NVelocity.Runtime.Parser.Node.ASTMap.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3125. <summary>
  3126. Accept the visitor.
  3127. </summary>
  3128. </member>
  3129. <member name="M:NVelocity.Runtime.Parser.Node.ASTMap.Value(NVelocity.Context.IInternalContextAdapter)">
  3130. <summary>
  3131. Evaluate the node.
  3132. </summary>
  3133. </member>
  3134. <member name="T:NVelocity.Runtime.Parser.Node.ASTMethod">
  3135. <summary>
  3136. Method support for references : $foo.method()
  3137. NOTE :
  3138. introspection is now done at render time.
  3139. Please look at the Parser.jjt file which is
  3140. what controls the generation of this class.
  3141. </summary>
  3142. </member>
  3143. <member name="M:NVelocity.Runtime.Parser.Node.ASTMethod.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3144. <summary>
  3145. Accept the visitor.
  3146. </summary>
  3147. </member>
  3148. <member name="M:NVelocity.Runtime.Parser.Node.ASTMethod.Init(NVelocity.Context.IInternalContextAdapter,System.Object)">
  3149. <summary>
  3150. simple init - init our subtree and get what we can from
  3151. the AST
  3152. </summary>
  3153. </member>
  3154. <member name="M:NVelocity.Runtime.Parser.Node.ASTMethod.Execute(System.Object,NVelocity.Context.IInternalContextAdapter)">
  3155. <summary>
  3156. invokes the method. Returns null if a problem, the
  3157. actual return if the method returns something, or
  3158. an empty string "" if the method returns void
  3159. </summary>
  3160. </member>
  3161. <member name="M:NVelocity.Runtime.Parser.Node.ASTMethod.PerformIntrospection(NVelocity.Context.IInternalContextAdapter,System.Type,System.Object[])">
  3162. <summary>
  3163. does the introspection of the class for the method needed.
  3164. NOTE: this will try to flip the case of the first character for
  3165. convince (compatibility with Java version). If there are no arguments,
  3166. it will also try to find a property with the same name (also flipping first character).
  3167. </summary>
  3168. </member>
  3169. <member name="M:NVelocity.Runtime.Parser.Node.ASTModNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3170. <summary>
  3171. Accept the visitor.
  3172. </summary>
  3173. </member>
  3174. <member name="T:NVelocity.Runtime.Parser.Node.ASTMulNode">
  3175. <summary>
  3176. Handles integer multiplication
  3177. Please look at the Parser.jjt file which is
  3178. what controls the generation of this class.
  3179. </summary>
  3180. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  3181. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  3182. <version> $Id: ASTMulNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  3183. </member>
  3184. <member name="M:NVelocity.Runtime.Parser.Node.ASTMulNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3185. <summary>Accept the visitor. *
  3186. </summary>
  3187. </member>
  3188. <member name="M:NVelocity.Runtime.Parser.Node.ASTMulNode.Value(NVelocity.Context.IInternalContextAdapter)">
  3189. <summary>
  3190. Computes the product of the two args.
  3191. Returns null if either arg is null
  3192. or if either arg is not an integer
  3193. </summary>
  3194. </member>
  3195. <member name="M:NVelocity.Runtime.Parser.Node.ASTNENode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3196. <summary>
  3197. Accept the visitor.
  3198. </summary>
  3199. </member>
  3200. <member name="M:NVelocity.Runtime.Parser.Node.ASTNotNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3201. <summary>
  3202. Accept the visitor.
  3203. </summary>
  3204. </member>
  3205. <member name="M:NVelocity.Runtime.Parser.Node.ASTNumberLiteral.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3206. <summary>Accept the visitor. *
  3207. </summary>
  3208. </member>
  3209. <member name="M:NVelocity.Runtime.Parser.Node.ASTNumberLiteral.Init(NVelocity.Context.IInternalContextAdapter,System.Object)">
  3210. <summary> Initialization method - doesn't do much but do the object
  3211. creation. We only need to do it once.
  3212. </summary>
  3213. </member>
  3214. <member name="M:NVelocity.Runtime.Parser.Node.ASTObjectArray.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3215. <summary>
  3216. Accept the visitor.
  3217. </summary>
  3218. </member>
  3219. <member name="T:NVelocity.Runtime.Parser.Node.ASTOrNode">
  3220. <summary>
  3221. Please look at the Parser.jjt file which is what controls
  3222. the generation of this class.
  3223. </summary>
  3224. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  3225. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  3226. <version> $Id: ASTOrNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  3227. </member>
  3228. <member name="M:NVelocity.Runtime.Parser.Node.ASTOrNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3229. <summary>Accept the visitor. *
  3230. </summary>
  3231. </member>
  3232. <member name="M:NVelocity.Runtime.Parser.Node.ASTOrNode.Value(NVelocity.Context.IInternalContextAdapter)">
  3233. <summary> Returns the value of the expression.
  3234. Since the value of the expression is simply the boolean
  3235. result of evaluate(), lets return that.
  3236. </summary>
  3237. </member>
  3238. <member name="M:NVelocity.Runtime.Parser.Node.ASTOrNode.Evaluate(NVelocity.Context.IInternalContextAdapter)">
  3239. <summary>
  3240. the logical or :
  3241. the rule :
  3242. left || null -> left
  3243. null || right -> right
  3244. null || null -> false
  3245. left || right -> left || right
  3246. </summary>
  3247. </member>
  3248. <member name="M:NVelocity.Runtime.Parser.Node.ASTParameters.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3249. <summary>
  3250. Accept the visitor.
  3251. </summary>
  3252. </member>
  3253. <member name="M:NVelocity.Runtime.Parser.Node.ASTprocess.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3254. <summary>Accept the visitor. *
  3255. </summary>
  3256. </member>
  3257. <member name="T:NVelocity.Runtime.Parser.Node.ReferenceType">
  3258. <summary>
  3259. Reference types
  3260. </summary>
  3261. </member>
  3262. <member name="T:NVelocity.Runtime.Parser.Node.ASTReference">
  3263. <summary>
  3264. This class is responsible for handling the references in
  3265. VTL ($foo).
  3266. Please look at the Parser.jjt file which is
  3267. what controls the generation of this class.
  3268. </summary>
  3269. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  3270. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  3271. <author> <a href="mailto:Christoph.Reck@dlr.de">Christoph Reck</a></author>
  3272. <author> <a href="mailto:kjohnson@transparent.com">Kent Johnson</a></author>
  3273. <version> $Id: ASTReference.cs,v 1.4 2003/10/27 13:54:10 corts Exp $ </version>
  3274. </member>
  3275. <member name="M:NVelocity.Runtime.Parser.Node.ASTReference.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3276. <summary>Accept the visitor.</summary>
  3277. </member>
  3278. <member name="M:NVelocity.Runtime.Parser.Node.ASTReference.Execute(System.Object,NVelocity.Context.IInternalContextAdapter)">
  3279. <summary>
  3280. gets an Object that 'is' the value of the reference
  3281. </summary>
  3282. </member>
  3283. <member name="M:NVelocity.Runtime.Parser.Node.ASTReference.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter)">
  3284. <summary>
  3285. gets the value of the reference and outputs it to the
  3286. writer.
  3287. </summary>
  3288. <param name="context"> context of data to use in getting value </param>
  3289. <param name="writer"> writer to render to </param>
  3290. </member>
  3291. <member name="M:NVelocity.Runtime.Parser.Node.ASTReference.Evaluate(NVelocity.Context.IInternalContextAdapter)">
  3292. <summary>
  3293. Computes boolean value of this reference
  3294. Returns the actual value of reference return type
  3295. boolean, and 'true' if value is not null
  3296. </summary>
  3297. <param name="context">context to compute value with</param>
  3298. </member>
  3299. <member name="M:NVelocity.Runtime.Parser.Node.ASTReference.SetValue(NVelocity.Context.IInternalContextAdapter,System.Object)">
  3300. <summary>
  3301. Sets the value of a complex reference (something like $foo.bar)
  3302. Currently used by ASTSetReference()
  3303. </summary>
  3304. <seealso cref="T:NVelocity.Runtime.Parser.Node.ASTSetDirective"/>
  3305. <param name="context">context object containing this reference</param>
  3306. <param name="value">Object to set as value</param>
  3307. <returns>true if successful, false otherwise</returns>
  3308. </member>
  3309. <member name="P:NVelocity.Runtime.Parser.Node.ASTReference.RootString">
  3310. <summary>
  3311. Returns the 'root string', the reference key
  3312. </summary>
  3313. </member>
  3314. <member name="T:NVelocity.Runtime.Parser.Node.ASTSetDirective">
  3315. <summary>
  3316. Node for the #set directive
  3317. </summary>
  3318. </member>
  3319. <member name="M:NVelocity.Runtime.Parser.Node.ASTSetDirective.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3320. <summary>Accept the visitor. *
  3321. </summary>
  3322. </member>
  3323. <member name="M:NVelocity.Runtime.Parser.Node.ASTSetDirective.Init(NVelocity.Context.IInternalContextAdapter,System.Object)">
  3324. <summary> simple init. We can get the RHS and LHS as the the tree structure is static
  3325. </summary>
  3326. </member>
  3327. <member name="M:NVelocity.Runtime.Parser.Node.ASTSetDirective.Render(NVelocity.Context.IInternalContextAdapter,System.IO.TextWriter)">
  3328. <summary> puts the value of the RHS into the context under the key of the LHS
  3329. </summary>
  3330. </member>
  3331. <member name="T:NVelocity.Runtime.Parser.Node.ASTStringLiteral">
  3332. <summary>
  3333. ASTStringLiteral support.
  3334. </summary>
  3335. </member>
  3336. <member name="M:NVelocity.Runtime.Parser.Node.ASTStringLiteral.#ctor(System.Int32)">
  3337. <summary>
  3338. Initializes a new instance of the <see cref="T:NVelocity.Runtime.Parser.Node.ASTStringLiteral"/> class.
  3339. </summary>
  3340. <param name="id">The id.</param>
  3341. </member>
  3342. <member name="M:NVelocity.Runtime.Parser.Node.ASTStringLiteral.#ctor(NVelocity.Runtime.Parser.Parser,System.Int32)">
  3343. <summary>
  3344. Initializes a new instance of the <see cref="T:NVelocity.Runtime.Parser.Node.ASTStringLiteral"/> class.
  3345. </summary>
  3346. <param name="p">The p.</param>
  3347. <param name="id">The id.</param>
  3348. </member>
  3349. <member name="M:NVelocity.Runtime.Parser.Node.ASTStringLiteral.Init(NVelocity.Context.IInternalContextAdapter,System.Object)">
  3350. <summary> init : we don't have to do much. Init the tree (there
  3351. shouldn't be one) and then see if interpolation is turned on.
  3352. </summary>
  3353. </member>
  3354. <member name="M:NVelocity.Runtime.Parser.Node.ASTStringLiteral.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3355. <summary>Accept the visitor. *
  3356. </summary>
  3357. </member>
  3358. <member name="M:NVelocity.Runtime.Parser.Node.ASTStringLiteral.Value(NVelocity.Context.IInternalContextAdapter)">
  3359. <summary> renders the value of the string literal
  3360. If the properties allow, and the string literal contains a $ or a #
  3361. the literal is rendered against the context
  3362. Otherwise, the stringlit is returned.
  3363. </summary>
  3364. </member>
  3365. <member name="M:NVelocity.Runtime.Parser.Node.ASTStringLiteral.InterpolateDictionaryString(System.String,NVelocity.Context.IInternalContextAdapter)">
  3366. <summary>
  3367. Interpolates the dictionary string.
  3368. dictionary string is any string in the format
  3369. "%{ key='value' [,key2='value2' }"
  3370. "%{ key='value' [,key2='value2'] }"
  3371. </summary>
  3372. <param name="str">If valid input a HybridDictionary with zero or more items,
  3373. otherwise the input string</param>
  3374. <param name="context">NVelocity runtime context</param>
  3375. </member>
  3376. <member name="T:NVelocity.Runtime.Parser.Node.ASTSubtractNode">
  3377. <summary>
  3378. Handles integer subtraction of nodes (in #set() )
  3379. Please look at the Parser.jjt file which is
  3380. what controls the generation of this class.
  3381. </summary>
  3382. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  3383. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  3384. <version> $Id: ASTSubtractNode.cs,v 1.3 2003/10/27 13:54:10 corts Exp $ </version>
  3385. </member>
  3386. <member name="M:NVelocity.Runtime.Parser.Node.ASTSubtractNode.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3387. <summary>
  3388. Accept the visitor.
  3389. </summary>
  3390. </member>
  3391. <member name="M:NVelocity.Runtime.Parser.Node.ASTSubtractNode.Value(NVelocity.Context.IInternalContextAdapter)">
  3392. <summary>
  3393. Computes the value of the subtraction.
  3394. Currently limited to integers.
  3395. </summary>
  3396. <returns>Integer(value) or null</returns>
  3397. </member>
  3398. <member name="M:NVelocity.Runtime.Parser.Node.ASTText.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3399. <summary>
  3400. Accept the visitor.
  3401. </summary>
  3402. </member>
  3403. <member name="M:NVelocity.Runtime.Parser.Node.ASTTrue.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3404. <summary>
  3405. Accept the visitor.
  3406. </summary>
  3407. </member>
  3408. <member name="M:NVelocity.Runtime.Parser.Node.ASTVariable.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3409. <summary>
  3410. Accept the visitor.
  3411. </summary>
  3412. </member>
  3413. <member name="M:NVelocity.Runtime.Parser.Node.ASTWord.Accept(NVelocity.Runtime.Parser.Node.IParserVisitor,System.Object)">
  3414. <summary>
  3415. Accept the visitor.
  3416. </summary>
  3417. </member>
  3418. <member name="T:NVelocity.Runtime.Parser.Node.BooleanPropertyExecutor">
  3419. <summary> Handles discovery and valuation of a
  3420. boolean object property, of the
  3421. form public boolean is&lt;property&gt; when executed.
  3422. We do this separately as to preserve the current
  3423. quasi-broken semantics of get&lt;as is property&gt;
  3424. get&lt; flip 1st char&gt; get("property") and now followed
  3425. by is&lt;Property&gt;
  3426. </summary>
  3427. </member>
  3428. <member name="T:NVelocity.Runtime.Parser.Node.PropertyExecutor">
  3429. <summary>
  3430. Returned the value of object property when executed.
  3431. </summary>
  3432. </member>
  3433. <member name="M:NVelocity.Runtime.Parser.Node.PropertyExecutor.Execute(System.Object)">
  3434. <summary>
  3435. Execute property against context.
  3436. </summary>
  3437. </member>
  3438. <member name="T:NVelocity.Runtime.Parser.Node.GetExecutor">
  3439. <summary>
  3440. Executor that simply tries to execute a get(key)
  3441. operation. This will try to find a get(key) method
  3442. for any type of object, not just objects that
  3443. implement the Map interface as was previously
  3444. the case.
  3445. </summary>
  3446. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  3447. <remarks>
  3448. Add discovery for .NET default property, using
  3449. <see cref="M:System.Type.GetDefaultMembers"/>.
  3450. </remarks>
  3451. </member>
  3452. <member name="F:NVelocity.Runtime.Parser.Node.GetExecutor.arguments">
  3453. <summary>
  3454. Container to hold the 'key' part of get(key).
  3455. </summary>
  3456. </member>
  3457. <member name="M:NVelocity.Runtime.Parser.Node.GetExecutor.#ctor(NVelocity.Runtime.IRuntimeLogger,NVelocity.Util.Introspection.Introspector,System.Type,System.String)">
  3458. <summary>
  3459. Default constructor.
  3460. </summary>
  3461. </member>
  3462. <member name="M:NVelocity.Runtime.Parser.Node.GetExecutor.Execute(System.Object)">
  3463. <summary>
  3464. Execute method against context.
  3465. </summary>
  3466. </member>
  3467. <member name="T:NVelocity.Runtime.Parser.Node.NodeUtils">
  3468. <summary> Utilities for dealing with the AST node structure.
  3469. *
  3470. </summary>
  3471. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  3472. </author>
  3473. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  3474. </author>
  3475. <version> $Id: NodeUtils.cs,v 1.4 2003/10/27 13:54:10 corts Exp $
  3476. </version>
  3477. </member>
  3478. <member name="M:NVelocity.Runtime.Parser.Node.NodeUtils.specialText(NVelocity.Runtime.Parser.Token)">
  3479. <summary> Collect all the &lt;SPECIAL_TOKEN&gt;s that
  3480. are carried along with a token. Special
  3481. tokens do not participate in parsing but
  3482. can still trigger certain lexical actions.
  3483. In some cases you may want to retrieve these
  3484. special tokens, this is simply a way to
  3485. extract them.
  3486. </summary>
  3487. </member>
  3488. <member name="M:NVelocity.Runtime.Parser.Node.NodeUtils.tokenLiteral(NVelocity.Runtime.Parser.Token)">
  3489. <summary> complete node literal
  3490. *
  3491. </summary>
  3492. </member>
  3493. <member name="M:NVelocity.Runtime.Parser.Node.NodeUtils.interpolate(System.String,NVelocity.Context.IContext)">
  3494. <summary> Utility method to interpolate context variables
  3495. into string literals. So that the following will
  3496. work:
  3497. *
  3498. #set $name = "candy"
  3499. $image.getURI("${name}.jpg")
  3500. *
  3501. And the string literal argument will
  3502. be transformed into "candy.jpg" before
  3503. the method is executed.
  3504. </summary>
  3505. </member>
  3506. <member name="T:NVelocity.Runtime.Parser.Node.ObjectComparer">
  3507. <summary>
  3508. ObjectComparer allows you to compare primitive types and some others
  3509. using IComparable interface whenever possible, and performing type
  3510. conversions to get the best possible result.
  3511. </summary>
  3512. </member>
  3513. <member name="M:NVelocity.Runtime.Parser.Node.ObjectComparer.CompareObjects(System.Object,System.Object)">
  3514. <summary>
  3515. Tries to compare two random objects. -1 is returned
  3516. if x is smaller than y, 1 the other way around, or 0
  3517. if they are equal.
  3518. </summary>
  3519. </member>
  3520. <member name="T:NVelocity.Runtime.Parser.ICharStream">
  3521. <summary>
  3522. This interface describes a character stream that maintains line and
  3523. column number positions of the characters. It also has the capability
  3524. to backup the stream to some extent. An implementation of this
  3525. interface is used in the TokenManager implementation generated by
  3526. JavaCCParser.
  3527. All the methods except backup can be implemented in any fashion. backup
  3528. needs to be implemented correctly for the correct operation of the lexer.
  3529. Rest of the methods are all used to get information like line number,
  3530. column number and the String that constitutes a token and are not used
  3531. by the lexer. Hence their implementation won't affect the generated lexer's
  3532. operation.
  3533. </summary>
  3534. </member>
  3535. <member name="M:NVelocity.Runtime.Parser.ICharStream.ReadChar">
  3536. <summary> Returns the next character from the selected input. The method
  3537. of selecting the input is the responsibility of the class
  3538. implementing this interface. Can throw any java.io.IOException.
  3539. </summary>
  3540. </member>
  3541. <member name="M:NVelocity.Runtime.Parser.ICharStream.Backup(System.Int32)">
  3542. <summary> Backs up the input stream by amount steps. Lexer calls this method if it
  3543. had already read some characters, but could not use them to match a
  3544. (longer) token. So, they will be used again as the prefix of the next
  3545. token and it is the implemetation's responsibility to do this right.
  3546. </summary>
  3547. </member>
  3548. <member name="M:NVelocity.Runtime.Parser.ICharStream.BeginToken">
  3549. <summary> Returns the next character that marks the beginning of the next token.
  3550. All characters must remain in the buffer between two successive calls
  3551. to this method to implement backup correctly.
  3552. </summary>
  3553. </member>
  3554. <member name="M:NVelocity.Runtime.Parser.ICharStream.GetImage">
  3555. <summary> Returns a string made up of characters from the marked token beginning
  3556. to the current buffer position. Implementations have the choice of returning
  3557. anything that they want to. For example, for efficiency, one might decide
  3558. to just return null, which is a valid implementation.
  3559. </summary>
  3560. </member>
  3561. <member name="M:NVelocity.Runtime.Parser.ICharStream.GetSuffix(System.Int32)">
  3562. <summary>
  3563. Returns an array of characters that make up the suffix of length 'len' for
  3564. the currently matched token. This is used to build up the matched string
  3565. for use in actions in the case of MORE. A simple and inefficient
  3566. implementation of this is as follows :
  3567. {
  3568. String t = GetImage();
  3569. return t.substring(t.length() - len, t.length()).toCharArray();
  3570. }
  3571. </summary>
  3572. </member>
  3573. <member name="M:NVelocity.Runtime.Parser.ICharStream.Done">
  3574. <summary> The lexer calls this function to indicate that it is done with the stream
  3575. and hence implementations can free any resources held by this class.
  3576. Again, the body of this function can be just empty and it will not
  3577. affect the lexer's operation.
  3578. </summary>
  3579. </member>
  3580. <member name="P:NVelocity.Runtime.Parser.ICharStream.CurrentCharacter">
  3581. <summary>
  3582. The currenct character.
  3583. </summary>
  3584. </member>
  3585. <member name="P:NVelocity.Runtime.Parser.ICharStream.Column">
  3586. <summary>
  3587. Gets the column.
  3588. </summary>
  3589. <value>The column.</value>
  3590. </member>
  3591. <member name="P:NVelocity.Runtime.Parser.ICharStream.Line">
  3592. <summary>
  3593. Gets the line.
  3594. </summary>
  3595. <value>The line.</value>
  3596. </member>
  3597. <member name="P:NVelocity.Runtime.Parser.ICharStream.EndColumn">
  3598. <summary>
  3599. Gets the end column.
  3600. </summary>
  3601. <value>The end column.</value>
  3602. </member>
  3603. <member name="P:NVelocity.Runtime.Parser.ICharStream.EndLine">
  3604. <summary>
  3605. Gets the end line.
  3606. </summary>
  3607. <value>The end line.</value>
  3608. </member>
  3609. <member name="P:NVelocity.Runtime.Parser.ICharStream.BeginColumn">
  3610. <summary>
  3611. Gets the begin column.
  3612. </summary>
  3613. <value>The begin column.</value>
  3614. </member>
  3615. <member name="P:NVelocity.Runtime.Parser.ICharStream.BeginLine">
  3616. <summary>
  3617. Gets the begin line.
  3618. </summary>
  3619. <value>The begin line.</value>
  3620. </member>
  3621. <member name="T:NVelocity.Runtime.Parser.ParseException">
  3622. <summary> This exception is thrown when parse errors are encountered.
  3623. You can explicitly create objects of this exception type by
  3624. calling the method generateParseException in the generated
  3625. parser.
  3626. *
  3627. You can modify this class to customize your error reporting
  3628. mechanisms so long as you retain the public fields.
  3629. </summary>
  3630. </member>
  3631. <member name="F:NVelocity.Runtime.Parser.ParseException.eol">
  3632. <summary> The end of line string for this machine.
  3633. </summary>
  3634. </member>
  3635. <member name="M:NVelocity.Runtime.Parser.ParseException.#ctor(NVelocity.Runtime.Parser.Token,System.Int32[][],System.String[])">
  3636. <summary> This constructor is used by the method "generateParseException"
  3637. in the generated parser. Calling this constructor generates
  3638. a new object of this type with the fields "currentToken",
  3639. "expectedTokenSequences", and "tokenImage" set. The boolean
  3640. flag "specialConstructor" is also set to true to indicate that
  3641. this constructor was used to create this object.
  3642. This constructor calls its super class with the empty string
  3643. to force the "toString" method of parent class "Throwable" to
  3644. print the error message in the form:
  3645. ParseException: &lt;result of getMessage&gt;
  3646. </summary>
  3647. </member>
  3648. <member name="M:NVelocity.Runtime.Parser.ParseException.#ctor">
  3649. <summary> The following constructors are for use by you for whatever
  3650. purpose you can think of. Constructing the exception in this
  3651. manner makes the exception behave in the normal way - i.e., as
  3652. documented in the class "Throwable". The fields "errorToken",
  3653. "expectedTokenSequences", and "tokenImage" do not contain
  3654. relevant information. The JavaCC generated code does not use
  3655. these constructors.
  3656. </summary>
  3657. </member>
  3658. <member name="F:NVelocity.Runtime.Parser.ParseException.specialConstructor">
  3659. <summary> This variable determines which constructor was used to create
  3660. this object and thereby affects the semantics of the
  3661. "getMessage" method (see below).
  3662. </summary>
  3663. </member>
  3664. <member name="F:NVelocity.Runtime.Parser.ParseException.currentToken">
  3665. <summary> This is the last token that has been consumed successfully. If
  3666. this object has been created due to a parse error, the token
  3667. following this token will (therefore) be the first error token.
  3668. </summary>
  3669. </member>
  3670. <member name="F:NVelocity.Runtime.Parser.ParseException.expectedTokenSequences">
  3671. <summary> Each entry in this array is an array of integers. Each array
  3672. of integers represents a sequence of tokens (by their ordinal
  3673. values) that is expected at this point of the parse.
  3674. </summary>
  3675. </member>
  3676. <member name="F:NVelocity.Runtime.Parser.ParseException.tokenImage">
  3677. <summary> This is a reference to the "tokenImage" array of the generated
  3678. parser within which the parse error occurred. This array is
  3679. defined in the generated ...Constants interface.
  3680. </summary>
  3681. </member>
  3682. <member name="M:NVelocity.Runtime.Parser.ParseException.AddEscapes(System.String)">
  3683. <summary> This method has the standard behavior when this object has been
  3684. created using the standard constructors. Otherwise, it uses
  3685. "currentToken" and "expectedTokenSequences" to generate a parse
  3686. error message and returns it. If this object has been created
  3687. due to a parse error, and you do not catch it (it gets thrown
  3688. from the parser), then this method is called during the printing
  3689. of the final stack trace, and hence the correct error message
  3690. gets displayed.
  3691. </summary>
  3692. <summary> Used to convert raw characters to their escaped version
  3693. when these raw version cannot be used as part of an ASCII
  3694. string literal.
  3695. </summary>
  3696. </member>
  3697. <member name="T:NVelocity.Runtime.Parser.Parser">
  3698. <summary> This class is responsible for parsing a Velocity
  3699. template. This class was generated by JavaCC using
  3700. the JJTree extension to produce an Abstract
  3701. Syntax Tree (AST) of the template.
  3702. Please look at the Parser.jjt file which is
  3703. what controls the generation of this class.
  3704. </summary>
  3705. </member>
  3706. <member name="F:NVelocity.Runtime.Parser.Parser.directives">
  3707. <summary> This Hashtable contains a list of all of the dynamic directives.
  3708. </summary>
  3709. </member>
  3710. <member name="F:NVelocity.Runtime.Parser.Parser.currentTemplateName">
  3711. <summary> Name of current template we are parsing. Passed to us in parse()
  3712. </summary>
  3713. </member>
  3714. <member name="M:NVelocity.Runtime.Parser.Parser.#ctor(NVelocity.Runtime.IRuntimeServices)">
  3715. <summary>
  3716. This constructor was added to allow the re-use of parsers.
  3717. The normal constructor takes a single argument which
  3718. an InputStream. This simply creates a re-usable parser
  3719. object, we satisfy the requirement of an InputStream
  3720. by using a newline character as an input stream.
  3721. </summary>
  3722. </member>
  3723. <member name="M:NVelocity.Runtime.Parser.Parser.Parse(System.IO.TextReader,System.String)">
  3724. <summary> This was also added to allow parsers to be
  3725. re-usable. Normal JavaCC use entails passing an
  3726. input stream to the constructor and the parsing
  3727. process is carried out once. We want to be able
  3728. to re-use parsers: we do this by adding this
  3729. method and re-initializing the lexer with
  3730. the new stream that we want parsed.
  3731. </summary>
  3732. </member>
  3733. <member name="M:NVelocity.Runtime.Parser.Parser.IsDirective(System.String)">
  3734. <summary> This method finds out of the directive exists in the directives
  3735. Hashtable.
  3736. </summary>
  3737. </member>
  3738. <member name="M:NVelocity.Runtime.Parser.Parser.EscapedDirective(System.String)">
  3739. <summary> Produces a processed output for an escaped control or
  3740. pluggable directive
  3741. </summary>
  3742. </member>
  3743. <member name="M:NVelocity.Runtime.Parser.Parser.Process">
  3744. <summary> This method is what starts the whole parsing
  3745. process. After the parsing is complete and
  3746. the template has been turned into an AST,
  3747. this method returns the root of AST which
  3748. can subsequently be traversed by a visitor
  3749. which implements the ParserVisitor interface
  3750. which is generated automatically by JavaCC
  3751. </summary>
  3752. </member>
  3753. <member name="M:NVelocity.Runtime.Parser.Parser.Statement">
  3754. <summary> These are the types of statements that
  3755. are acceptable in Velocity templates.
  3756. </summary>
  3757. </member>
  3758. <member name="M:NVelocity.Runtime.Parser.Parser.EscapedDirective">
  3759. <summary> used to separate the notion of a valid directive that has been
  3760. escaped, versus something that looks like a directive and
  3761. is just schmoo. This is important to do as a separate production
  3762. that creates a node, because we want this, in either case, to stop
  3763. the further parsing of the Directive() tree.
  3764. </summary>
  3765. </member>
  3766. <member name="M:NVelocity.Runtime.Parser.Parser.Escape">
  3767. <summary> Used to catch and process escape sequences in grammatical constructs
  3768. as escapes outside of VTL are just characters. Right now we have both
  3769. this and the EscapeDirective() construction because in the EscapeDirective()
  3770. case, we want to suck in the #&lt;directive&gt; and here we don't. We just want
  3771. the escapes to render correctly
  3772. </summary>
  3773. </member>
  3774. <member name="M:NVelocity.Runtime.Parser.Parser.Identifier">
  3775. <summary> This method corresponds to variable
  3776. references in Velocity templates.
  3777. The following are examples of variable
  3778. references that may be found in a
  3779. template:
  3780. *
  3781. $foo
  3782. $bar
  3783. *
  3784. </summary>
  3785. </member>
  3786. <member name="M:NVelocity.Runtime.Parser.Parser.DirectiveArg">
  3787. <summary> Supports the arguments for the Pluggable Directives
  3788. We add whitespace in here as a token so the VMs can
  3789. easily reconstruct a macro body from the token stream
  3790. See Directive()
  3791. </summary>
  3792. </member>
  3793. <member name="M:NVelocity.Runtime.Parser.Parser.Directive">
  3794. <summary> Supports the Pluggable Directives
  3795. #foo( arg+ )
  3796. </summary>
  3797. </member>
  3798. <member name="M:NVelocity.Runtime.Parser.Parser.IntegerRange">
  3799. <summary> supports the [n..m] vector generator for use in
  3800. the #foreach() to generate measured ranges w/o
  3801. needing explicit support from the app/servlet
  3802. </summary>
  3803. </member>
  3804. <member name="M:NVelocity.Runtime.Parser.Parser.Parameter">
  3805. <summary> This method has yet to be fully implemented
  3806. but will allow arbitrarily nested method
  3807. calls
  3808. </summary>
  3809. </member>
  3810. <member name="M:NVelocity.Runtime.Parser.Parser.Method">
  3811. <summary> This method has yet to be fully implemented
  3812. but will allow arbitrarily nested method
  3813. calls
  3814. </summary>
  3815. </member>
  3816. <member name="M:NVelocity.Runtime.Parser.Parser.Text">
  3817. <summary> This method is responsible for allowing
  3818. all non-grammar text to pass through
  3819. unscathed.
  3820. </summary>
  3821. </member>
  3822. <member name="M:NVelocity.Runtime.Parser.Parser.SetDirective">
  3823. <summary> Currently support both types of set :
  3824. #set( expr )
  3825. #set expr
  3826. </summary>
  3827. </member>
  3828. <member name="M:NVelocity.Runtime.Parser.Parser.StopStatement">
  3829. <summary> This method corresponds to the #stop
  3830. directive which just simulates and EOF
  3831. so that parsing stops. The #stop directive
  3832. is useful for end-user debugging
  3833. purposes.
  3834. </summary>
  3835. </member>
  3836. <member name="M:NVelocity.Runtime.Parser.ParserState.NodeCreated">
  3837. <summary>
  3838. Determines whether the current node was actually closed and
  3839. pushed. This should only be called in the final user action of a
  3840. node scope.
  3841. </summary>
  3842. <returns></returns>
  3843. </member>
  3844. <member name="M:NVelocity.Runtime.Parser.ParserState.Reset">
  3845. <summary>
  3846. Call this to reinitialize the node stack. It is called automatically by the parser's ReInit() method.
  3847. </summary>
  3848. </member>
  3849. <member name="M:NVelocity.Runtime.Parser.ParserState.PushNode(NVelocity.Runtime.Parser.Node.INode)">
  3850. <summary>
  3851. Pushes a node on to the stack.
  3852. </summary>
  3853. </member>
  3854. <member name="M:NVelocity.Runtime.Parser.ParserState.PopNode">
  3855. <summary>
  3856. Returns the node on the top of the stack, and remove it from the stack.
  3857. </summary>
  3858. </member>
  3859. <member name="M:NVelocity.Runtime.Parser.ParserState.PeekNode">
  3860. <summary>
  3861. Returns the node currently on the top of the stack.
  3862. </summary>
  3863. </member>
  3864. <member name="M:NVelocity.Runtime.Parser.ParserState.NodeArity">
  3865. <summary>
  3866. Returns the number of children on the stack in the current node scope.
  3867. </summary>
  3868. </member>
  3869. <member name="M:NVelocity.Runtime.Parser.ParserState.CloseNodeScope(NVelocity.Runtime.Parser.Node.INode,System.Int32)">
  3870. <summary>
  3871. A definite node is constructed from a specified number of
  3872. children. That number of nodes are popped from the stack and
  3873. made the children of the definite node. Then the definite node
  3874. is pushed on to the stack.
  3875. </summary>
  3876. </member>
  3877. <member name="M:NVelocity.Runtime.Parser.ParserState.CloseNodeScope(NVelocity.Runtime.Parser.Node.INode,System.Boolean)">
  3878. <summary>
  3879. A conditional node is constructed if its condition is true. All
  3880. the nodes that have been pushed since the node was opened are
  3881. made children of the the conditional node, which is then pushed
  3882. on to the stack. If the condition is false the node is not
  3883. constructed and they are left on the stack.
  3884. </summary>
  3885. </member>
  3886. <member name="P:NVelocity.Runtime.Parser.ParserState.RootNode">
  3887. <summary>
  3888. Returns the root node of the AST. It only makes sense to call this after a successful parse.
  3889. </summary>
  3890. </member>
  3891. <member name="M:NVelocity.Runtime.Parser.ParserTokenManager.StateStackPop">
  3892. pushes the current state onto the 'state stack',
  3893. and maintains the parens counts
  3894. public because we need it in PD &amp; VM handling
  3895. @return bool : success. It can fail if the state machine
  3896. gets messed up (do don't mess it up :)
  3897. </member>
  3898. <member name="M:NVelocity.Runtime.Parser.ParserTokenManager.StateStackPush">
  3899. pops a state off the stack, and restores paren counts
  3900. @return bool : success of operation
  3901. </member>
  3902. <member name="M:NVelocity.Runtime.Parser.ParserTokenManager.ClearStateVars">
  3903. Clears all state variables, resets to
  3904. start values, clears stateStack. Call
  3905. before parsing.
  3906. @return void
  3907. </member>
  3908. <member name="M:NVelocity.Runtime.Parser.ParserTokenManager.RPARENHandler">
  3909. handles the dropdown logic when encountering a RPAREN
  3910. </member>
  3911. <member name="M:NVelocity.Runtime.Parser.ParserTreeConstants.#ctor">
  3912. <summary>
  3913. private constructor as class is meant to hold constants only.
  3914. Class was originally an interface in Java, but as C# does not support Fields in an interface and
  3915. the jjtNodeName field, I converted it to a class with no constructor.
  3916. </summary>
  3917. </member>
  3918. <member name="T:NVelocity.Runtime.Parser.Token">
  3919. <summary>
  3920. Describes the input token stream.
  3921. </summary>
  3922. </member>
  3923. <member name="F:NVelocity.Runtime.Parser.Token.Kind">
  3924. <summary>
  3925. An integer that describes the kind of this token. This numbering
  3926. system is determined by JavaCCParser, and a table of these numbers is
  3927. stored in the file ...Constants.java.
  3928. </summary>
  3929. </member>
  3930. <member name="F:NVelocity.Runtime.Parser.Token.BeginLine">
  3931. <summary>
  3932. beginLine and beginColumn describe the position of the first character
  3933. of this token; endLine and endColumn describe the position of the
  3934. last character of this token.
  3935. </summary>
  3936. </member>
  3937. <member name="F:NVelocity.Runtime.Parser.Token.BeginColumn">
  3938. <summary>
  3939. beginLine and beginColumn describe the position of the first character
  3940. of this token; endLine and endColumn describe the position of the
  3941. last character of this token.
  3942. </summary>
  3943. </member>
  3944. <member name="F:NVelocity.Runtime.Parser.Token.EndLine">
  3945. <summary>
  3946. beginLine and beginColumn describe the position of the first character
  3947. of this token; endLine and endColumn describe the position of the
  3948. last character of this token.
  3949. </summary>
  3950. </member>
  3951. <member name="F:NVelocity.Runtime.Parser.Token.EndColumn">
  3952. <summary>
  3953. beginLine and beginColumn describe the position of the first character
  3954. of this token; endLine and endColumn describe the position of the
  3955. last character of this token.
  3956. </summary>
  3957. </member>
  3958. <member name="F:NVelocity.Runtime.Parser.Token.Image">
  3959. <summary> The string image of the token. </summary>
  3960. </member>
  3961. <member name="F:NVelocity.Runtime.Parser.Token.Next">
  3962. <summary>
  3963. A reference to the next regular (non-special) token from the input
  3964. stream. If this is the last token from the input stream, or if the
  3965. token manager has not read tokens beyond this one, this field is
  3966. set to null. This is true only if this token is also a regular
  3967. token. Otherwise, see below for a description of the contents of
  3968. this field.
  3969. </summary>
  3970. </member>
  3971. <member name="F:NVelocity.Runtime.Parser.Token.SpecialToken">
  3972. <summary>
  3973. This field is used to access special tokens that occur prior to this
  3974. token, but after the immediately preceding regular (non-special) token.
  3975. If there are no such special tokens, this field is set to null.
  3976. When there are more than one such special token, this field refers
  3977. to the last of these special tokens, which in turn refers to the next
  3978. previous special token through its specialToken field, and so on
  3979. until the first special token (whose specialToken field is null).
  3980. The next fields of special tokens refer to other special tokens that
  3981. immediately follow it (without an intervening regular token). If there
  3982. is no such token, this field is null.
  3983. </summary>
  3984. </member>
  3985. <member name="M:NVelocity.Runtime.Parser.Token.ToString">
  3986. <summary>
  3987. Returns the image.
  3988. </summary>
  3989. </member>
  3990. <member name="M:NVelocity.Runtime.Parser.Token.NewToken(System.Int32)">
  3991. <summary>
  3992. Returns a new Token object, by default. However, if you want, you
  3993. can create and return subclass objects based on the value of ofKind.
  3994. Simply add the cases to the switch for all those special cases.
  3995. For example, if you have a subclass of Token called IDToken that
  3996. you want to create if ofKind is ID, simply add something like :
  3997. <c>case MyParserConstants.ID : return new IDToken();</c>
  3998. to the following switch statement. Then you can cast matchedToken
  3999. variable to the appropriate type and use it in your lexical actions.
  4000. </summary>
  4001. </member>
  4002. <member name="F:NVelocity.Runtime.Parser.TokenMgrError.LEXICAL_ERROR">
  4003. <summary> Lexical error occurred.
  4004. </summary>
  4005. </member>
  4006. <member name="F:NVelocity.Runtime.Parser.TokenMgrError.STATIC_LEXER_ERROR">
  4007. <summary> An attempt was made to create a second instance of a static token manager.
  4008. </summary>
  4009. </member>
  4010. <member name="F:NVelocity.Runtime.Parser.TokenMgrError.INVALID_LEXICAL_STATE">
  4011. <summary> Tried to change to an invalid lexical state.
  4012. </summary>
  4013. </member>
  4014. <member name="F:NVelocity.Runtime.Parser.TokenMgrError.LOOP_DETECTED">
  4015. <summary> Detected (and bailed out of) an infinite loop in the token manager.
  4016. </summary>
  4017. </member>
  4018. <member name="F:NVelocity.Runtime.Parser.TokenMgrError.errorCode">
  4019. <summary> Indicates the reason why the exception is thrown. It will have
  4020. one of the above 4 values.
  4021. </summary>
  4022. </member>
  4023. <member name="M:NVelocity.Runtime.Parser.TokenMgrError.AddEscapes(System.String)">
  4024. <summary> Replaces unprintable characters by their escaped (or unicode escaped)
  4025. equivalents in the given string
  4026. </summary>
  4027. </member>
  4028. <member name="M:NVelocity.Runtime.Parser.TokenMgrError.LexicalError(System.Boolean,System.Int32,System.Int32,System.String,System.Char)">
  4029. <summary> Returns a detailed message for the Error when it is thrown by the
  4030. token manager to indicate a lexical error.
  4031. Parameters :
  4032. EOFSeen : indicates if EOF caused the lexical error
  4033. curLexState : lexical state in which this error occurred
  4034. errorLine : line number when the error occurred
  4035. errorColumn : column number when the error occurred
  4036. errorAfter : prefix that was seen before this error occurred
  4037. currentCharacter : the offending character
  4038. Note: You can customize the lexical error message by modifying this method.
  4039. </summary>
  4040. </member>
  4041. <member name="M:NVelocity.Runtime.Parser.TokenMgrError.#ctor">
  4042. <summary> You can also modify the body of this method to customize your error messages.
  4043. For example, cases like LOOP_DETECTED and INVALID_LEXICAL_STATE are not
  4044. of end-users concern, so you can return something like :
  4045. *
  4046. "Internal Error : Please file a bug report .... "
  4047. *
  4048. from this method for such cases in the release version of your parser.
  4049. </summary>
  4050. </member>
  4051. <member name="T:NVelocity.Runtime.Parser.VelocityCharStream">
  4052. <summary> NOTE : This class was originally an ASCII_CharStream autogenerated
  4053. by Javacc. It was then modified via changing class name with appropriate
  4054. fixes for CTORS, and mods to readChar().
  4055. This is safe because we *always* use Reader with this class, and never a
  4056. InputStream. This guarantees that we have a correct stream of 16-bit
  4057. chars - all encoding transformations have been done elsewhere, so we
  4058. believe that there is no risk in doing this. Time will tell :)
  4059. </summary>
  4060. <summary> An implementation of interface CharStream, where the stream is assumed to
  4061. contain only ASCII characters (without unicode processing).
  4062. </summary>
  4063. </member>
  4064. <member name="M:NVelocity.Runtime.Parser.VelocityCharStream.AdjustBeginLineColumn(System.Int32,System.Int32)">
  4065. <summary> Method to adjust line and column numbers for the start of a token.<br/>
  4066. </summary>
  4067. </member>
  4068. <member name="T:NVelocity.Runtime.Resource.Loader.ResourceLoader">
  4069. <summary>
  4070. This is abstract class the all text resource loaders should extend.
  4071. </summary>
  4072. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  4073. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  4074. <version> $Id: ResourceLoader.cs,v 1.3 2003/10/27 13:54:11 corts Exp $</version>
  4075. </member>
  4076. <member name="F:NVelocity.Runtime.Resource.Loader.ResourceLoader.isCachingOn">
  4077. <summary>
  4078. Does this loader want templates produced with it
  4079. cached in the Runtime.
  4080. </summary>
  4081. </member>
  4082. <member name="F:NVelocity.Runtime.Resource.Loader.ResourceLoader.modificationCheckInterval">
  4083. <summary>
  4084. This property will be passed on to the templates
  4085. that are created with this loader.
  4086. </summary>
  4087. </member>
  4088. <member name="F:NVelocity.Runtime.Resource.Loader.ResourceLoader.className">
  4089. <summary>
  4090. Class name for this loader, for logging/debugging
  4091. purposes.
  4092. </summary>
  4093. </member>
  4094. <member name="M:NVelocity.Runtime.Resource.Loader.ResourceLoader.CommonInit(NVelocity.Runtime.IRuntimeServices,Commons.Collections.ExtendedProperties)">
  4095. <summary>
  4096. This initialization is used by all resource
  4097. loaders and must be called to set up common
  4098. properties shared by all resource loaders
  4099. </summary>
  4100. </member>
  4101. <member name="M:NVelocity.Runtime.Resource.Loader.ResourceLoader.Init(Commons.Collections.ExtendedProperties)">
  4102. <summary>
  4103. Initialize the template loader with a
  4104. a resources class.
  4105. </summary>
  4106. </member>
  4107. <member name="M:NVelocity.Runtime.Resource.Loader.ResourceLoader.GetResourceStream(System.String)">
  4108. <summary>
  4109. Get the InputStream that the Runtime will parse
  4110. to create a template.
  4111. </summary>
  4112. </member>
  4113. <member name="M:NVelocity.Runtime.Resource.Loader.ResourceLoader.IsSourceModified(NVelocity.Runtime.Resource.Resource)">
  4114. <summary>
  4115. Given a template, check to see if the source of InputStream
  4116. has been modified.
  4117. </summary>
  4118. </member>
  4119. <member name="M:NVelocity.Runtime.Resource.Loader.ResourceLoader.GetLastModified(NVelocity.Runtime.Resource.Resource)">
  4120. <summary>
  4121. Get the last modified time of the InputStream source
  4122. that was used to create the template. We need the template
  4123. here because we have to extract the name of the template
  4124. in order to locate the InputStream source.
  4125. </summary>
  4126. </member>
  4127. <member name="P:NVelocity.Runtime.Resource.Loader.ResourceLoader.ClassName">
  4128. <summary>
  4129. Return the class name of this resource Loader
  4130. </summary>
  4131. </member>
  4132. <member name="P:NVelocity.Runtime.Resource.Loader.ResourceLoader.CachingOn">
  4133. <summary>
  4134. Set the caching state. If true, then this loader
  4135. would like the Runtime to cache templates that
  4136. have been created with InputStreams provided
  4137. by this loader.
  4138. </summary>
  4139. </member>
  4140. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyRelativeResourceLoader.Init(Commons.Collections.ExtendedProperties)">
  4141. <summary>
  4142. Initialize the template loader with a
  4143. a resources class.
  4144. </summary>
  4145. </member>
  4146. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyRelativeResourceLoader.GetResourceStream(System.String)">
  4147. <summary> Get the InputStream that the Runtime will parse
  4148. to create a template.
  4149. </summary>
  4150. </member>
  4151. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyRelativeResourceLoader.IsSourceModified(NVelocity.Runtime.Resource.Resource)">
  4152. <summary> Given a template, check to see if the source of InputStream
  4153. has been modified.
  4154. </summary>
  4155. </member>
  4156. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyRelativeResourceLoader.GetLastModified(NVelocity.Runtime.Resource.Resource)">
  4157. <summary> Get the last modified time of the InputStream source
  4158. that was used to create the template. We need the template
  4159. here because we have to extract the name of the template
  4160. in order to locate the InputStream source.
  4161. </summary>
  4162. </member>
  4163. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyResourceLoader.Init(Commons.Collections.ExtendedProperties)">
  4164. <summary>
  4165. Initialize the template loader with a resources class.
  4166. </summary>
  4167. </member>
  4168. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyResourceLoader.GetResourceStream(System.String)">
  4169. <summary> Get the InputStream that the Runtime will parse
  4170. to create a template.
  4171. </summary>
  4172. </member>
  4173. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyResourceLoader.IsSourceModified(NVelocity.Runtime.Resource.Resource)">
  4174. <summary> Given a template, check to see if the source of InputStream
  4175. has been modified.
  4176. </summary>
  4177. </member>
  4178. <member name="M:NVelocity.Runtime.Resource.Loader.AssemblyResourceLoader.GetLastModified(NVelocity.Runtime.Resource.Resource)">
  4179. <summary> Get the last modified time of the InputStream source
  4180. that was used to create the template. We need the template
  4181. here because we have to extract the name of the template
  4182. in order to locate the InputStream source.
  4183. </summary>
  4184. </member>
  4185. <member name="T:NVelocity.Runtime.Resource.Loader.FileResourceLoader">
  4186. <summary>
  4187. A loader for templates stored on the file system.
  4188. </summary>
  4189. </member>
  4190. <member name="F:NVelocity.Runtime.Resource.Loader.FileResourceLoader.paths">
  4191. <summary>
  4192. The paths to search for templates.
  4193. </summary>
  4194. </member>
  4195. <member name="F:NVelocity.Runtime.Resource.Loader.FileResourceLoader.templatePaths">
  4196. <summary>
  4197. Used to map the path that a template was found on
  4198. so that we can properly check the modification
  4199. times of the files.
  4200. </summary>
  4201. </member>
  4202. <member name="M:NVelocity.Runtime.Resource.Loader.FileResourceLoader.GetResourceStream(System.String)">
  4203. <summary>
  4204. Get an InputStream so that the Runtime can build a
  4205. template with it.
  4206. </summary>
  4207. <param name="templateName">name of template to get</param>
  4208. <returns>InputStream containing the template
  4209. @throws ResourceNotFoundException if template not found
  4210. in the file template path.
  4211. </returns>
  4212. </member>
  4213. <member name="M:NVelocity.Runtime.Resource.Loader.FileResourceLoader.FindTemplate(System.String,System.String)">
  4214. <summary>
  4215. Try to find a template given a normalized path.
  4216. </summary>
  4217. <param name="path">a normalized path</param>
  4218. <param name="template">filename of template to get</param>
  4219. <returns>InputStream input stream that will be parsed</returns>
  4220. </member>
  4221. <member name="M:NVelocity.Runtime.Resource.Loader.FileResourceLoader.IsSourceModified(NVelocity.Runtime.Resource.Resource)">
  4222. <summary>
  4223. How to keep track of all the modified times
  4224. across the paths.
  4225. </summary>
  4226. </member>
  4227. <member name="T:NVelocity.Runtime.Resource.Loader.ResourceLoaderFactory">
  4228. <summary>
  4229. Factory to grab a template loader.
  4230. </summary>
  4231. <author><a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  4232. </member>
  4233. <member name="M:NVelocity.Runtime.Resource.Loader.ResourceLoaderFactory.getLoader(NVelocity.Runtime.IRuntimeServices,System.String)">
  4234. <summary>
  4235. Gets the loader specified in the configuration file.
  4236. </summary>
  4237. <returns>TemplateLoader</returns>
  4238. </member>
  4239. <member name="T:NVelocity.Runtime.Resource.ContentResource">
  4240. <summary>
  4241. This class represent a general text resource that
  4242. may have been retrieved from any number of possible
  4243. sources.
  4244. Also of interest is Velocity's {@link org.apache.velocity.Template}
  4245. <code>Resource</code>.
  4246. </summary>
  4247. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  4248. </author>
  4249. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  4250. </author>
  4251. <version> $Id: ContentResource.cs,v 1.5 2004/01/02 00:09:23 corts Exp $
  4252. </version>
  4253. </member>
  4254. <member name="T:NVelocity.Runtime.Resource.Resource">
  4255. <summary>
  4256. This class represent a general text resource that
  4257. may have been retrieved from any number of possible
  4258. sources.
  4259. </summary>
  4260. <author><a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  4261. <author><a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  4262. <version> $Id: Resource.cs,v 1.5 2004/01/02 00:13:51 corts Exp $</version>
  4263. </member>
  4264. <member name="F:NVelocity.Runtime.Resource.Resource.MILLIS_PER_SECOND">
  4265. <summary>
  4266. The number of milliseconds in a minute, used to calculate the
  4267. check interval.
  4268. </summary>
  4269. </member>
  4270. <member name="F:NVelocity.Runtime.Resource.Resource.data">
  4271. <summary>
  4272. Resource might require ancillary storage of some kind
  4273. </summary>
  4274. </member>
  4275. <member name="F:NVelocity.Runtime.Resource.Resource.encoding">
  4276. <summary>
  4277. Character encoding of this resource
  4278. </summary>
  4279. </member>
  4280. <member name="F:NVelocity.Runtime.Resource.Resource.lastModified">
  4281. <summary>
  4282. The file modification time (in milliseconds) for the cached template.
  4283. </summary>
  4284. </member>
  4285. <member name="F:NVelocity.Runtime.Resource.Resource.modificationCheckInterval">
  4286. <summary>
  4287. How often the file modification time is checked (in milliseconds).
  4288. </summary>
  4289. </member>
  4290. <member name="F:NVelocity.Runtime.Resource.Resource.name">
  4291. <summary>
  4292. Name of the resource
  4293. </summary>
  4294. </member>
  4295. <member name="F:NVelocity.Runtime.Resource.Resource.nextCheck">
  4296. <summary>
  4297. The next time the file modification time will be checked (in milliseconds).
  4298. </summary>
  4299. </member>
  4300. <member name="F:NVelocity.Runtime.Resource.Resource.resourceLoader">
  4301. <summary>
  4302. The template loader that initially loaded the input
  4303. stream for this template, and knows how to check the
  4304. source of the input stream for modification.
  4305. </summary>
  4306. </member>
  4307. <member name="M:NVelocity.Runtime.Resource.Resource.Process">
  4308. <summary>
  4309. Perform any subsequent processing that might need
  4310. to be done by a resource. In the case of a template
  4311. the actual parsing of the input stream needs to be
  4312. performed.
  4313. </summary>
  4314. <returns>
  4315. Whether the resource could be processed successfully.
  4316. For a {@link org.apache.velocity.Template} or {@link
  4317. org.apache.velocity.runtime.resource.ContentResource}, this
  4318. indicates whether the resource could be read.
  4319. @exception ResourceNotFoundException Similar in semantics as
  4320. returning <code>false</code>.
  4321. </returns>
  4322. </member>
  4323. <member name="M:NVelocity.Runtime.Resource.Resource.RequiresChecking">
  4324. <summary> Set the modification check interval.
  4325. </summary>
  4326. <summary> Is it time to check to see if the resource
  4327. source has been updated?
  4328. </summary>
  4329. </member>
  4330. <member name="M:NVelocity.Runtime.Resource.Resource.Touch">
  4331. <summary>
  4332. 'Touch' this template and thereby resetting the nextCheck field.
  4333. </summary>
  4334. </member>
  4335. <member name="P:NVelocity.Runtime.Resource.Resource.Data">
  4336. <summary>
  4337. Set arbitrary data object that might be used
  4338. by the resource.
  4339. Get arbitrary data object that might be used
  4340. by the resource.
  4341. </summary>
  4342. </member>
  4343. <member name="P:NVelocity.Runtime.Resource.Resource.Encoding">
  4344. <summary>
  4345. set the encoding of this resource
  4346. for example, "ISO-8859-1"
  4347. get the encoding of this resource
  4348. for example, "ISO-8859-1"
  4349. </summary>
  4350. </member>
  4351. <member name="P:NVelocity.Runtime.Resource.Resource.LastModified">
  4352. <summary>
  4353. Return the lastModified time of this
  4354. template.
  4355. Set the last modified time for this
  4356. template.
  4357. </summary>
  4358. </member>
  4359. <member name="P:NVelocity.Runtime.Resource.Resource.Name">
  4360. <summary>
  4361. Set the name of this resource, for example test.vm.
  4362. Get the name of this template.
  4363. </summary>
  4364. </member>
  4365. <member name="P:NVelocity.Runtime.Resource.Resource.ResourceLoader">
  4366. <summary>
  4367. Return the template loader that pulled
  4368. in the template stream
  4369. Set the template loader for this template. Set
  4370. when the Runtime determines where this template
  4371. came from the list of possible sources.
  4372. </summary>
  4373. </member>
  4374. <member name="M:NVelocity.Runtime.Resource.ContentResource.#ctor">
  4375. <summary>Default empty constructor
  4376. </summary>
  4377. </member>
  4378. <member name="M:NVelocity.Runtime.Resource.ContentResource.Process">
  4379. <summary>
  4380. Pull in static content and store it.
  4381. @exception ResourceNotFoundException Resource could not be
  4382. found.
  4383. </summary>
  4384. </member>
  4385. <member name="T:NVelocity.Runtime.Resource.ResourceCache">
  4386. <summary> Interface that defines the shape of a pluggable resource cache
  4387. for the included ResourceManager
  4388. *
  4389. </summary>
  4390. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  4391. </author>
  4392. <version> $Id: ResourceCache.cs,v 1.3 2003/10/27 13:54:11 corts Exp $
  4393. </version>
  4394. </member>
  4395. <member name="M:NVelocity.Runtime.Resource.ResourceCache.initialize(NVelocity.Runtime.IRuntimeServices)">
  4396. <summary> initializes the ResourceCache. Will be
  4397. called before any utilization
  4398. *
  4399. </summary>
  4400. <param name="rs">RuntimeServices to use for logging, etc
  4401. </param>
  4402. </member>
  4403. <member name="M:NVelocity.Runtime.Resource.ResourceCache.get(System.Object)">
  4404. <summary> retrieves a Resource from the
  4405. cache
  4406. *
  4407. </summary>
  4408. <param name="resourceKey">key for Resource to be retrieved
  4409. </param>
  4410. <returns>Resource specified or null if not found
  4411. </returns>
  4412. </member>
  4413. <member name="M:NVelocity.Runtime.Resource.ResourceCache.put(System.Object,NVelocity.Runtime.Resource.Resource)">
  4414. <summary> stores a Resource in the cache
  4415. *
  4416. </summary>
  4417. <param name="resourceKey">key to associate with the Resource
  4418. </param>
  4419. <param name="resource">Resource to be stored
  4420. </param>
  4421. <returns>existing Resource stored under this key, or null if none
  4422. </returns>
  4423. </member>
  4424. <member name="M:NVelocity.Runtime.Resource.ResourceCache.remove(System.Object)">
  4425. <summary> removes a Resource from the cache
  4426. *
  4427. </summary>
  4428. <param name="resourceKey">resource to be removed
  4429. </param>
  4430. </member>
  4431. <member name="M:NVelocity.Runtime.Resource.ResourceCache.enumerateKeys">
  4432. <summary> returns an Iterator of Keys in the cache
  4433. </summary>
  4434. </member>
  4435. <member name="T:NVelocity.Runtime.Resource.ResourceCacheImpl">
  4436. <summary>
  4437. Default implementation of the resource cache for the default
  4438. ResourceManager. The cache uses a <i>least recently used</i> (LRU)
  4439. algorithm, with a maximum size specified via the
  4440. <code>resource.manager.cache.size</code> property (identified by the
  4441. {@link
  4442. org.apache.velocity.runtime.RuntimeConstants#RESOURCE_MANAGER_CACHE_SIZE}
  4443. constant). This property get be set to <code>0</code> or less for
  4444. a greedy, unbounded cache (the behavior from pre-v1.5).
  4445. *
  4446. </summary>
  4447. <author> <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
  4448. </author>
  4449. <author> <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
  4450. </author>
  4451. <version> $Id: ResourceCacheImpl.cs,v 1.5 2004/12/23 08:14:32 corts Exp $
  4452. </version>
  4453. </member>
  4454. <member name="F:NVelocity.Runtime.Resource.ResourceCacheImpl.cache">
  4455. <summary>
  4456. Cache storage, assumed to be thread-safe.
  4457. </summary>
  4458. </member>
  4459. <member name="F:NVelocity.Runtime.Resource.ResourceCacheImpl.runtimeServices">
  4460. <summary>
  4461. Runtime services, generally initialized by the
  4462. <code>initialize()</code> method.
  4463. </summary>
  4464. </member>
  4465. <member name="T:NVelocity.Runtime.Resource.ResourceFactory">
  4466. <summary>
  4467. Class responsible for instantiating <code>Resource</code> objects,
  4468. given name and type.
  4469. </summary>
  4470. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a> </author>
  4471. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  4472. <version> $Id: ResourceFactory.cs,v 1.3 2003/10/27 13:54:11 corts Exp $ </version>
  4473. </member>
  4474. <member name="T:NVelocity.Runtime.Resource.ResourceType">
  4475. <summary>
  4476. Class to manage the text resource for the Velocity
  4477. Runtime.
  4478. </summary>
  4479. </member>
  4480. <member name="F:NVelocity.Runtime.Resource.ResourceType.Template">
  4481. <summary>
  4482. A template resources.
  4483. </summary>
  4484. </member>
  4485. <member name="F:NVelocity.Runtime.Resource.ResourceType.Content">
  4486. <summary>
  4487. A static content resource.
  4488. </summary>
  4489. </member>
  4490. <member name="M:NVelocity.Runtime.Resource.IResourceManager.Initialize(NVelocity.Runtime.IRuntimeServices)">
  4491. <summary>
  4492. Initialize the ResourceManager.
  4493. </summary>
  4494. </member>
  4495. <member name="M:NVelocity.Runtime.Resource.IResourceManager.GetResource(System.String,NVelocity.Runtime.Resource.ResourceType,System.String)">
  4496. <summary>
  4497. Gets the named resource. Returned class type corresponds to specified type
  4498. (i.e. <c>Template</c> to <c>Template</c>).
  4499. </summary>
  4500. <param name="resourceName">The name of the resource to retrieve.</param>
  4501. <param name="resourceType">The type of resource (<code>Template</code>, <code>Content</code>, etc.).</param>
  4502. <param name="encoding">The character encoding to use.</param>
  4503. <returns>Resource with the template parsed and ready.</returns>
  4504. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  4505. if template not found from any available source.
  4506. </exception>
  4507. <exception cref="T:NVelocity.Exception.ParseErrorException">
  4508. if template cannot be parsed due to syntax (or other) error.
  4509. </exception>
  4510. <exception cref="T:System.Exception">
  4511. if a problem in parse
  4512. </exception>
  4513. </member>
  4514. <member name="M:NVelocity.Runtime.Resource.IResourceManager.GetLoaderNameForResource(System.String)">
  4515. <summary>
  4516. Determines is a template exists, and returns name of the loader that
  4517. provides it. This is a slightly less hokey way to support
  4518. the Velocity.templateExists() utility method, which was broken
  4519. when per-template encoding was introduced. We can revisit this.
  4520. </summary>
  4521. <param name="resourceName">Name of template or content resource</param>
  4522. <returns>class name of loader than can provide it</returns>
  4523. </member>
  4524. <member name="T:NVelocity.Runtime.Resource.ResourceManagerImpl">
  4525. <summary>
  4526. Class to manage the text resource for the Velocity Runtime.
  4527. </summary>
  4528. </member>
  4529. <member name="F:NVelocity.Runtime.Resource.ResourceManagerImpl.RESOURCE_LOADER_IDENTIFIER">
  4530. <summary>
  4531. token used to identify the loader internally
  4532. </summary>
  4533. </member>
  4534. <member name="F:NVelocity.Runtime.Resource.ResourceManagerImpl.globalCache">
  4535. <summary>
  4536. Object implementing ResourceCache to
  4537. be our resource manager's Resource cache.
  4538. </summary>
  4539. </member>
  4540. <member name="F:NVelocity.Runtime.Resource.ResourceManagerImpl.resourceLoaders">
  4541. <summary>
  4542. The List of templateLoaders that the Runtime will
  4543. use to locate the InputStream source of a template.
  4544. </summary>
  4545. </member>
  4546. <member name="F:NVelocity.Runtime.Resource.ResourceManagerImpl.sourceInitializerList">
  4547. <summary>
  4548. This is a list of the template input stream source
  4549. initializers, basically properties for a particular
  4550. template stream source. The order in this list
  4551. reflects numbering of the properties i.e.
  4552. &lt;loader-id&gt;.resource.loader.&lt;property&gt; = &lt;value&gt;
  4553. </summary>
  4554. </member>
  4555. <member name="F:NVelocity.Runtime.Resource.ResourceManagerImpl.resourceLoaderInitializersActive">
  4556. <summary>
  4557. Each loader needs a configuration object for
  4558. its initialization, this flags keeps track of whether
  4559. or not the configuration objects have been created
  4560. for the resource loaders.
  4561. </summary>
  4562. </member>
  4563. <member name="F:NVelocity.Runtime.Resource.ResourceManagerImpl.logWhenFound">
  4564. <summary>
  4565. switch to turn off log notice when a resource is found for
  4566. the first time.
  4567. </summary>
  4568. </member>
  4569. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.Initialize(NVelocity.Runtime.IRuntimeServices)">
  4570. <summary>
  4571. Initialize the ResourceManager.
  4572. </summary>
  4573. </member>
  4574. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.AssembleResourceLoaderInitializers">
  4575. <summary>
  4576. This will produce a List of Hashtables, each
  4577. hashtable contains the initialization info for
  4578. a particular resource loader. This Hashtable
  4579. will be passed in when initializing the
  4580. the template loader.
  4581. </summary>
  4582. </member>
  4583. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.GetResource(System.String,NVelocity.Runtime.Resource.ResourceType,System.String)">
  4584. <summary> Gets the named resource. Returned class type corresponds to specified type
  4585. (i.e. <code>Template</code> to <code>Template</code>).
  4586. *
  4587. </summary>
  4588. <param name="resourceName">The name of the resource to retrieve.
  4589. </param>
  4590. <param name="resourceType">The type of resource (<code>Template</code>,
  4591. <code>Content</code>, etc.).
  4592. </param>
  4593. <param name="encoding"> The character encoding to use.
  4594. </param>
  4595. <returns>Resource with the template parsed and ready.
  4596. @throws ResourceNotFoundException if template not found
  4597. from any available source.
  4598. @throws ParseErrorException if template cannot be parsed due
  4599. to syntax (or other) error.
  4600. @throws Exception if a problem in parse
  4601. </returns>
  4602. </member>
  4603. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.LoadResource(System.String,NVelocity.Runtime.Resource.ResourceType,System.String)">
  4604. <summary>
  4605. Loads a resource from the current set of resource loaders
  4606. </summary>
  4607. <param name="resourceName">The name of the resource to retrieve.</param>
  4608. <param name="resourceType">The type of resource (<code>Template</code>,
  4609. <code>Content</code>, etc.).
  4610. </param>
  4611. <param name="encoding"> The character encoding to use.</param>
  4612. <returns>Resource with the template parsed and ready.
  4613. @throws ResourceNotFoundException if template not found
  4614. from any available source.
  4615. @throws ParseErrorException if template cannot be parsed due
  4616. to syntax (or other) error.
  4617. @throws Exception if a problem in parse
  4618. </returns>
  4619. </member>
  4620. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.RefreshResource(NVelocity.Runtime.Resource.Resource,System.String)">
  4621. <summary> Takes an existing resource, and 'refreshes' it. This
  4622. generally means that the source of the resource is checked
  4623. for changes according to some cache/check algorithm
  4624. and if the resource changed, then the resource data is
  4625. reloaded and re-parsed.
  4626. *
  4627. </summary>
  4628. <param name="resource">resource to refresh
  4629. *
  4630. @throws ResourceNotFoundException if template not found
  4631. from current source for this Resource
  4632. @throws ParseErrorException if template cannot be parsed due
  4633. to syntax (or other) error.
  4634. @throws Exception if a problem in parse
  4635. </param>
  4636. <param name="encoding"></param>
  4637. </member>
  4638. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.GetResource(System.String,NVelocity.Runtime.Resource.ResourceType)">
  4639. <summary> Gets the named resource. Returned class type corresponds to specified type
  4640. (i.e. <code>Template</code> to <code>Template</code>).
  4641. *
  4642. </summary>
  4643. <param name="resourceName">The name of the resource to retrieve.
  4644. </param>
  4645. <param name="resourceType">The type of resource (<code>Template</code>,
  4646. <code>Content</code>, etc.).
  4647. </param>
  4648. <returns>Resource with the template parsed and ready.
  4649. @throws ResourceNotFoundException if template not found
  4650. from any available source.
  4651. @throws ParseErrorException if template cannot be parsed due
  4652. to syntax (or other) error.
  4653. @throws Exception if a problem in parse
  4654. *
  4655. </returns>
  4656. <deprecated>Use
  4657. {@link #GetResource(String resourceName, int resourceType,
  4658. String encoding )}
  4659. </deprecated>
  4660. </member>
  4661. <member name="M:NVelocity.Runtime.Resource.ResourceManagerImpl.GetLoaderNameForResource(System.String)">
  4662. <summary> Determines is a template exists, and returns name of the loader that
  4663. provides it. This is a slightly less hokey way to support
  4664. the Velocity.templateExists() utility method, which was broken
  4665. when per-template encoding was introduced. We can revisit this.
  4666. </summary>
  4667. <param name="resourceName">Name of template or content resource
  4668. </param>
  4669. <returns>class name of loader than can provide it
  4670. </returns>
  4671. </member>
  4672. <member name="T:NVelocity.Runtime.Visitor.BaseVisitor">
  4673. <summary> This is the base class for all visitors.
  4674. For each AST node, this class will provide
  4675. a bare-bones method for traversal.
  4676. *
  4677. </summary>
  4678. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  4679. </author>
  4680. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  4681. </author>
  4682. <version> $Id: BaseVisitor.cs,v 1.3 2003/10/27 13:54:11 corts Exp $
  4683. </version>
  4684. </member>
  4685. <member name="F:NVelocity.Runtime.Visitor.BaseVisitor.context">
  4686. <summary>
  4687. Context used during traversal
  4688. </summary>
  4689. </member>
  4690. <member name="F:NVelocity.Runtime.Visitor.BaseVisitor.writer">
  4691. <summary>
  4692. Writer used as the output sink
  4693. </summary>
  4694. </member>
  4695. <member name="T:NVelocity.Runtime.Visitor.NodeViewMode">
  4696. <summary> This class is simply a visitor implementation
  4697. that traverses the AST, produced by the Velocity
  4698. parsing process, and creates a visual structure
  4699. of the AST. This is primarily used for
  4700. debugging, but it useful for documentation
  4701. as well.
  4702. *
  4703. </summary>
  4704. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  4705. </author>
  4706. <version> $Id: NodeViewMode.cs,v 1.3 2003/10/27 13:54:11 corts Exp $
  4707. </version>
  4708. </member>
  4709. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.IndentString">
  4710. <summary>Indent child nodes to help visually identify
  4711. the structure of the AST.
  4712. </summary>
  4713. </member>
  4714. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.ShowNode(NVelocity.Runtime.Parser.Node.INode,System.Object)">
  4715. <summary> Display the type of nodes and optionally the
  4716. first token.
  4717. </summary>
  4718. </member>
  4719. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.SimpleNode,System.Object)">
  4720. <summary>Display a SimpleNode
  4721. </summary>
  4722. </member>
  4723. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTprocess,System.Object)">
  4724. <summary>Display an ASTprocess node
  4725. </summary>
  4726. </member>
  4727. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTExpression,System.Object)">
  4728. <summary>Display an ASTExpression node
  4729. </summary>
  4730. </member>
  4731. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTAssignment,System.Object)">
  4732. <summary>Display an ASTAssignment node ( = )
  4733. </summary>
  4734. </member>
  4735. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTOrNode,System.Object)">
  4736. <summary>Display an ASTOrNode ( || )
  4737. </summary>
  4738. </member>
  4739. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTAndNode,System.Object)">
  4740. <summary>Display an ASTAndNode ( &amp;&amp; )
  4741. </summary>
  4742. </member>
  4743. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTEQNode,System.Object)">
  4744. <summary>Display an ASTEQNode ( == )
  4745. </summary>
  4746. </member>
  4747. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTNENode,System.Object)">
  4748. <summary>Display an ASTNENode ( != )
  4749. </summary>
  4750. </member>
  4751. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTLTNode,System.Object)">
  4752. <summary>Display an ASTLTNode ( &lt; )
  4753. </summary>
  4754. </member>
  4755. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTGTNode,System.Object)">
  4756. <summary>Display an ASTGTNode ( &gt; )
  4757. </summary>
  4758. </member>
  4759. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTLENode,System.Object)">
  4760. <summary>Display an ASTLENode ( &lt;= )
  4761. </summary>
  4762. </member>
  4763. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTGENode,System.Object)">
  4764. <summary>Display an ASTGENode ( &gt;= )
  4765. </summary>
  4766. </member>
  4767. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTAddNode,System.Object)">
  4768. <summary>Display an ASTAddNode ( + )
  4769. </summary>
  4770. </member>
  4771. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTSubtractNode,System.Object)">
  4772. <summary>Display an ASTSubtractNode ( - )
  4773. </summary>
  4774. </member>
  4775. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTMulNode,System.Object)">
  4776. <summary>Display an ASTMulNode ( * )
  4777. </summary>
  4778. </member>
  4779. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTDivNode,System.Object)">
  4780. <summary>Display an ASTDivNode ( / )
  4781. </summary>
  4782. </member>
  4783. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTModNode,System.Object)">
  4784. <summary>Display an ASTModNode ( % )
  4785. </summary>
  4786. </member>
  4787. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTNotNode,System.Object)">
  4788. <summary>Display an ASTNotNode ( ! )
  4789. </summary>
  4790. </member>
  4791. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTNumberLiteral,System.Object)">
  4792. <summary>Display an ASTNumberLiteral node
  4793. </summary>
  4794. </member>
  4795. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTStringLiteral,System.Object)">
  4796. <summary>Display an ASTStringLiteral node
  4797. </summary>
  4798. </member>
  4799. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTIdentifier,System.Object)">
  4800. <summary>Display an ASTIdentifier node
  4801. </summary>
  4802. </member>
  4803. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTMethod,System.Object)">
  4804. <summary>Display an ASTMethod node
  4805. </summary>
  4806. </member>
  4807. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTReference,System.Object)">
  4808. <summary>Display an ASTReference node
  4809. </summary>
  4810. </member>
  4811. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTTrue,System.Object)">
  4812. <summary>Display an ASTTrue node
  4813. </summary>
  4814. </member>
  4815. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTFalse,System.Object)">
  4816. <summary>Display an ASTFalse node
  4817. </summary>
  4818. </member>
  4819. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTBlock,System.Object)">
  4820. <summary>Display an ASTBlock node
  4821. </summary>
  4822. </member>
  4823. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTText,System.Object)">
  4824. <summary>Display an ASTText node
  4825. </summary>
  4826. </member>
  4827. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTIfStatement,System.Object)">
  4828. <summary>Display an ASTIfStatement node
  4829. </summary>
  4830. </member>
  4831. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTElseStatement,System.Object)">
  4832. <summary>Display an ASTElseStatement node
  4833. </summary>
  4834. </member>
  4835. <member name="M:NVelocity.Runtime.Visitor.NodeViewMode.Visit(NVelocity.Runtime.Parser.Node.ASTElseIfStatement,System.Object)">
  4836. <summary>Display an ASTElseIfStatement node
  4837. </summary>
  4838. </member>
  4839. <member name="T:NVelocity.Runtime.Visitor.VMReferenceMungeVisitor">
  4840. <summary>
  4841. This class is a visitor used by the VM proxy to change the
  4842. literal representation of a reference in a VM. The reason is
  4843. to preserve the 'render literal if null' behavior w/o making
  4844. the VMProxy stuff more complicated than it is already.
  4845. </summary>
  4846. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  4847. <version> $Id: VMReferenceMungeVisitor.cs,v 1.3 2003/10/27 13:54:11 corts Exp $</version>
  4848. </member>
  4849. <member name="F:NVelocity.Runtime.Visitor.VMReferenceMungeVisitor.argumentMap">
  4850. <summary>
  4851. Map containing VM arg to instance-use reference
  4852. Passed in with CTOR
  4853. </summary>
  4854. </member>
  4855. <member name="M:NVelocity.Runtime.Visitor.VMReferenceMungeVisitor.#ctor(System.Collections.Hashtable)">
  4856. <summary>
  4857. CTOR - takes a map of args to reference
  4858. </summary>
  4859. </member>
  4860. <member name="M:NVelocity.Runtime.Visitor.VMReferenceMungeVisitor.Visit(NVelocity.Runtime.Parser.Node.ASTReference,System.Object)">
  4861. <summary>
  4862. Visitor method - if the literal is right, will
  4863. set the literal in the ASTReference node
  4864. </summary>
  4865. <param name="node">ASTReference to work on</param>
  4866. <param name="data">Object to pass down from caller</param>
  4867. </member>
  4868. <member name="T:NVelocity.Runtime.IRuntimeLogger">
  4869. <summary>
  4870. Interface for internal runtime logging services that are needed by the
  4871. </summary>
  4872. <author><a href="mailto:geirm@apache.org">Geir Magusson Jr.</a></author>
  4873. <version>$Id: RuntimeLogger.cs,v 1.1 2004/01/02 00:04:50 corts Exp $</version>
  4874. </member>
  4875. <member name="M:NVelocity.Runtime.IRuntimeLogger.Warn(System.Object)">
  4876. <summary>
  4877. Log a warning message.
  4878. </summary>
  4879. <param name="message">message to log</param>
  4880. </member>
  4881. <member name="M:NVelocity.Runtime.IRuntimeLogger.Info(System.Object)">
  4882. <summary>
  4883. Log an info message.
  4884. </summary>
  4885. <param name="message">message to log</param>
  4886. </member>
  4887. <member name="M:NVelocity.Runtime.IRuntimeLogger.Error(System.Object)">
  4888. <summary>
  4889. Log an error message.
  4890. </summary>
  4891. <param name="message">message to log</param>
  4892. </member>
  4893. <member name="M:NVelocity.Runtime.IRuntimeLogger.Debug(System.Object)">
  4894. <summary>
  4895. Log a debug message.
  4896. </summary>
  4897. <param name="message">message to log</param>
  4898. </member>
  4899. <member name="T:NVelocity.Runtime.IRuntimeServices">
  4900. <summary> Interface for internal runtime services that are needed by the
  4901. various components w/in Velocity. This was taken from the old
  4902. Runtime singleton, and anything not necessary was removed.
  4903. Currently implemented by RuntimeInstance.
  4904. </summary>
  4905. </member>
  4906. <member name="M:NVelocity.Runtime.IRuntimeServices.SetProperty(System.String,System.Object)">
  4907. <summary>
  4908. Allows an external system to set a property in
  4909. the Velocity Runtime.
  4910. </summary>
  4911. <param name="key">property key</param>
  4912. <param name="value">property value</param>
  4913. </member>
  4914. <member name="M:NVelocity.Runtime.IRuntimeServices.AddProperty(System.String,System.Object)">
  4915. <summary> Add a property to the configuration. If it already
  4916. exists then the value stated here will be added
  4917. to the configuration entry. For example, if
  4918. *
  4919. resource.loader = file
  4920. *
  4921. is already present in the configuration and you
  4922. *
  4923. addProperty("resource.loader", "classpath")
  4924. *
  4925. Then you will end up with a Vector like the
  4926. following:
  4927. *
  4928. ["file", "classpath"]
  4929. *
  4930. </summary>
  4931. <param name="key">key</param>
  4932. <param name="value">value</param>
  4933. </member>
  4934. <member name="M:NVelocity.Runtime.IRuntimeServices.ClearProperty(System.String)">
  4935. <summary>
  4936. Clear the values pertaining to a particular property.
  4937. </summary>
  4938. <param name="key">key of property to clear</param>
  4939. </member>
  4940. <member name="M:NVelocity.Runtime.IRuntimeServices.GetProperty(System.String)">
  4941. <summary> Allows an external caller to get a property. The calling
  4942. routine is required to know the type, as this routine
  4943. will return an Object, as that is what properties can be.
  4944. *
  4945. </summary>
  4946. <param name="key">property to return
  4947. </param>
  4948. </member>
  4949. <member name="M:NVelocity.Runtime.IRuntimeServices.Init(System.String)">
  4950. <summary>
  4951. Initialize the Velocity Runtime with the name of
  4952. ExtendedProperties object.
  4953. </summary>
  4954. <param name="configurationFile">Properties</param>
  4955. </member>
  4956. <member name="M:NVelocity.Runtime.IRuntimeServices.Parse(System.IO.TextReader,System.String)">
  4957. <summary>
  4958. Parse the input and return the root of
  4959. AST node structure.
  4960. </summary>
  4961. <remarks>
  4962. In the event that it runs out of parsers in the
  4963. pool, it will create and let them be GC'd
  4964. dynamically, logging that it has to do that. This
  4965. is considered an exceptional condition. It is
  4966. expected that the user will set the
  4967. PARSER_POOL_SIZE property appropriately for their
  4968. application. We will revisit this.
  4969. </remarks>
  4970. <param name="reader">inputStream retrieved by a resource loader</param>
  4971. <param name="templateName">name of the template being parsed</param>
  4972. </member>
  4973. <member name="M:NVelocity.Runtime.IRuntimeServices.Parse(System.IO.TextReader,System.String,System.Boolean)">
  4974. <summary>
  4975. Parse the input and return the root of the AST node structure.
  4976. </summary>
  4977. <param name="reader">inputStream retrieved by a resource loader</param>
  4978. <param name="templateName">name of the template being parsed</param>
  4979. <param name="dumpNamespace">flag to dump the Velocimacro namespace for this template</param>
  4980. </member>
  4981. <member name="M:NVelocity.Runtime.IRuntimeServices.GetTemplate(System.String)">
  4982. <summary> Returns a <code>Template</code> from the resource manager.
  4983. This method assumes that the character encoding of the
  4984. template is set by the <code>input.encoding</code>
  4985. property. The default is "ISO-8859-1"
  4986. *
  4987. </summary>
  4988. <param name="name">The file name of the desired template.
  4989. </param>
  4990. <returns> The template.
  4991. @throws ResourceNotFoundException if template not found
  4992. from any available source.
  4993. @throws ParseErrorException if template cannot be parsed due
  4994. to syntax (or other) error.
  4995. @throws Exception if an error occurs in template initialization
  4996. </returns>
  4997. </member>
  4998. <member name="M:NVelocity.Runtime.IRuntimeServices.GetTemplate(System.String,System.String)">
  4999. <summary> Returns a <code>Template</code> from the resource manager
  5000. *
  5001. </summary>
  5002. <param name="name">The name of the desired template.
  5003. </param>
  5004. <param name="encoding">Character encoding of the template
  5005. </param>
  5006. <returns> The template.
  5007. @throws ResourceNotFoundException if template not found
  5008. from any available source.
  5009. @throws ParseErrorException if template cannot be parsed due
  5010. to syntax (or other) error.
  5011. @throws Exception if an error occurs in template initialization
  5012. </returns>
  5013. </member>
  5014. <member name="M:NVelocity.Runtime.IRuntimeServices.GetContent(System.String)">
  5015. <summary> Returns a static content resource from the
  5016. resource manager. Uses the current value
  5017. if INPUT_ENCODING as the character encoding.
  5018. *
  5019. </summary>
  5020. <param name="name">Name of content resource to get
  5021. </param>
  5022. <returns>parsed ContentResource object ready for use
  5023. @throws ResourceNotFoundException if template not found
  5024. from any available source.
  5025. </returns>
  5026. </member>
  5027. <member name="M:NVelocity.Runtime.IRuntimeServices.GetContent(System.String,System.String)">
  5028. <summary> Returns a static content resource from the
  5029. resource manager.
  5030. *
  5031. </summary>
  5032. <param name="name">Name of content resource to get
  5033. </param>
  5034. <param name="encoding">Character encoding to use
  5035. </param>
  5036. <returns>parsed ContentResource object ready for use
  5037. @throws ResourceNotFoundException if template not found
  5038. from any available source.
  5039. </returns>
  5040. </member>
  5041. <member name="M:NVelocity.Runtime.IRuntimeServices.GetLoaderNameForResource(System.String)">
  5042. <summary> Determines is a template exists, and returns name of the loader that
  5043. provides it. This is a slightly less hokey way to support
  5044. the Velocity.templateExists() utility method, which was broken
  5045. when per-template encoding was introduced. We can revisit this.
  5046. *
  5047. </summary>
  5048. <param name="resourceName">Name of template or content resource
  5049. </param>
  5050. <returns>class name of loader than can provide it
  5051. </returns>
  5052. </member>
  5053. <member name="M:NVelocity.Runtime.IRuntimeServices.GetString(System.String,System.String)">
  5054. <summary>
  5055. String property accessor method with default to hide the
  5056. configuration implementation.
  5057. </summary>
  5058. <param name="key">key property key</param>
  5059. <param name="defaultValue">default value to return if key not
  5060. found in resource manager.
  5061. </param>
  5062. <returns>value of key or default</returns>
  5063. </member>
  5064. <member name="M:NVelocity.Runtime.IRuntimeServices.GetVelocimacro(System.String,System.String)">
  5065. <summary>
  5066. Returns the appropriate VelocimacroProxy object if vmName
  5067. is a valid current Velocimacro.
  5068. </summary>
  5069. <param name="vmName">Name of velocimacro requested</param>
  5070. <param name="templateName">Template Name</param>
  5071. <returns>VelocimacroProxy</returns>
  5072. </member>
  5073. <member name="M:NVelocity.Runtime.IRuntimeServices.AddVelocimacro(System.String,System.String,System.String[],System.String)">
  5074. <summary>
  5075. Adds a new Velocimacro. Usually called by Macro only while parsing.
  5076. </summary>
  5077. <param name="name">name Name of velocimacro</param>
  5078. <param name="macro">macro String form of macro body</param>
  5079. <param name="argArray">argArray Array of strings, containing the
  5080. <c>#macro()</c> arguments. the 0th is the name.</param>
  5081. <param name="sourceTemplate">Source Template</param>
  5082. <returns>
  5083. True if added, false if rejected for some
  5084. reason (either parameters or permission settings)
  5085. </returns>
  5086. </member>
  5087. <member name="M:NVelocity.Runtime.IRuntimeServices.IsVelocimacro(System.String,System.String)">
  5088. <summary>
  5089. Checks to see if a VM exists
  5090. </summary>
  5091. <param name="vmName">Name of velocimacro</param>
  5092. <param name="templateName">Template Name</param>
  5093. <returns>True if VM by that name exists, false if not</returns>
  5094. </member>
  5095. <member name="M:NVelocity.Runtime.IRuntimeServices.DumpVMNamespace(System.String)">
  5096. <summary> tells the vmFactory to dump the specified namespace. This is to support
  5097. clearing the VM list when in inline-VM-local-scope mode
  5098. </summary>
  5099. </member>
  5100. <member name="M:NVelocity.Runtime.IRuntimeServices.GetString(System.String)">
  5101. <summary>
  5102. String property accessor method to hide the configuration implementation.
  5103. </summary>
  5104. <param name="key">property key</param>
  5105. <returns>value</returns>
  5106. </member>
  5107. <member name="M:NVelocity.Runtime.IRuntimeServices.GetInt(System.String)">
  5108. <summary>
  5109. Int property accessor method to hide the configuration implementation.
  5110. </summary>
  5111. <param name="key">property key</param>
  5112. <returns>value</returns>
  5113. </member>
  5114. <member name="M:NVelocity.Runtime.IRuntimeServices.GetInt(System.String,System.Int32)">
  5115. <summary>
  5116. Int property accessor method to hide the configuration implementation.
  5117. </summary>
  5118. <param name="key">property key</param>
  5119. <param name="defaultValue">default value</param>
  5120. <returns>value</returns>
  5121. </member>
  5122. <member name="M:NVelocity.Runtime.IRuntimeServices.GetBoolean(System.String,System.Boolean)">
  5123. <summary>
  5124. Boolean property accessor method to hide the configuration implementation.
  5125. </summary>
  5126. <param name="key">property key</param>
  5127. <param name="def">default value</param>
  5128. <returns>value</returns>
  5129. </member>
  5130. <member name="M:NVelocity.Runtime.IRuntimeServices.GetApplicationAttribute(System.Object)">
  5131. <summary>
  5132. Return the specified application attribute
  5133. </summary>
  5134. <param name="key"></param>
  5135. <returns></returns>
  5136. </member>
  5137. <member name="M:NVelocity.Runtime.IRuntimeServices.SetApplicationAttribute(System.Object,System.Object)">
  5138. <summary>
  5139. Sets the specified application attribute.
  5140. </summary>
  5141. <param name="key"></param>
  5142. <param name="value"></param>
  5143. </member>
  5144. <member name="P:NVelocity.Runtime.IRuntimeServices.Configuration">
  5145. Return the velocity runtime configuration object.
  5146. @return ExtendedProperties configuration object which houses
  5147. the velocity runtime properties.
  5148. </member>
  5149. <member name="P:NVelocity.Runtime.IRuntimeServices.Uberspect">
  5150. Returns the configured class introspection/reflection
  5151. implementation.
  5152. </member>
  5153. <member name="P:NVelocity.Runtime.IRuntimeServices.Introspector">
  5154. Returns the configured method introspection/reflection
  5155. implementation.
  5156. </member>
  5157. <member name="T:NVelocity.Runtime.RuntimeConstants">
  5158. <summary>
  5159. This class defines the keys that are used in the
  5160. velocity.properties file so that they can be referenced as a constant
  5161. within Java code.
  5162. </summary>
  5163. <author> <a href="mailto:jon@latchkey.com">Jon S. Stevens</a></author>
  5164. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a></author>
  5165. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  5166. </member>
  5167. <member name="F:NVelocity.Runtime.RuntimeConstants.RESOURCE_MANAGER_CACHE_CLASS">
  5168. <summary>
  5169. The <code>resource.manager.cache.class</code> property
  5170. specifies the name of the <see cref="T:NVelocity.Runtime.Resource.ResourceCache"/> implementation to use.
  5171. </summary>
  5172. </member>
  5173. <member name="F:NVelocity.Runtime.RuntimeConstants.RESOURCE_MANAGER_DEFAULTCACHE_SIZE">
  5174. <summary>
  5175. The <code>resource.manager.cache.size</code> property
  5176. specifies the cache upper bound (if relevant).
  5177. </summary>
  5178. </member>
  5179. <member name="F:NVelocity.Runtime.RuntimeConstants.NUMBER_OF_PARSERS">
  5180. <summary>
  5181. The default number of parser instances to create.
  5182. Configurable via the parameter named by the <see cref="F:NVelocity.Runtime.RuntimeConstants.PARSER_POOL_SIZE"/> constant.
  5183. </summary>
  5184. </member>
  5185. <member name="F:NVelocity.Runtime.RuntimeConstants.PARSER_POOL_SIZE">
  5186. <summary>
  5187. <see cref="F:NVelocity.Runtime.RuntimeConstants.NUMBER_OF_PARSERS"/>
  5188. </summary>
  5189. </member>
  5190. <member name="F:NVelocity.Runtime.RuntimeConstants.UBERSPECT_CLASSNAME">
  5191. <summary>
  5192. key name for uberspector
  5193. </summary>
  5194. </member>
  5195. <member name="T:NVelocity.Runtime.RuntimeInstance">
  5196. <summary>
  5197. This is the Runtime system for Velocity. It is the
  5198. single access point for all functionality in Velocity.
  5199. It adheres to the mediator pattern and is the only
  5200. structure that developers need to be familiar with
  5201. in order to get Velocity to perform.
  5202. The Runtime will also cooperate with external
  5203. systems like Turbine. Runtime properties can
  5204. set and then the Runtime is initialized.
  5205. Turbine for example knows where the templates
  5206. are to be loaded from, and where the velocity
  5207. log file should be placed.
  5208. So in the case of Velocity cooperating with Turbine
  5209. the code might look something like the following:
  5210. <code>
  5211. Runtime.setProperty(Runtime.FILE_RESOURCE_LOADER_PATH, templatePath);
  5212. Runtime.setProperty(Runtime.RUNTIME_LOG, pathToVelocityLog);
  5213. Runtime.init();
  5214. </code>
  5215. <pre>
  5216. -----------------------------------------------------------------------
  5217. N O T E S O N R U N T I M E I N I T I A L I Z A T I O N
  5218. -----------------------------------------------------------------------
  5219. Runtime.init()
  5220. If Runtime.init() is called by itself the Runtime will
  5221. initialize with a set of default values.
  5222. -----------------------------------------------------------------------
  5223. Runtime.init(String/Properties)
  5224. In this case the default velocity properties are layed down
  5225. first to provide a solid base, then any properties provided
  5226. in the given properties object will override the corresponding
  5227. default property.
  5228. -----------------------------------------------------------------------
  5229. </pre>
  5230. </summary>
  5231. </member>
  5232. <member name="F:NVelocity.Runtime.RuntimeInstance.vmFactory">
  5233. <summary>
  5234. VelocimacroFactory object to manage VMs
  5235. </summary>
  5236. </member>
  5237. <member name="F:NVelocity.Runtime.RuntimeInstance.parserPool">
  5238. <summary>
  5239. The Runtime parser pool
  5240. </summary>
  5241. </member>
  5242. <member name="F:NVelocity.Runtime.RuntimeInstance.initialized">
  5243. <summary>
  5244. Indicate whether the Runtime has been fully initialized.
  5245. </summary>
  5246. </member>
  5247. <member name="F:NVelocity.Runtime.RuntimeInstance.overridingProperties">
  5248. <summary>
  5249. These are the properties that are laid down over top
  5250. of the default properties when requested.
  5251. </summary>
  5252. </member>
  5253. <member name="F:NVelocity.Runtime.RuntimeInstance.configuration">
  5254. <summary>
  5255. Object that houses the configuration options for
  5256. the velocity runtime. The ExtendedProperties object allows
  5257. the convenient retrieval of a subset of properties.
  5258. For example all the properties for a resource loader
  5259. can be retrieved from the main ExtendedProperties object
  5260. using something like the following:
  5261. <code>
  5262. ExtendedProperties loaderConfiguration =
  5263. configuration.subset(loaderID);
  5264. </code>
  5265. And a configuration is a lot more convenient to deal
  5266. with then conventional properties objects, or Maps.
  5267. </summary>
  5268. </member>
  5269. <member name="F:NVelocity.Runtime.RuntimeInstance.introspector">
  5270. <summary>
  5271. Each runtime instance has it's own introspector
  5272. to ensure that each instance is completely separate.
  5273. </summary>
  5274. </member>
  5275. <member name="F:NVelocity.Runtime.RuntimeInstance.applicationAttributes">
  5276. <summary>
  5277. Opaque reference to something specified by the
  5278. application for use in application supplied/specified
  5279. pluggable components.
  5280. </summary>
  5281. </member>
  5282. <member name="M:NVelocity.Runtime.RuntimeInstance.initializeIntrospection">
  5283. <summary>
  5284. Gets the classname for the Uberspect introspection package and
  5285. instantiates an instance.
  5286. </summary>
  5287. </member>
  5288. <member name="M:NVelocity.Runtime.RuntimeInstance.setDefaultProperties">
  5289. <summary>
  5290. Initializes the Velocity Runtime with properties file.
  5291. The properties file may be in the file system proper,
  5292. or the properties file may be in the classpath.
  5293. </summary>
  5294. </member>
  5295. <member name="M:NVelocity.Runtime.RuntimeInstance.SetProperty(System.String,System.Object)">
  5296. <summary>
  5297. Allows an external system to set a property in
  5298. the Velocity Runtime.
  5299. </summary>
  5300. <param name="key">property key </param>
  5301. <param name="value">property value</param>
  5302. </member>
  5303. <member name="M:NVelocity.Runtime.RuntimeInstance.AddProperty(System.String,System.Object)">
  5304. <summary>
  5305. Add a property to the configuration. If it already
  5306. exists then the value stated here will be added
  5307. to the configuration entry.
  5308. <remarks>
  5309. For example, if
  5310. <c>resource.loader = file</c>
  5311. is already present in the configuration and you
  5312. <c>addProperty("resource.loader", "classpath")</c>
  5313. Then you will end up with a <see cref="T:System.Collections.IList"/> like the
  5314. following:
  5315. <c>["file", "classpath"]</c>
  5316. </remarks>
  5317. </summary>
  5318. <param name="key">key</param>
  5319. <param name="value">value</param>
  5320. </member>
  5321. <member name="M:NVelocity.Runtime.RuntimeInstance.ClearProperty(System.String)">
  5322. <summary>
  5323. Clear the values pertaining to a particular
  5324. property.
  5325. </summary>
  5326. <param name="key">key of property to clear</param>
  5327. </member>
  5328. <member name="M:NVelocity.Runtime.RuntimeInstance.GetProperty(System.String)">
  5329. <summary>
  5330. Allows an external caller to get a property.
  5331. <remarks>
  5332. The calling routine is required to know the type, as this routine
  5333. will return an Object, as that is what properties can be.
  5334. </remarks>
  5335. </summary>
  5336. <param name="key">property to return</param>
  5337. </member>
  5338. <member name="M:NVelocity.Runtime.RuntimeInstance.initializeProperties">
  5339. <summary>
  5340. Initialize Velocity properties, if the default
  5341. properties have not been laid down first then
  5342. do so. Then proceed to process any overriding
  5343. properties. Laying down the default properties
  5344. gives a much greater chance of having a
  5345. working system.
  5346. </summary>
  5347. </member>
  5348. <member name="M:NVelocity.Runtime.RuntimeInstance.Init(Commons.Collections.ExtendedProperties)">
  5349. <summary>
  5350. Initialize the Velocity Runtime with a Properties
  5351. object.
  5352. </summary>
  5353. <param name="p">Properties</param>
  5354. </member>
  5355. <member name="M:NVelocity.Runtime.RuntimeInstance.Init(System.String)">
  5356. <summary>
  5357. Initialize the Velocity Runtime with the name of
  5358. ExtendedProperties object.
  5359. </summary>
  5360. <param name="configurationFile">Properties</param>
  5361. </member>
  5362. <member name="M:NVelocity.Runtime.RuntimeInstance.initializeLogger">
  5363. <summary> Initialize the Velocity logging system.
  5364. *
  5365. @throws Exception
  5366. </summary>
  5367. </member>
  5368. <member name="M:NVelocity.Runtime.RuntimeInstance.initializeDirectives">
  5369. <summary> This methods initializes all the directives
  5370. that are used by the Velocity Runtime. The
  5371. directives to be initialized are listed in
  5372. the RUNTIME_DEFAULT_DIRECTIVES properties
  5373. file.
  5374. @throws Exception
  5375. </summary>
  5376. </member>
  5377. <member name="M:NVelocity.Runtime.RuntimeInstance.initializeParserPool">
  5378. <summary> Initializes the Velocity parser pool.
  5379. This still needs to be implemented.
  5380. </summary>
  5381. </member>
  5382. <member name="M:NVelocity.Runtime.RuntimeInstance.CreateNewParser">
  5383. <summary> Returns a JavaCC generated Parser.
  5384. </summary>
  5385. <returns>Parser javacc generated parser
  5386. </returns>
  5387. </member>
  5388. <member name="M:NVelocity.Runtime.RuntimeInstance.Parse(System.IO.TextReader,System.String)">
  5389. <summary>
  5390. Parse the input and return the root of
  5391. AST node structure.
  5392. <remarks>
  5393. In the event that it runs out of parsers in the
  5394. pool, it will create and let them be GC'd
  5395. dynamically, logging that it has to do that. This
  5396. is considered an exceptional condition. It is
  5397. expected that the user will set the
  5398. <c>PARSER_POOL_SIZE</c> property appropriately for their
  5399. application. We will revisit this.
  5400. </remarks>
  5401. </summary>
  5402. <param name="reader">inputstream retrieved by a resource loader</param>
  5403. <param name="templateName">name of the template being parsed</param>
  5404. </member>
  5405. <member name="M:NVelocity.Runtime.RuntimeInstance.Parse(System.IO.TextReader,System.String,System.Boolean)">
  5406. <summary>
  5407. Parse the input and return the root of the AST node structure.
  5408. </summary>
  5409. <param name="reader">inputstream retrieved by a resource loader</param>
  5410. <param name="templateName">name of the template being parsed</param>
  5411. <param name="dumpNamespace">flag to dump the Velocimacro namespace for this template</param>
  5412. </member>
  5413. <member name="M:NVelocity.Runtime.RuntimeInstance.GetTemplate(System.String)">
  5414. <summary>
  5415. Returns a <code>Template</code> from the resource manager.
  5416. This method assumes that the character encoding of the
  5417. template is set by the <code>input.encoding</code>
  5418. property. The default is "ISO-8859-1"
  5419. </summary>
  5420. <param name="name">The file name of the desired template.
  5421. </param>
  5422. <returns>The template.</returns>
  5423. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  5424. if template not found from any available source
  5425. </exception>
  5426. <exception cref="T:NVelocity.Exception.ParseErrorException">
  5427. if template cannot be parsed due to syntax (or other) error.
  5428. </exception>
  5429. <exception cref="N:NVelocity.Runtime.Exception">
  5430. if an error occurs in template initialization
  5431. </exception>
  5432. </member>
  5433. <member name="M:NVelocity.Runtime.RuntimeInstance.GetTemplate(System.String,System.String)">
  5434. <summary>
  5435. Returns a <code>Template</code> from the resource manager
  5436. </summary>
  5437. <param name="name">The name of the desired template.</param>
  5438. <param name="encoding">Character encoding of the template</param>
  5439. <returns>The template.</returns>
  5440. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  5441. if template not found from any available source.
  5442. </exception>
  5443. <exception cref="T:NVelocity.Exception.ParseErrorException">
  5444. if template cannot be parsed due to syntax (or other) error.
  5445. </exception>
  5446. <exception cref="N:NVelocity.Runtime.Exception">
  5447. if an error occurs in template initialization
  5448. </exception>
  5449. </member>
  5450. <member name="M:NVelocity.Runtime.RuntimeInstance.GetContent(System.String)">
  5451. <summary>
  5452. Returns a static content resource from the
  5453. resource manager. Uses the current value
  5454. if <c>INPUT_ENCODING</c> as the character encoding.
  5455. </summary>
  5456. <param name="name">Name of content resource to get</param>
  5457. <returns>ContentResource object ready for use</returns>
  5458. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  5459. if template not found from any available source.
  5460. </exception>
  5461. </member>
  5462. <member name="M:NVelocity.Runtime.RuntimeInstance.GetContent(System.String,System.String)">
  5463. <summary>
  5464. Returns a static content resource from the
  5465. resource manager.
  5466. </summary>
  5467. <param name="name">Name of content resource to get</param>
  5468. <param name="encoding">Character encoding to use</param>
  5469. <returns>ContentResource object ready for use</returns>
  5470. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  5471. if template not found from any available source.
  5472. </exception>
  5473. </member>
  5474. <member name="M:NVelocity.Runtime.RuntimeInstance.GetLoaderNameForResource(System.String)">
  5475. <summary>
  5476. Determines is a template exists, and returns name of the loader that
  5477. provides it. This is a slightly less hokey way to support
  5478. the <c>Velocity.templateExists()</c> utility method, which was broken
  5479. when per-template encoding was introduced. We can revisit this.
  5480. </summary>
  5481. <param name="resourceName">Name of template or content resource</param>
  5482. <returns>class name of loader than can provide it</returns>
  5483. </member>
  5484. <member name="M:NVelocity.Runtime.RuntimeInstance.showStackTrace">
  5485. <summary>
  5486. Added this to check and make sure that the configuration
  5487. is initialized before trying to get properties from it.
  5488. This occurs when there are errors during initialization
  5489. and the default properties have yet to be layed down.
  5490. </summary>
  5491. </member>
  5492. <member name="M:NVelocity.Runtime.RuntimeInstance.Log(NVelocity.Runtime.Log.LogLevel,System.Object)">
  5493. <summary>
  5494. Handle logging.
  5495. </summary>
  5496. <param name="level">log level</param>
  5497. <param name="message">message to log</param>
  5498. </member>
  5499. <member name="M:NVelocity.Runtime.RuntimeInstance.Warn(System.Object)">
  5500. <summary>
  5501. Log a warning message.
  5502. </summary>
  5503. <param name="message">message to log</param>
  5504. </member>
  5505. <member name="M:NVelocity.Runtime.RuntimeInstance.Info(System.Object)">
  5506. <summary>
  5507. Log an info message.
  5508. </summary>
  5509. <param name="message">message to log</param>
  5510. </member>
  5511. <member name="M:NVelocity.Runtime.RuntimeInstance.Error(System.Object)">
  5512. <summary>
  5513. Log an error message.
  5514. </summary>
  5515. <param name="message">message to log</param>
  5516. </member>
  5517. <member name="M:NVelocity.Runtime.RuntimeInstance.Debug(System.Object)">
  5518. <summary>
  5519. Log a debug message.
  5520. </summary>
  5521. <param name="message">message to log</param>
  5522. </member>
  5523. <member name="M:NVelocity.Runtime.RuntimeInstance.GetString(System.String,System.String)">
  5524. <summary>
  5525. String property accessor method with default to hide the
  5526. configuration implementation.
  5527. </summary>
  5528. <param name="key">key property key</param>
  5529. <param name="defaultValue">default value to return if key not found in resource manager.</param>
  5530. <returns>String value of key or default</returns>
  5531. </member>
  5532. <member name="M:NVelocity.Runtime.RuntimeInstance.GetVelocimacro(System.String,System.String)">
  5533. <summary>
  5534. Returns the appropriate VelocimacroProxy object if strVMname
  5535. is a valid current Velocimacro.
  5536. </summary>
  5537. <param name="vmName">Name of velocimacro requested</param>
  5538. <param name="templateName">Name of template</param>
  5539. <returns>VelocimacroProxy</returns>
  5540. </member>
  5541. <member name="M:NVelocity.Runtime.RuntimeInstance.AddVelocimacro(System.String,System.String,System.String[],System.String)">
  5542. <summary>
  5543. Adds a new Velocimacro. Usually called by Macro only while parsing.
  5544. </summary>
  5545. <param name="name">Name of velocimacro</param>
  5546. <param name="macro">String form of macro body</param>
  5547. <param name="argArray">Array of strings, containing the #macro() arguments. the 0th is the name.</param>
  5548. <param name="sourceTemplate">Name of template</param>
  5549. <returns>
  5550. True if added, false if rejected for some
  5551. reason (either parameters or permission settings)
  5552. </returns>
  5553. </member>
  5554. <member name="M:NVelocity.Runtime.RuntimeInstance.IsVelocimacro(System.String,System.String)">
  5555. <summary>
  5556. Checks to see if a VM exists
  5557. </summary>
  5558. <param name="vmName">Name of velocimacro</param>
  5559. <param name="templateName">Name of template</param>
  5560. <returns>
  5561. True if VM by that name exists, false if not
  5562. </returns>
  5563. </member>
  5564. <member name="M:NVelocity.Runtime.RuntimeInstance.DumpVMNamespace(System.String)">
  5565. <summary>
  5566. Tells the vmFactory to dump the specified namespace.
  5567. This is to support clearing the VM list when in
  5568. <c>inline-VM-local-scope</c> mode.
  5569. </summary>
  5570. </member>
  5571. <member name="M:NVelocity.Runtime.RuntimeInstance.GetString(System.String)">
  5572. <summary>
  5573. String property accessor method to hide the configuration implementation
  5574. </summary>
  5575. <param name="key">property key</param>
  5576. <returns>value of key or null</returns>
  5577. </member>
  5578. <member name="M:NVelocity.Runtime.RuntimeInstance.GetInt(System.String)">
  5579. <summary>
  5580. Int property accessor method to hide the configuration implementation.
  5581. </summary>
  5582. <param name="key">property key</param>
  5583. <returns>value</returns>
  5584. </member>
  5585. <member name="M:NVelocity.Runtime.RuntimeInstance.GetInt(System.String,System.Int32)">
  5586. <summary>
  5587. Int property accessor method to hide the configuration implementation.
  5588. </summary>
  5589. <param name="key">property key</param>
  5590. <param name="defaultValue">default value</param>
  5591. <returns>value</returns>
  5592. </member>
  5593. <member name="M:NVelocity.Runtime.RuntimeInstance.GetBoolean(System.String,System.Boolean)">
  5594. <summary>
  5595. Boolean property accessor method to hide the configuration implementation.
  5596. </summary>
  5597. <param name="key">property key</param>
  5598. <param name="def">default value if property not found</param>
  5599. <returns>boolean value of key or default value</returns>
  5600. </member>
  5601. <member name="M:NVelocity.Runtime.RuntimeInstance.GetApplicationAttribute(System.Object)">
  5602. <summary>
  5603. Return the velocity runtime configuration object.
  5604. </summary>
  5605. <returns>
  5606. ExtendedProperties configuration object which houses
  5607. the velocity runtime properties.
  5608. </returns>
  5609. </member>
  5610. <member name="P:NVelocity.Runtime.RuntimeInstance.Uberspect">
  5611. <summary>
  5612. Return the Introspector for this instance
  5613. </summary>
  5614. </member>
  5615. <member name="T:NVelocity.Runtime.RuntimeSingleton">
  5616. <summary>
  5617. This is the Runtime system for Velocity. It is the
  5618. single access point for all functionality in Velocity.
  5619. It adheres to the mediator pattern and is the only
  5620. structure that developers need to be familiar with
  5621. in order to get Velocity to perform.
  5622. The Runtime will also cooperate with external
  5623. systems like Turbine. Runtime properties can
  5624. set and then the Runtime is initialized.
  5625. Turbine for example knows where the templates
  5626. are to be loaded from, and where the velocity
  5627. log file should be placed.
  5628. So in the case of Velocity cooperating with Turbine
  5629. the code might look something like the following:
  5630. <pre>
  5631. RuntimeSingleton.setProperty(RuntimeConstants.FILE_RESOURCE_LOADER_PATH, templatePath);
  5632. RuntimeSingleton.setProperty(RuntimeConstants.RUNTIME_LOG, pathToVelocityLog);
  5633. RuntimeSingleton.init();
  5634. </pre>
  5635. <pre>
  5636. -----------------------------------------------------------------------
  5637. N O T E S O N R U N T I M E I N I T I A L I Z A T I O N
  5638. -----------------------------------------------------------------------
  5639. RuntimeSingleton.init()
  5640. If Runtime.init() is called by itself the Runtime will
  5641. initialize with a set of default values.
  5642. -----------------------------------------------------------------------
  5643. RuntimeSingleton.init(String/Properties)
  5644. In this case the default velocity properties are layed down
  5645. first to provide a solid base, then any properties provided
  5646. in the given properties object will override the corresponding
  5647. default property.
  5648. -----------------------------------------------------------------------
  5649. </pre>
  5650. </summary>
  5651. <author><a href="mailto:jvanzyl@apache.org">Jason van Zyl</a></author>
  5652. <author><a href="mailto:jlb@houseofdistraction.com">Jeff Bowden</a></author>
  5653. <author><a href="mailto:geirm@optonline.net">Geir Magusson Jr.</a></author>
  5654. <author><a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a></author>
  5655. <version> $Id: RuntimeSingleton.cs,v 1.5 2004/12/27 05:59:46 corts Exp $
  5656. </version>
  5657. </member>
  5658. <member name="M:NVelocity.Runtime.RuntimeSingleton.Init">
  5659. <summary>
  5660. This is the primary initialization method in the Velocity
  5661. Runtime. The systems that are setup/initialized here are
  5662. as follows:
  5663. <list type="">
  5664. <item>Logging System</item>
  5665. <item>ResourceManager</item>
  5666. <item>Parser Pool</item>
  5667. <item>Global Cache</item>
  5668. <item>Static Content Include System</item>
  5669. <item>Velocimacro System</item>
  5670. </list>
  5671. </summary>
  5672. </member>
  5673. <member name="M:NVelocity.Runtime.RuntimeSingleton.SetProperty(System.String,System.Object)">
  5674. <summary>
  5675. Allows an external system to set a property in
  5676. the Velocity Runtime.
  5677. </summary>
  5678. <param name="key">property key</param>
  5679. <param name="value">property value</param>
  5680. </member>
  5681. <member name="M:NVelocity.Runtime.RuntimeSingleton.AddProperty(System.String,System.Object)">
  5682. <summary> Add a property to the configuration. If it already
  5683. exists then the value stated here will be added
  5684. to the configuration entry. For example, if
  5685. <code>resource.loader = file</code>
  5686. is already present in the configuration and you
  5687. <code>addProperty("resource.loader", "classpath")</code>
  5688. Then you will end up with an ArrayList like the
  5689. following:
  5690. ["file", "classpath"]
  5691. </summary>
  5692. <param name="key">key</param>
  5693. <param name="value">value</param>
  5694. </member>
  5695. <member name="M:NVelocity.Runtime.RuntimeSingleton.ClearProperty(System.String)">
  5696. <summary>
  5697. Clear the values pertaining to a particular property.
  5698. </summary>
  5699. <param name="key">key of property to clear</param>
  5700. </member>
  5701. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetProperty(System.String)">
  5702. <summary>
  5703. Allows an external caller to get a property. The calling
  5704. routine is required to know the type, as this routine
  5705. will return an Object, as that is what properties can be.
  5706. </summary>
  5707. <param name="key">property to return</param>
  5708. </member>
  5709. <member name="M:NVelocity.Runtime.RuntimeSingleton.Init(Commons.Collections.ExtendedProperties)">
  5710. <summary>
  5711. Initialize the Velocity Runtime with an ExtendedProperties object.
  5712. </summary>
  5713. <param name="p">Properties</param>
  5714. </member>
  5715. <member name="M:NVelocity.Runtime.RuntimeSingleton.Init(System.String)">
  5716. <summary> Initialize the Velocity Runtime with a configuration file.</summary>
  5717. <param name="configurationFile">configuration file</param>
  5718. </member>
  5719. <member name="M:NVelocity.Runtime.RuntimeSingleton.CreateNewParser">
  5720. <summary>
  5721. Returns a JavaCC generated Parser.
  5722. </summary>
  5723. <returns>Parser javacc generated parser</returns>
  5724. </member>
  5725. <member name="M:NVelocity.Runtime.RuntimeSingleton.Parse(System.IO.TextReader,System.String)">
  5726. <summary> Parse the input and return the root of
  5727. AST node structure.
  5728. </summary>
  5729. <remarks>
  5730. In the event that it runs out of parsers in the
  5731. pool, it will create and let them be GC'd
  5732. dynamically, logging that it has to do that. This
  5733. is considered an exceptional condition. It is
  5734. expected that the user will set the
  5735. PARSER_POOL_SIZE property appropriately for their
  5736. application. We will revisit this.
  5737. </remarks>
  5738. <param name="reader">TextReader retrieved by a resource loader</param>
  5739. <param name="templateName">name of the template being parsed</param>
  5740. </member>
  5741. <member name="M:NVelocity.Runtime.RuntimeSingleton.Parse(System.IO.TextReader,System.String,System.Boolean)">
  5742. <summary>
  5743. Parse the input and return the root of the AST node structure.
  5744. </summary>
  5745. <param name="reader">TextReader retrieved by a resource loader</param>
  5746. <param name="templateName">name of the template being parsed</param>
  5747. <param name="dumpNamespace">flag to dump the Velocimacro namespace for this template</param>
  5748. </member>
  5749. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetTemplate(System.String)">
  5750. <summary> Returns a <code>Template</code> from the resource manager.
  5751. This method assumes that the character encoding of the
  5752. template is set by the <code>input.encoding</code>
  5753. property. The default is "ISO-8859-1"
  5754. *
  5755. </summary>
  5756. <param name="name">The file name of the desired template.
  5757. </param>
  5758. <returns> The template.
  5759. @throws ResourceNotFoundException if template not found
  5760. from any available source.
  5761. @throws ParseErrorException if template cannot be parsed due
  5762. to syntax (or other) error.
  5763. @throws Exception if an error occurs in template initialization
  5764. </returns>
  5765. </member>
  5766. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetTemplate(System.String,System.String)">
  5767. <summary> Returns a <code>Template</code> from the resource manager
  5768. *
  5769. </summary>
  5770. <param name="name">The name of the desired template.
  5771. </param>
  5772. <param name="encoding">Character encoding of the template
  5773. </param>
  5774. <returns> The template.
  5775. @throws ResourceNotFoundException if template not found
  5776. from any available source.
  5777. @throws ParseErrorException if template cannot be parsed due
  5778. to syntax (or other) error.
  5779. @throws Exception if an error occurs in template initialization
  5780. </returns>
  5781. </member>
  5782. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetContent(System.String)">
  5783. <summary> Returns a static content resource from the
  5784. resource manager. Uses the current value
  5785. if INPUT_ENCODING as the character encoding.
  5786. *
  5787. </summary>
  5788. <param name="name">Name of content resource to get
  5789. </param>
  5790. <returns>parsed ContentResource object ready for use
  5791. @throws ResourceNotFoundException if template not found
  5792. from any available source.
  5793. </returns>
  5794. </member>
  5795. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetContent(System.String,System.String)">
  5796. <summary> Returns a static content resource from the
  5797. resource manager.
  5798. *
  5799. </summary>
  5800. <param name="name">Name of content resource to get
  5801. </param>
  5802. <param name="encoding">Character encoding to use
  5803. </param>
  5804. <returns>parsed ContentResource object ready for use
  5805. @throws ResourceNotFoundException if template not found
  5806. from any available source.
  5807. </returns>
  5808. </member>
  5809. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetLoaderNameForResource(System.String)">
  5810. <summary> Determines is a template exists, and returns name of the loader that
  5811. provides it. This is a slightly less hokey way to support
  5812. the Velocity.templateExists() utility method, which was broken
  5813. when per-template encoding was introduced. We can revisit this.
  5814. *
  5815. </summary>
  5816. <param name="resourceName">Name of template or content resource
  5817. </param>
  5818. <returns>class name of loader than can provide it
  5819. </returns>
  5820. </member>
  5821. <member name="M:NVelocity.Runtime.RuntimeSingleton.Warn(System.Object)">
  5822. <summary>
  5823. Log a warning message.
  5824. </summary>
  5825. <param name="message">message to log</param>
  5826. </member>
  5827. <member name="M:NVelocity.Runtime.RuntimeSingleton.Info(System.Object)">
  5828. <summary>
  5829. Log an info message.
  5830. </summary>
  5831. <param name="message">message to log</param>
  5832. </member>
  5833. <member name="M:NVelocity.Runtime.RuntimeSingleton.Error(System.Object)">
  5834. <summary>
  5835. Log an error message.
  5836. </summary>
  5837. <param name="message">message to log</param>
  5838. </member>
  5839. <member name="M:NVelocity.Runtime.RuntimeSingleton.Debug(System.Object)">
  5840. <summary>
  5841. Log a debug message.
  5842. </summary>
  5843. <param name="message">message to log</param>
  5844. </member>
  5845. <member name="M:NVelocity.Runtime.RuntimeSingleton.getString(System.String,System.String)">
  5846. <summary> String property accessor method with default to hide the
  5847. configuration implementation.
  5848. </summary>
  5849. <param name="key">property key
  5850. </param>
  5851. <param name="defaultValue">default value to return if key not
  5852. found in resource manager.
  5853. </param>
  5854. <returns>String value of key or default
  5855. </returns>
  5856. </member>
  5857. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetVelocimacro(System.String,System.String)">
  5858. <summary>
  5859. Returns the appropriate VelocimacroProxy object if vmName
  5860. is a valid current Velocimacro.
  5861. </summary>
  5862. <param name="vmName">Name of velocimacro requested</param>
  5863. <param name="templateName">Template Name</param>
  5864. <returns>VelocimacroProxy</returns>
  5865. </member>
  5866. <member name="M:NVelocity.Runtime.RuntimeSingleton.AddVelocimacro(System.String,System.String,System.String[],System.String)">
  5867. <summary>
  5868. Adds a new Velocimacro. Usually called by Macro only while parsing.
  5869. </summary>
  5870. <param name="name">Name of velocimacro</param>
  5871. <param name="macro">String form of macro body</param>
  5872. <param name="argArray">Array of strings, containing the
  5873. <code>#macro()</code> arguments. The 0th is the name.
  5874. </param>
  5875. <param name="sourceTemplate">Source template</param>
  5876. <returns>True if added, false if rejected for some
  5877. reason (either parameters or permission settings)
  5878. </returns>
  5879. </member>
  5880. <member name="M:NVelocity.Runtime.RuntimeSingleton.IsVelocimacro(System.String,System.String)">
  5881. <summary>
  5882. Checks to see if a VM exists
  5883. </summary>
  5884. <param name="vmName">Name of velocimacro</param>
  5885. <param name="templateName">Template Name</param>
  5886. <returns>True if VM by that name exists, false if not</returns>
  5887. </member>
  5888. <member name="M:NVelocity.Runtime.RuntimeSingleton.DumpVMNamespace(System.String)">
  5889. <summary>
  5890. Tells the vmFactory to dump the specified namespace.
  5891. This is to support clearing the VM list when in
  5892. inline-VM-local-scope mode
  5893. </summary>
  5894. </member>
  5895. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetString(System.String)">
  5896. <summary>
  5897. String property accessor method to hide the configuration implementation.
  5898. </summary>
  5899. <param name="key">property key</param>
  5900. <returns>Value of key or <c>null</c></returns>
  5901. </member>
  5902. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetInt(System.String)">
  5903. <summary>
  5904. Int property accessor method to hide the configuration implementation.
  5905. </summary>
  5906. <param name="key">property key</param>
  5907. <returns>value</returns>
  5908. </member>
  5909. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetInt(System.String,System.Int32)">
  5910. <summary>
  5911. Int property accessor method to hide the configuration implementation.
  5912. </summary>
  5913. <param name="key">property key</param>
  5914. <param name="defaultValue">default value</param>
  5915. <returns>value</returns>
  5916. </member>
  5917. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetBoolean(System.String,System.Boolean)">
  5918. <summary>
  5919. Boolean property accessor method to hide the configuration implementation.
  5920. </summary>
  5921. <param name="key">property key</param>
  5922. <param name="def">default value if property not found</param>
  5923. <returns>value of key or default value</returns>
  5924. </member>
  5925. <member name="M:NVelocity.Runtime.RuntimeSingleton.GetApplicationAttribute(System.Object)">
  5926. <summary>
  5927. <seealso cref="M:NVelocity.Runtime.IRuntimeServices.GetApplicationAttribute(System.Object)"/>
  5928. </summary>
  5929. <param name="key">key</param>
  5930. <returns>value</returns>
  5931. </member>
  5932. <member name="P:NVelocity.Runtime.RuntimeSingleton.Configuration">
  5933. <summary>
  5934. Return the velocity runtime configuration object.
  5935. </summary>
  5936. <returns>
  5937. ExtendedProperties configuration object which houses
  5938. the velocity runtime properties.
  5939. </returns>
  5940. </member>
  5941. <member name="P:NVelocity.Runtime.RuntimeSingleton.Introspector">
  5942. <summary>
  5943. Return the Introspector for this RuntimeInstance
  5944. </summary>
  5945. <returns>
  5946. Introspector object for this runtime instance
  5947. </returns>
  5948. </member>
  5949. <member name="P:NVelocity.Runtime.RuntimeSingleton.RuntimeInstance">
  5950. <summary>
  5951. Returns the RuntimeInstance object for this singleton.
  5952. For internal use only.
  5953. </summary>
  5954. <returns>
  5955. The <see cref="P:NVelocity.Runtime.RuntimeSingleton.RuntimeInstance"/> used by this Singleton instance.
  5956. </returns>
  5957. </member>
  5958. <member name="T:NVelocity.Runtime.VelocimacroFactory">
  5959. <summary> VelocimacroFactory.java
  5960. *
  5961. manages the set of VMs in a running Velocity engine.
  5962. *
  5963. </summary>
  5964. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  5965. </author>
  5966. <version> $Id: VelocimacroFactory.cs,v 1.5 2003/10/27 15:37:24 corts Exp $
  5967. </version>
  5968. </member>
  5969. <member name="F:NVelocity.Runtime.VelocimacroFactory.runtimeServices">
  5970. <summary> runtime services for this instance
  5971. </summary>
  5972. </member>
  5973. <member name="F:NVelocity.Runtime.VelocimacroFactory.velocimacroManager">
  5974. <summary> VMManager : deal with namespace management
  5975. and actually keeps all the VM definitions
  5976. </summary>
  5977. </member>
  5978. <member name="F:NVelocity.Runtime.VelocimacroFactory.replaceAllowed">
  5979. <summary> determines if replacement of global VMs are allowed
  5980. controlled by VM_PERM_ALLOW_INLINE_REPLACE_GLOBAL
  5981. </summary>
  5982. </member>
  5983. <member name="F:NVelocity.Runtime.VelocimacroFactory.addNewAllowed">
  5984. <summary> controls if new VMs can be added. Set by
  5985. VM_PERM_ALLOW_INLINE Note the assumption that only
  5986. through inline defs can this happen.
  5987. additions through auto-loaded VMs is allowed
  5988. </summary>
  5989. </member>
  5990. <member name="F:NVelocity.Runtime.VelocimacroFactory.templateLocal">
  5991. <summary> sets if template-local namespace in used
  5992. </summary>
  5993. </member>
  5994. <member name="F:NVelocity.Runtime.VelocimacroFactory.blather">
  5995. <summary> controls log output
  5996. </summary>
  5997. </member>
  5998. <member name="F:NVelocity.Runtime.VelocimacroFactory.autoReloadLibrary">
  5999. <summary> determines if the libraries are auto-loaded
  6000. when they change
  6001. </summary>
  6002. </member>
  6003. <member name="F:NVelocity.Runtime.VelocimacroFactory.macroLibVec">
  6004. <summary> vector of the library names
  6005. </summary>
  6006. </member>
  6007. <member name="F:NVelocity.Runtime.VelocimacroFactory.libModMap">
  6008. <summary> map of the library Template objects
  6009. used for reload determination
  6010. </summary>
  6011. </member>
  6012. <member name="M:NVelocity.Runtime.VelocimacroFactory.#ctor(NVelocity.Runtime.IRuntimeServices)">
  6013. <summary> CTOR : requires a runtime services from now
  6014. on
  6015. </summary>
  6016. </member>
  6017. <member name="M:NVelocity.Runtime.VelocimacroFactory.InitVelocimacro">
  6018. <summary> initialize the factory - setup all permissions
  6019. load all global libraries.
  6020. </summary>
  6021. </member>
  6022. <member name="M:NVelocity.Runtime.VelocimacroFactory.AddVelocimacro(System.String,System.String,System.String[],System.String)">
  6023. <summary> adds a macro to the factory.
  6024. </summary>
  6025. </member>
  6026. <member name="M:NVelocity.Runtime.VelocimacroFactory.CanAddVelocimacro(System.String,System.String)">
  6027. <summary> determines if a given macro/namespace (name, source) combo is allowed
  6028. to be added
  6029. *
  6030. </summary>
  6031. <param name="name">Name of VM to add
  6032. </param>
  6033. <param name="sourceTemplate">Source template that contains the definition of the VM
  6034. </param>
  6035. <returns>true if it is allowed to be added, false otherwise
  6036. </returns>
  6037. </member>
  6038. <member name="M:NVelocity.Runtime.VelocimacroFactory.LogVMMessageInfo(System.String)">
  6039. <summary> localization of the logging logic
  6040. </summary>
  6041. </member>
  6042. <member name="M:NVelocity.Runtime.VelocimacroFactory.LogVMMessageWarn(System.String)">
  6043. <summary> localization of the logging logic
  6044. </summary>
  6045. </member>
  6046. <member name="M:NVelocity.Runtime.VelocimacroFactory.IsVelocimacro(System.String,System.String)">
  6047. <summary> Tells the world if a given directive string is a Velocimacro
  6048. </summary>
  6049. </member>
  6050. <member name="M:NVelocity.Runtime.VelocimacroFactory.GetVelocimacro(System.String,System.String)">
  6051. <summary> actual factory : creates a Directive that will
  6052. behave correctly wrt getting the framework to
  6053. dig out the correct # of args
  6054. </summary>
  6055. </member>
  6056. <member name="M:NVelocity.Runtime.VelocimacroFactory.DumpVMNamespace(System.String)">
  6057. <summary> tells the velocimacroManager to dump the specified namespace
  6058. </summary>
  6059. </member>
  6060. <member name="T:NVelocity.Runtime.VelocimacroFactory.Twonk">
  6061. <summary> sets permission to have VMs local in scope to their declaring template
  6062. note that this is really taken care of in the VMManager class, but
  6063. we need it here for gating purposes in addVM
  6064. eventually, I will slide this all into the manager, maybe.
  6065. </summary>
  6066. <summary> sets the permission to add new macros
  6067. </summary>
  6068. <summary> sets the permission for allowing addMacro() calls to
  6069. replace existing VM's
  6070. </summary>
  6071. <summary> set output message mode
  6072. </summary>
  6073. <summary> get output message mode
  6074. </summary>
  6075. <summary> set the switch for automatic reloading of
  6076. global library-based VMs
  6077. </summary>
  6078. <summary> get the switch for automatic reloading of
  6079. global library-based VMs
  6080. </summary>
  6081. <summary> small container class to hold the duple
  6082. of a template and modification time.
  6083. We keep the modification time so we can
  6084. 'override' it on a reload to prevent
  6085. recursive reload due to inter-calling
  6086. VMs in a library
  6087. </summary>
  6088. </member>
  6089. <member name="T:NVelocity.Runtime.VelocimacroManager">
  6090. <summary>
  6091. Manages VMs in namespaces. Currently, two namespace modes are
  6092. supported:
  6093. *
  6094. <ul>
  6095. <li>flat - all allowable VMs are in the global namespace</li>
  6096. <li>local - inline VMs are added to it's own template namespace</li>
  6097. </ul>
  6098. *
  6099. Thanks to <a href="mailto:JFernandez@viquity.com">Jose Alberto Fernandez</a>
  6100. for some ideas incorporated here.
  6101. *
  6102. </summary>
  6103. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  6104. </author>
  6105. <author> <a href="mailto:JFernandez@viquity.com">Jose Alberto Fernandez</a>
  6106. </author>
  6107. </member>
  6108. <member name="F:NVelocity.Runtime.VelocimacroManager.namespaceHash">
  6109. <summary>Hash of namespace hashes.
  6110. </summary>
  6111. </member>
  6112. <member name="F:NVelocity.Runtime.VelocimacroManager.libraryMap">
  6113. <summary>map of names of library templates/namespaces</summary>
  6114. </member>
  6115. <member name="M:NVelocity.Runtime.VelocimacroManager.#ctor(NVelocity.Runtime.IRuntimeServices)">
  6116. <summary> Adds the global namespace to the hash.</summary>
  6117. </member>
  6118. <member name="M:NVelocity.Runtime.VelocimacroManager.AddVM(System.String,System.String,System.String[],System.String)">
  6119. <summary> Adds a VM definition to the cache.
  6120. </summary>
  6121. <returns>Whether everything went okay.
  6122. </returns>
  6123. </member>
  6124. <member name="M:NVelocity.Runtime.VelocimacroManager.get(System.String,System.String)">
  6125. <summary> gets a new living VelocimacroProxy object by the
  6126. name / source template duple
  6127. </summary>
  6128. </member>
  6129. <member name="M:NVelocity.Runtime.VelocimacroManager.DumpNamespace(System.String)">
  6130. <summary> Removes the VMs and the namespace from the manager.
  6131. Used when a template is reloaded to avoid
  6132. accumulating drek
  6133. </summary>
  6134. <param name="ns">namespace to dump
  6135. </param>
  6136. <returns>boolean representing success
  6137. </returns>
  6138. </member>
  6139. <member name="M:NVelocity.Runtime.VelocimacroManager.GetNamespace(System.String)">
  6140. <summary>
  6141. public switch to let external user of manager to control namespace
  6142. usage indep of properties. That way, for example, at startup the
  6143. library files are loaded into global namespace
  6144. returns the hash for the specified namespace. Will not create a new one
  6145. if it doesn't exist
  6146. </summary>
  6147. <param name="ns"> name of the namespace :) </param>
  6148. <returns>namespace Hashtable of VMs or null if doesn't exist </returns>
  6149. </member>
  6150. <member name="M:NVelocity.Runtime.VelocimacroManager.GetNamespace(System.String,System.Boolean)">
  6151. <summary>
  6152. returns the hash for the specified namespace, and if it doesn't exist
  6153. will create a new one and add it to the namespaces
  6154. </summary>
  6155. <param name="ns"> name of the namespace :)</param>
  6156. <param name="addIfNew"> flag to add a new namespace if it doesn't exist</param>
  6157. <returns>namespace Hashtable of VMs or null if doesn't exist</returns>
  6158. </member>
  6159. <member name="M:NVelocity.Runtime.VelocimacroManager.AddNamespace(System.String)">
  6160. <summary>adds a namespace to the namespaces</summary>
  6161. <param name="ns">name of namespace to add</param>
  6162. <returns>Hash added to namespaces, ready for use</returns>
  6163. </member>
  6164. <member name="M:NVelocity.Runtime.VelocimacroManager.UsingNamespaces(System.String)">
  6165. <summary>determines if currently using namespaces.</summary>
  6166. <param name="ns">currently ignored</param>
  6167. <returns>true if using namespaces, false if not</returns>
  6168. </member>
  6169. <member name="T:NVelocity.Runtime.VelocimacroManager.MacroEntry">
  6170. <summary> wrapper class for holding VM information
  6171. </summary>
  6172. </member>
  6173. <member name="T:NVelocity.Tool.DataInfo">
  6174. <summary> ToolInfo implementation to handle "primitive" data types.
  6175. It currently supports String, Number, and Boolean data.
  6176. *
  6177. </summary>
  6178. <author> <a href="mailto:nathan@esha.com">Nathan Bubna</a>
  6179. *
  6180. </author>
  6181. <version> $Id: DataInfo.cs,v 1.2 2003/10/27 13:54:12 corts Exp $
  6182. </version>
  6183. </member>
  6184. <member name="T:NVelocity.Tool.IToolInfo">
  6185. <summary> Interface to simplify and abstract tool handling.
  6186. *
  6187. Implementations of this class should hold both the context
  6188. key for the tool and sufficient information to return
  6189. an instance of the tool.
  6190. *
  6191. </summary>
  6192. <author> <a href="mailto:nathan@esha.com">Nathan Bubna</a>
  6193. *
  6194. </author>
  6195. <version> $Id: IToolInfo.cs,v 1.2 2003/10/27 13:54:12 corts Exp $
  6196. </version>
  6197. </member>
  6198. <member name="M:NVelocity.Tool.IToolInfo.getInstance(System.Object)">
  6199. <returns>the context key for the tool
  6200. </returns>
  6201. <returns>the fully qualified classname for the tool
  6202. </returns>
  6203. <summary> Returns an instance of the tool.
  6204. *
  6205. Instances returned may be new on each call, pooled, or
  6206. the be same instance every time depending on the
  6207. implementation. The object passed to this method may
  6208. be used to initialize or create the tool that is returned,
  6209. or it may be null if no such data is required.
  6210. *
  6211. </summary>
  6212. <param name="initData">an object that may be used to initialize the instance
  6213. </param>
  6214. <returns>an instance of the tool
  6215. </returns>
  6216. </member>
  6217. <member name="M:NVelocity.Tool.DataInfo.#ctor(System.String,System.String,System.String)">
  6218. <summary> Parses the value string into a recognized type. If
  6219. the type specified is not supported, the data will
  6220. be held and returned as a string.
  6221. *
  6222. </summary>
  6223. <param name="key">the context key for the data
  6224. </param>
  6225. <param name="type">the data type
  6226. </param>
  6227. <param name="value">the data
  6228. </param>
  6229. </member>
  6230. <member name="M:NVelocity.Tool.DataInfo.getInstance(System.Object)">
  6231. <summary> Returns the data. Always returns the same
  6232. object since the data is a constant. Initialization
  6233. data is ignored.
  6234. </summary>
  6235. </member>
  6236. <member name="T:NVelocity.Tool.ToolLoader">
  6237. <summary>
  6238. <p>A view tool that allows template designers to load
  6239. an arbitrary object into the context. Any object
  6240. with a public constructor without parameters can be used
  6241. as a view tool.</p>
  6242. <p>THIS CLASS IS HERE AS A PROOF OF CONCEPT ONLY. IT IS NOT
  6243. INTENDED FOR USE IN PRODUCTION ENVIRONMENTS. USE AT YOUR OWN RISK.</p>
  6244. </summary>
  6245. <author><a href="mailto:sidler@teamup.com">Gabe Sidler</a></author>
  6246. <author><a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a></author>
  6247. </member>
  6248. <member name="M:NVelocity.Tool.ToolLoader.Load(System.String)">
  6249. <summary>
  6250. Creates and returns an object of the specified classname.
  6251. The object must have a valid default constructor.
  6252. </summary>
  6253. <param name="className">the fully qualified class name of the object</param>
  6254. <returns>an instance of the specified class or null if the class
  6255. could not be instantiated.</returns>
  6256. </member>
  6257. <member name="T:NVelocity.Util.Introspection.AmbiguousException">
  6258. <summary>
  6259. Simple distinguishable exception, used when
  6260. we run across ambiguous overloading
  6261. </summary>
  6262. </member>
  6263. <member name="M:NVelocity.Util.Introspection.AmbiguousException.#ctor(System.String)">
  6264. <summary>
  6265. Initializes a new instance of the <see cref="T:NVelocity.Util.Introspection.AmbiguousException"/> class.
  6266. </summary>
  6267. <param name="message">The message.</param>
  6268. </member>
  6269. <member name="M:NVelocity.Util.Introspection.AmbiguousException.#ctor(System.String,System.Exception)">
  6270. <summary>
  6271. Initializes a new instance of the <see cref="T:NVelocity.Util.Introspection.AmbiguousException"/> class.
  6272. </summary>
  6273. <param name="message">The message.</param>
  6274. <param name="innerException">The inner exception.</param>
  6275. </member>
  6276. <member name="M:NVelocity.Util.Introspection.AmbiguousException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6277. <summary>
  6278. Initializes a new instance of the <see cref="T:NVelocity.Util.Introspection.AmbiguousException"/> class.
  6279. </summary>
  6280. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"></see> that holds the serialized object data about the exception being thrown.</param>
  6281. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"></see> that contains contextual information about the source or destination.</param>
  6282. <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"></see> is zero (0). </exception>
  6283. <exception cref="T:System.ArgumentNullException">The info parameter is null. </exception>
  6284. </member>
  6285. <member name="T:NVelocity.Util.Introspection.ClassMap">
  6286. <summary>
  6287. A cache of introspection information for a specific class instance.
  6288. Keys <see cref="T:System.Reflection.MethodInfo"/> objects by a concatenation of the
  6289. method name and the names of classes that make up the parameters.
  6290. </summary>
  6291. </member>
  6292. <member name="F:NVelocity.Util.Introspection.ClassMap.methodCache">
  6293. <summary> Cache of Methods, or CACHE_MISS, keyed by method
  6294. name and actual arguments used to find it.
  6295. </summary>
  6296. </member>
  6297. <member name="M:NVelocity.Util.Introspection.ClassMap.#ctor(System.Type)">
  6298. <summary> Standard constructor
  6299. </summary>
  6300. </member>
  6301. <member name="M:NVelocity.Util.Introspection.ClassMap.FindMethod(System.String,System.Object[])">
  6302. <summary>
  6303. Find a Method using the methodKey provided.
  6304. Look in the methodMap for an entry. If found,
  6305. it'll either be a CACHE_MISS, in which case we
  6306. simply give up, or it'll be a Method, in which
  6307. case, we return it.
  6308. If nothing is found, then we must actually go
  6309. and introspect the method from the MethodMap.
  6310. </summary>
  6311. <returns>
  6312. the class object whose methods are cached by this map.
  6313. </returns>
  6314. </member>
  6315. <member name="M:NVelocity.Util.Introspection.ClassMap.FindProperty(System.String)">
  6316. <summary>
  6317. Find a Method using the methodKey
  6318. provided.
  6319. Look in the methodMap for an entry. If found,
  6320. it'll either be a CACHE_MISS, in which case we
  6321. simply give up, or it'll be a Method, in which
  6322. case, we return it.
  6323. If nothing is found, then we must actually go
  6324. and introspect the method from the MethodMap.
  6325. </summary>
  6326. </member>
  6327. <member name="M:NVelocity.Util.Introspection.ClassMap.PopulateMethodCache">
  6328. <summary>
  6329. Populate the Map of direct hits. These
  6330. are taken from all the public methods
  6331. that our class provides.
  6332. </summary>
  6333. </member>
  6334. <member name="M:NVelocity.Util.Introspection.ClassMap.MakeMethodKey(System.Reflection.MethodInfo)">
  6335. <summary>
  6336. Make a methodKey for the given method using
  6337. the concatenation of the name and the
  6338. types of the method parameters.
  6339. </summary>
  6340. </member>
  6341. <member name="M:NVelocity.Util.Introspection.ClassMap.GetAccessibleMethods(System.Type)">
  6342. <summary>
  6343. Retrieves public methods for a class.
  6344. </summary>
  6345. </member>
  6346. <member name="P:NVelocity.Util.Introspection.ClassMap.CachedClass">
  6347. <summary>
  6348. Class passed into the constructor used to as
  6349. the basis for the Method map.
  6350. </summary>
  6351. </member>
  6352. <member name="T:NVelocity.Util.Introspection.Info">
  6353. <summary>
  6354. Little class to carry in info such as template name, line and column
  6355. for information error reporting from the uberspector implementations
  6356. *
  6357. </summary>
  6358. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  6359. </author>
  6360. <version> $Id: Info.cs,v 1.1 2004/12/27 05:55:08 corts Exp $
  6361. </version>
  6362. </member>
  6363. <member name="M:NVelocity.Util.Introspection.Info.#ctor(System.String,System.Int32,System.Int32)">
  6364. <param name="source">Usually a template name.
  6365. </param>
  6366. <param name="line">The line number from <code>source</code>.
  6367. </param>
  6368. <param name="column">The column number from <code>source</code>.
  6369. </param>
  6370. </member>
  6371. <member name="M:NVelocity.Util.Introspection.Info.ToString">
  6372. <summary> Formats a textual representation of this object as <code>SOURCE
  6373. [line X, column Y]</code>.
  6374. </summary>
  6375. </member>
  6376. <member name="T:NVelocity.Util.Introspection.IntrospectionCacheData">
  6377. <summary>
  6378. Holds information for node-local context data introspection
  6379. information.
  6380. </summary>
  6381. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  6382. <version> $Id: IntrospectionCacheData.cs,v 1.3 2003/10/27 13:54:12 corts Exp $ </version>
  6383. </member>
  6384. <member name="F:NVelocity.Util.Introspection.IntrospectionCacheData.Thingy">
  6385. <summary>
  6386. Object to pair with class - currently either a Method or
  6387. AbstractExecutor. It can be used in any way the using node
  6388. wishes.
  6389. </summary>
  6390. </member>
  6391. <member name="F:NVelocity.Util.Introspection.IntrospectionCacheData.ContextData">
  6392. <summary>
  6393. Class of context data object associated with the
  6394. introspection information
  6395. </summary>
  6396. </member>
  6397. <member name="T:NVelocity.Util.Introspection.Introspector">
  6398. <summary>
  6399. This basic function of this class is to return a Method
  6400. object for a particular class given the name of a method
  6401. and the parameters to the method in the form of an Object[]
  6402. The first time the Introspector sees a
  6403. class it creates a class method map for the
  6404. class in question. Basically the class method map
  6405. is a Hashtable where Method objects are keyed by a
  6406. concatenation of the method name and the names of
  6407. classes that make up the parameters.
  6408. For example, a method with the following signature:
  6409. public void method(String a, StringBuffer b)
  6410. would be mapped by the key:
  6411. "method" + "java.lang.String" + "java.lang.StringBuffer"
  6412. This mapping is performed for all the methods in a class
  6413. and stored for
  6414. </summary>
  6415. </member>
  6416. <member name="T:NVelocity.Util.Introspection.IntrospectorBase">
  6417. <summary>
  6418. This basic function of this class is to return a Method
  6419. object for a particular class given the name of a method
  6420. and the parameters to the method in the form of an Object[]
  6421. The first time the Introspector sees a
  6422. class it creates a class method map for the
  6423. class in question. Basically the class method map
  6424. is a Hashtable where Method objects are keyed by a
  6425. concatenation of the method name and the names of
  6426. classes that make up the parameters.
  6427. For example, a method with the following signature:
  6428. public void method(String a, StringBuffer b)
  6429. would be mapped by the key:
  6430. "method" + "java.lang.String" + "java.lang.StringBuffer"
  6431. This mapping is performed for all the methods in a class
  6432. and stored for
  6433. </summary>
  6434. <version> $Id: IntrospectorBase.cs,v 1.3 2003/10/27 13:54:12 corts Exp $ </version>
  6435. </member>
  6436. <member name="F:NVelocity.Util.Introspection.IntrospectorBase.classMethodMaps">
  6437. <summary>
  6438. Holds the method maps for the classes we know about, keyed by
  6439. Class object.
  6440. </summary>
  6441. </member>
  6442. <member name="F:NVelocity.Util.Introspection.IntrospectorBase.cachedClassNames">
  6443. <summary>
  6444. Holds the qualified class names for the classes
  6445. we hold in the classMethodMaps hash
  6446. </summary>
  6447. </member>
  6448. <member name="M:NVelocity.Util.Introspection.IntrospectorBase.GetMethod(System.Type,System.String,System.Object[])">
  6449. <summary>
  6450. Gets the method defined by <code>name</code> and
  6451. <code>params</code> for the Class <code>c</code>.
  6452. </summary>
  6453. <param name="c">Class in which the method search is taking place</param>
  6454. <param name="name">Name of the method being searched for</param>
  6455. <param name="parameters">An array of Objects (not Classes) that describe the the parameters</param>
  6456. <returns>The desired <see cref="T:System.Reflection.MethodInfo"/> object.</returns>
  6457. </member>
  6458. <member name="M:NVelocity.Util.Introspection.IntrospectorBase.GetProperty(System.Type,System.String)">
  6459. <summary>
  6460. Gets the method defined by <code>name</code>
  6461. for the Class <code>c</code>.
  6462. </summary>
  6463. <param name="c">Class in which the method search is taking place</param>
  6464. <param name="name">Name of the method being searched for</param>
  6465. <returns>The desired <see cref="T:System.Reflection.PropertyInfo"/> object.</returns>
  6466. </member>
  6467. <member name="M:NVelocity.Util.Introspection.IntrospectorBase.CreateClassMap(System.Type)">
  6468. <summary>
  6469. Creates a class map for specific class and registers it in the
  6470. cache. Also adds the qualified name to the name->class map
  6471. for later Classloader change detection.
  6472. </summary>
  6473. </member>
  6474. <member name="F:NVelocity.Util.Introspection.Introspector.rlog">
  6475. <summary> our engine runtime services
  6476. </summary>
  6477. </member>
  6478. <member name="M:NVelocity.Util.Introspection.Introspector.#ctor(NVelocity.Runtime.IRuntimeLogger)">
  6479. <summary> Receives our RuntimeServices object
  6480. </summary>
  6481. </member>
  6482. <member name="M:NVelocity.Util.Introspection.Introspector.GetMethod(System.Type,System.String,System.Object[])">
  6483. <summary>
  6484. Gets the method defined by <code>name</code> and
  6485. <code>params</code> for the Class <code>c</code>.
  6486. </summary>
  6487. <param name="c">Class in which the method search is taking place</param>
  6488. <param name="name">Name of the method being searched for</param>
  6489. <param name="parameters">An array of Objects (not Classes) that describe the the parameters</param>
  6490. <returns>The desired Method object.</returns>
  6491. </member>
  6492. <member name="M:NVelocity.Util.Introspection.Introspector.GetProperty(System.Type,System.String)">
  6493. <summary>
  6494. Gets the method defined by <code>name</code>
  6495. for the Class <code>c</code>.
  6496. </summary>
  6497. <param name="c">Class in which the method search is taking place</param>
  6498. <param name="name">Name of the method being searched for</param>
  6499. <returns>The desired <see cref="T:System.Reflection.PropertyInfo"/> object.</returns>
  6500. </member>
  6501. <member name="T:NVelocity.Util.Introspection.IUberspect">
  6502. <summary> 'Federated' introspection/reflection interface to allow the introspection
  6503. behavior in Velocity to be customized.
  6504. *
  6505. </summary>
  6506. <author> <a href="mailto:geirm@apache.org">Geir Magusson Jr.</a>
  6507. </author>
  6508. <version> $Id: Uberspect.cs,v 1.1 2004/12/27 05:55:08 corts Exp $
  6509. </version>
  6510. </member>
  6511. <member name="M:NVelocity.Util.Introspection.IUberspect.Init">
  6512. <summary> Initializer - will be called before use
  6513. </summary>
  6514. </member>
  6515. <member name="M:NVelocity.Util.Introspection.IUberspect.GetMethod(System.Object,System.String,System.Object[],NVelocity.Util.Introspection.Info)">
  6516. <summary> Returns a general method, corresponding to $foo.bar( $woogie )
  6517. </summary>
  6518. </member>
  6519. <member name="M:NVelocity.Util.Introspection.IUberspect.GetPropertyGet(System.Object,System.String,NVelocity.Util.Introspection.Info)">
  6520. <summary> Property getter - returns VelPropertyGet appropos for #set($foo = $bar.woogie)
  6521. </summary>
  6522. </member>
  6523. <member name="M:NVelocity.Util.Introspection.IUberspect.GetPropertySet(System.Object,System.String,System.Object,NVelocity.Util.Introspection.Info)">
  6524. <summary> Property setter - returns VelPropertySet appropos for #set($foo.bar = "geir")
  6525. </summary>
  6526. </member>
  6527. <member name="T:NVelocity.Util.Introspection.IVelMethod">
  6528. <summary> Method used for regular method invocation
  6529. *
  6530. $foo.bar()
  6531. *
  6532. *
  6533. </summary>
  6534. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  6535. </author>
  6536. <version> $Id: VelMethod.cs,v 1.1 2004/12/27 05:55:08 corts Exp $
  6537. </version>
  6538. </member>
  6539. <member name="M:NVelocity.Util.Introspection.IVelMethod.Invoke(System.Object,System.Object[])">
  6540. <summary> invocation method - called when the method invocation should be
  6541. performed and a value returned
  6542. </summary>
  6543. </member>
  6544. <member name="P:NVelocity.Util.Introspection.IVelMethod.Cacheable">
  6545. <summary> specifies if this VelMethod is cacheable and able to be
  6546. reused for this class of object it was returned for
  6547. *
  6548. </summary>
  6549. <returns> true if can be reused for this class, false if not
  6550. </returns>
  6551. </member>
  6552. <member name="P:NVelocity.Util.Introspection.IVelMethod.MethodName">
  6553. <summary> returns the method name used
  6554. </summary>
  6555. </member>
  6556. <member name="P:NVelocity.Util.Introspection.IVelMethod.ReturnType">
  6557. <summary> returns the return type of the method invoked
  6558. </summary>
  6559. </member>
  6560. <member name="T:NVelocity.Util.Introspection.IVelPropertyGet">
  6561. <summary>
  6562. Interface defining a 'getter'. For uses when looking for resolution of
  6563. property references
  6564. <code>
  6565. $foo.bar
  6566. </code>
  6567. </summary>
  6568. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a> </author>
  6569. <version> $Id: VelPropertyGet.cs,v 1.1 2004/12/27 05:55:08 corts Exp $ </version>
  6570. </member>
  6571. <member name="M:NVelocity.Util.Introspection.IVelPropertyGet.Invoke(System.Object)">
  6572. <summary>
  6573. invocation method - called when the 'get action' should be
  6574. performed and a value returned
  6575. </summary>
  6576. </member>
  6577. <member name="P:NVelocity.Util.Introspection.IVelPropertyGet.Cacheable">
  6578. <summary>
  6579. specifies if this VelPropertyGet is cacheable and able to be
  6580. reused for this class of object it was returned for
  6581. </summary>
  6582. <returns>true if can be reused for this class, false if not</returns>
  6583. </member>
  6584. <member name="P:NVelocity.Util.Introspection.IVelPropertyGet.MethodName">
  6585. <summary>
  6586. returns the method name used to return this 'property'
  6587. </summary>
  6588. </member>
  6589. <member name="T:NVelocity.Util.Introspection.IVelPropertySet">
  6590. <summary> Interface used for setting values that appear to be properties in
  6591. Velocity. Ex.
  6592. *
  6593. #set($foo.bar = "hello")
  6594. *
  6595. </summary>
  6596. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  6597. </author>
  6598. <version> $Id: VelPropertySet.cs,v 1.1 2004/12/27 05:55:08 corts Exp $
  6599. </version>
  6600. </member>
  6601. <member name="M:NVelocity.Util.Introspection.IVelPropertySet.Invoke(System.Object,System.Object)">
  6602. <summary> method used to set the value in the object
  6603. *
  6604. </summary>
  6605. <param name="o">Object on which the method will be called with the arg
  6606. </param>
  6607. <param name="arg">value to be set
  6608. </param>
  6609. <returns> the value returned from the set operation (impl specific)
  6610. </returns>
  6611. </member>
  6612. <member name="P:NVelocity.Util.Introspection.IVelPropertySet.Cacheable">
  6613. <summary> specifies if this VelPropertySet is cacheable and able to be
  6614. reused for this class of object it was returned for
  6615. *
  6616. </summary>
  6617. <returns> true if can be reused for this class, false if not
  6618. </returns>
  6619. </member>
  6620. <member name="P:NVelocity.Util.Introspection.IVelPropertySet.MethodName">
  6621. <summary> returns the method name used to set this 'property'
  6622. </summary>
  6623. </member>
  6624. <member name="F:NVelocity.Util.Introspection.MethodMap.methodByNameMap">
  6625. <summary> Keep track of all methods with the same name.</summary>
  6626. </member>
  6627. <member name="M:NVelocity.Util.Introspection.MethodMap.Add(System.Reflection.MethodInfo)">
  6628. <summary> Add a method to a list of methods by name.
  6629. For a particular class we are keeping track
  6630. of all the methods with the same name.
  6631. </summary>
  6632. </member>
  6633. <member name="M:NVelocity.Util.Introspection.MethodMap.Get(System.String)">
  6634. <summary>
  6635. Return a list of methods with the same name.
  6636. </summary>
  6637. <param name="key">key</param>
  6638. <returns> List list of methods</returns>
  6639. </member>
  6640. <member name="M:NVelocity.Util.Introspection.MethodMap.Find(System.String,System.Object[])">
  6641. <summary>
  6642. Find a method. Attempts to find the
  6643. most specific applicable method using the
  6644. algorithm described in the JLS section
  6645. 15.12.2 (with the exception that it can't
  6646. distinguish a primitive type argument from
  6647. an object type argument, since in reflection
  6648. primitive type arguments are represented by
  6649. their object counterparts, so for an argument of
  6650. type (say) java.lang.Integer, it will not be able
  6651. to decide between a method that takes int and a
  6652. method that takes java.lang.Integer as a parameter.
  6653. <para>
  6654. This turns out to be a relatively rare case
  6655. where this is needed - however, functionality
  6656. like this is needed.
  6657. </para>
  6658. </summary>
  6659. <param name="methodName">name of method</param>
  6660. <param name="args">the actual arguments with which the method is called</param>
  6661. <returns> the most specific applicable method, or null if no method is applicable.</returns>
  6662. <exception cref="T:NVelocity.Util.Introspection.AmbiguousException">if there is more than one maximally specific applicable method</exception>
  6663. </member>
  6664. <member name="M:NVelocity.Util.Introspection.MethodMap.IsMoreSpecific(System.Reflection.ParameterInfo[],System.Reflection.ParameterInfo[])">
  6665. <summary> Determines which method signature (represented by a class array) is more
  6666. specific. This defines a partial ordering on the method signatures.
  6667. </summary>
  6668. <param name="c1">first signature to compare
  6669. </param>
  6670. <param name="c2">second signature to compare
  6671. </param>
  6672. <returns> MORE_SPECIFIC if c1 is more specific than c2, LESS_SPECIFIC if
  6673. c1 is less specific than c2, INCOMPARABLE if they are incomparable.
  6674. </returns>
  6675. </member>
  6676. <member name="M:NVelocity.Util.Introspection.MethodMap.GetApplicables(System.Collections.IList,System.Type[])">
  6677. <summary>
  6678. Returns all methods that are applicable to actual argument types.
  6679. </summary>
  6680. <param name="methods">list of all candidate methods</param>
  6681. <param name="classes">the actual types of the arguments</param>
  6682. <returns>
  6683. a list that contains only applicable methods (number of
  6684. formal and actual arguments matches, and argument types are assignable
  6685. to formal types through a method invocation conversion).
  6686. </returns>
  6687. TODO: this used to return a LinkedList -- changed to an ArrayList for now until I can figure out what is really needed
  6688. </member>
  6689. <member name="M:NVelocity.Util.Introspection.MethodMap.IsApplicable(System.Reflection.MethodInfo,System.Type[])">
  6690. <summary>
  6691. Returns true if the supplied method is applicable to actual
  6692. argument types.
  6693. </summary>
  6694. </member>
  6695. <member name="M:NVelocity.Util.Introspection.MethodMap.IsMethodInvocationConvertible(System.Reflection.ParameterInfo,System.Type)">
  6696. <summary>
  6697. Determines whether a type represented by a class object is
  6698. convertible to another type represented by a class object using a
  6699. method invocation conversion, treating object types of primitive
  6700. types as if they were primitive types (that is, a Boolean actual
  6701. parameter type matches boolean primitive formal type). This behavior
  6702. is because this method is used to determine applicable methods for
  6703. an actual parameter list, and primitive types are represented by
  6704. their object duals in reflective method calls.
  6705. </summary>
  6706. <param name="formal">the formal parameter type to which the actual parameter type should be convertible</param>
  6707. <param name="actual">the actual parameter type.</param>
  6708. <returns>
  6709. true if either formal type is assignable from actual type,
  6710. or formal is a primitive type and actual is its corresponding object
  6711. type or an object type of a primitive type that can be converted to
  6712. the formal type.
  6713. </returns>
  6714. </member>
  6715. <member name="M:NVelocity.Util.Introspection.MethodMap.IsStrictMethodInvocationConvertible(System.Reflection.ParameterInfo,System.Reflection.ParameterInfo)">
  6716. <summary>
  6717. Determines whether a type represented by a class object is
  6718. convertible to another type represented by a class object using a
  6719. method invocation conversion, without matching object and primitive
  6720. types. This method is used to determine the more specific type when
  6721. comparing signatures of methods.
  6722. </summary>
  6723. <param name="formal">the formal parameter type to which the actual parameter type should be convertible</param>
  6724. <param name="actual">the actual parameter type.</param>
  6725. <returns>
  6726. true if either formal type is assignable from actual type,
  6727. or formal and actual are both primitive types and actual can be
  6728. subject to widening conversion to formal.
  6729. </returns>
  6730. </member>
  6731. <member name="T:NVelocity.Util.Introspection.UberspectImpl">
  6732. <summary> Implementation of Uberspect to provide the default introspective
  6733. functionality of Velocity
  6734. *
  6735. </summary>
  6736. <author> <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
  6737. </author>
  6738. <version> $Id: UberspectImpl.cs,v 1.1 2004/12/27 05:55:08 corts Exp $
  6739. </version>
  6740. </member>
  6741. <member name="T:NVelocity.Util.Introspection.UberspectLoggable">
  6742. <summary>
  6743. Marker interface to let an uberspector indicate it can and wants to
  6744. log
  6745. *
  6746. Thanks to Paulo for the suggestion
  6747. *
  6748. </summary>
  6749. <author> <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
  6750. </author>
  6751. <version> $Id: UberspectLoggable.cs,v 1.1 2004/12/27 05:55:08 corts Exp $
  6752. *
  6753. </version>
  6754. </member>
  6755. <member name="P:NVelocity.Util.Introspection.UberspectLoggable.RuntimeLogger">
  6756. <summary> Sets the logger. This will be called before any calls to the
  6757. uberspector
  6758. </summary>
  6759. </member>
  6760. <member name="F:NVelocity.Util.Introspection.UberspectImpl.runtimeLogger">
  6761. <summary>
  6762. Our runtime logger.
  6763. </summary>
  6764. </member>
  6765. <member name="F:NVelocity.Util.Introspection.UberspectImpl.introspector">
  6766. <summary>
  6767. the default Velocity introspector
  6768. </summary>
  6769. </member>
  6770. <member name="M:NVelocity.Util.Introspection.UberspectImpl.Init">
  6771. <summary>
  6772. init - does nothing - we need to have setRuntimeLogger
  6773. called before getting our introspector, as the default
  6774. vel introspector depends upon it.
  6775. </summary>
  6776. </member>
  6777. <member name="M:NVelocity.Util.Introspection.UberspectImpl.GetMethod(System.Object,System.String,System.Object[],NVelocity.Util.Introspection.Info)">
  6778. <summary>
  6779. Method
  6780. </summary>
  6781. </member>
  6782. <member name="M:NVelocity.Util.Introspection.UberspectImpl.GetPropertyGet(System.Object,System.String,NVelocity.Util.Introspection.Info)">
  6783. <summary>
  6784. Property getter
  6785. </summary>
  6786. </member>
  6787. <member name="M:NVelocity.Util.Introspection.UberspectImpl.GetPropertySet(System.Object,System.String,System.Object,NVelocity.Util.Introspection.Info)">
  6788. <summary> Property setter
  6789. </summary>
  6790. </member>
  6791. <member name="P:NVelocity.Util.Introspection.UberspectImpl.RuntimeLogger">
  6792. <summary>
  6793. Sets the runtime logger - this must be called before anything
  6794. else besides init() as to get the logger. Makes the pull
  6795. model appealing...
  6796. </summary>
  6797. </member>
  6798. <member name="T:NVelocity.Util.Introspection.UberspectImpl.VelMethodImpl">
  6799. <summary>
  6800. Implementation of <see cref="T:NVelocity.Util.Introspection.IVelMethod"/>.
  6801. </summary>
  6802. </member>
  6803. <member name="T:NVelocity.Util.Introspection.UberspectImpl.VelGetterImpl">
  6804. <summary>
  6805. Implementation of <see cref="T:NVelocity.Util.Introspection.IVelPropertyGet"/>.
  6806. </summary>
  6807. </member>
  6808. <member name="T:NVelocity.Util.SimplePool`1">
  6809. <summary>
  6810. Simple object pool. Based on ThreadPool and few other classes
  6811. The pool will ignore overflow and return null if empty.
  6812. </summary>
  6813. </member>
  6814. <member name="F:NVelocity.Util.SimplePool`1.maximum">
  6815. <summary> max amount of objects to be managed
  6816. set via CTOR
  6817. </summary>
  6818. </member>
  6819. <member name="F:NVelocity.Util.SimplePool`1.current">
  6820. <summary> index of previous to next
  6821. free slot
  6822. </summary>
  6823. </member>
  6824. <member name="M:NVelocity.Util.SimplePool`1.put(`0)">
  6825. <summary>
  6826. Add the object to the pool, silent nothing if the pool is full
  6827. </summary>
  6828. </member>
  6829. <member name="M:NVelocity.Util.SimplePool`1.get">
  6830. <summary>
  6831. Get an object from the pool, null if the pool is empty.
  6832. </summary>
  6833. </member>
  6834. <member name="P:NVelocity.Util.SimplePool`1.Maximum">
  6835. <summary>
  6836. Return the size of the pool
  6837. </summary>
  6838. </member>
  6839. <member name="T:NVelocity.Util.StringUtils">
  6840. <summary> This class provides some methods for dynamically
  6841. invoking methods in objects, and some string
  6842. manipulation methods used by torque. The string
  6843. methods will soon be moved into the turbine
  6844. string utilities class.
  6845. *
  6846. </summary>
  6847. <author> <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>
  6848. </author>
  6849. <author> <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
  6850. </author>
  6851. <version> $Id: StringUtils.cs,v 1.3 2003/10/27 13:54:12 corts Exp $
  6852. </version>
  6853. </member>
  6854. <member name="F:NVelocity.Util.StringUtils.EOL">
  6855. <summary> Line separator for the OS we are operating on.
  6856. </summary>
  6857. </member>
  6858. <member name="M:NVelocity.Util.StringUtils.FirstLetterCaps(System.String)">
  6859. <summary> <p>
  6860. Makes the first letter caps and the rest lowercase.
  6861. </p>
  6862. *
  6863. <p>
  6864. For example <code>fooBar</code> becomes <code>Foobar</code>.
  6865. </p>
  6866. *
  6867. </summary>
  6868. <param name="data">capitalize this
  6869. </param>
  6870. <returns>String
  6871. </returns>
  6872. </member>
  6873. <member name="M:NVelocity.Util.StringUtils.FileContentsToString(System.String)">
  6874. <summary> Read the contents of a file and place them in
  6875. a string object.
  6876. *
  6877. </summary>
  6878. <param name="file">path to file.
  6879. </param>
  6880. <returns>String contents of the file.
  6881. </returns>
  6882. </member>
  6883. <member name="M:NVelocity.Util.StringUtils.NormalizePath(System.String)">
  6884. <summary> Return a context-relative path, beginning with a "/", that represents
  6885. the canonical version of the specified path after ".." and "." elements
  6886. are resolved out. If the specified path attempts to go outside the
  6887. boundaries of the current context (i.e. too many ".." path elements
  6888. are present), return <code>null</code> instead.
  6889. *
  6890. </summary>
  6891. <param name="path">Path to be normalized
  6892. </param>
  6893. <returns>String normalized path
  6894. </returns>
  6895. </member>
  6896. <member name="T:NVelocity.IDuck">
  6897. <summary>
  6898. </summary>
  6899. </member>
  6900. <member name="M:NVelocity.IDuck.GetInvoke(System.String)">
  6901. <summary>
  6902. Defines the behavior when a property is read
  6903. </summary>
  6904. <param name="propName">Property name.</param>
  6905. <returns>value back to the template</returns>
  6906. </member>
  6907. <member name="M:NVelocity.IDuck.SetInvoke(System.String,System.Object)">
  6908. <summary>
  6909. Defines the behavior when a property is written
  6910. </summary>
  6911. <param name="propName">Property name.</param>
  6912. <param name="value">The value to assign.</param>
  6913. </member>
  6914. <member name="M:NVelocity.IDuck.Invoke(System.String,System.Object[])">
  6915. <summary>
  6916. Invokes the specified method.
  6917. </summary>
  6918. <param name="method">The method name.</param>
  6919. <param name="args">The method arguments.</param>
  6920. <returns>value back to the template</returns>
  6921. </member>
  6922. <member name="M:NVelocity.SupportClass.CreateNewInstance(System.Type)">
  6923. <summary>
  6924. Creates an instance of a received Type
  6925. </summary>
  6926. <param name="classType">The Type of the new class instance to return</param>
  6927. <returns>An Object containing the new instance</returns>
  6928. </member>
  6929. <member name="T:NVelocity.Template">
  6930. <summary>
  6931. This class is used for controlling all template
  6932. operations. This class uses a parser created
  6933. by JavaCC to create an AST that is subsequently
  6934. traversed by a Visitor.
  6935. <code>
  6936. Template template = Velocity.getTemplate("test.wm");
  6937. IContext context = new VelocityContext();
  6938. context.Put("foo", "bar");
  6939. context.Put("customer", new Customer());
  6940. template.Merge(context, writer);
  6941. </code>
  6942. </summary>
  6943. </member>
  6944. <member name="M:NVelocity.Template.Process">
  6945. <summary>
  6946. Gets the named resource as a stream, parses and inits.
  6947. </summary>
  6948. <returns>true if successful</returns>
  6949. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  6950. if template not found from any available source.
  6951. </exception>
  6952. <exception cref="T:NVelocity.Exception.ParseErrorException">
  6953. if template cannot be parsed due to syntax (or other) error.
  6954. </exception>
  6955. <exception cref="T:System.Exception">
  6956. some other problem, should only be from initialization of the template AST.
  6957. </exception>
  6958. </member>
  6959. <member name="M:NVelocity.Template.InitDocument">
  6960. <summary>
  6961. initializes the document. init() is not longer
  6962. dependant upon context, but we need to let the
  6963. init() carry the template name down through for VM
  6964. namespace features
  6965. </summary>
  6966. </member>
  6967. <member name="M:NVelocity.Template.Merge(NVelocity.Context.IContext,System.IO.TextWriter)">
  6968. <summary>
  6969. The AST node structure is merged with the
  6970. context to produce the final output.
  6971. Throws IOException if failure is due to a file related
  6972. issue, and Exception otherwise
  6973. </summary>
  6974. <param name="context">Context with data elements accessed by template</param>
  6975. <param name="writer">writer for rendered template</param>
  6976. <exception cref="T:NVelocity.Exception.ResourceNotFoundException">
  6977. if template not found from any available source.
  6978. </exception>
  6979. <exception cref="T:NVelocity.Exception.ParseErrorException">
  6980. if template cannot be parsed due to syntax (or other) error.
  6981. </exception>
  6982. <exception cref="T:System.Exception">
  6983. anything else.
  6984. </exception>
  6985. </member>
  6986. <member name="T:NVelocity.VelocityContext">
  6987. <summary>
  6988. General purpose implementation of the application Context
  6989. interface for general application use. This class should
  6990. be used in place of the original Context class.
  6991. This context implementation cannot be shared between threads
  6992. without those threads synchronizing access between them, as
  6993. the HashMap is not synchronized, nor are some of the fundamentals
  6994. of AbstractContext. If you need to share a Context between
  6995. threads with simultaneous access for some reason, please create
  6996. your own and extend the interface Context
  6997. </summary>
  6998. </member>
  6999. <member name="F:NVelocity.VelocityContext.context">
  7000. <summary>
  7001. Storage for key/value pairs.
  7002. </summary>
  7003. </member>
  7004. <member name="M:NVelocity.VelocityContext.#ctor">
  7005. <summary>
  7006. Creates a new instance (with no inner context).
  7007. </summary>
  7008. </member>
  7009. <member name="M:NVelocity.VelocityContext.#ctor(System.Collections.Hashtable)">
  7010. <summary>
  7011. Creates a new instance with the provided storage (and no inner context).
  7012. </summary>
  7013. </member>
  7014. <member name="M:NVelocity.VelocityContext.#ctor(NVelocity.Context.IContext)">
  7015. <summary>
  7016. Chaining constructor, used when you want to
  7017. wrap a context in another. The inner context
  7018. will be 'read only' - put() calls to the
  7019. wrapping context will only effect the outermost
  7020. context
  7021. </summary>
  7022. <param name="innerContext">The <code>Context</code> implementation to wrap.</param>
  7023. </member>
  7024. <member name="M:NVelocity.VelocityContext.#ctor(System.Collections.Hashtable,NVelocity.Context.IContext)">
  7025. <summary>
  7026. Initializes internal storage (never to <code>null</code>), and
  7027. inner context.
  7028. </summary>
  7029. <param name="context">Internal storage, or <code>null</code> to
  7030. create default storage.
  7031. </param>
  7032. <param name="innerContext">Inner context.
  7033. </param>
  7034. </member>
  7035. <member name="M:NVelocity.VelocityContext.InternalGet(System.String)">
  7036. <summary>
  7037. retrieves value for key from internal
  7038. storage
  7039. </summary>
  7040. <param name="key">name of value to get</param>
  7041. <returns>value as object</returns>
  7042. </member>
  7043. <member name="M:NVelocity.VelocityContext.InternalPut(System.String,System.Object)">
  7044. <summary>
  7045. stores the value for key to internal
  7046. storage
  7047. </summary>
  7048. <param name="key">name of value to store</param>
  7049. <param name="value">value to store</param>
  7050. <returns>previous value of key as Object</returns>
  7051. </member>
  7052. <member name="M:NVelocity.VelocityContext.InternalContainsKey(System.Object)">
  7053. <summary>
  7054. determines if there is a value for the
  7055. given key
  7056. </summary>
  7057. <param name="key">name of value to check</param>
  7058. <returns>true if non-null value in store</returns>
  7059. </member>
  7060. <member name="M:NVelocity.VelocityContext.InternalGetKeys">
  7061. <summary>
  7062. returns array of keys
  7063. </summary>
  7064. <returns>keys as []</returns>
  7065. </member>
  7066. <member name="M:NVelocity.VelocityContext.InternalRemove(System.Object)">
  7067. <summary>
  7068. remove a key/value pair from the
  7069. internal storage
  7070. </summary>
  7071. <param name="key">name of value to remove</param>
  7072. <returns>value removed</returns>
  7073. </member>
  7074. </members>
  7075. </doc>