/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

Large files are truncated click here to view the full 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. </m