tools/devel/apidocs/org/apache/velocity/tools/generic/package-use.html - velocity-site - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="en">
 <head>
 <!-- Generated by javadoc (1.8.0_171) on Wed Jun 20 14:25:32 CEST 2018 -->
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <title>Uses of Package org.apache.velocity.tools.generic (VelocityTools 3.0-SNAPSHOT API)</title>
 <meta name="date" content="2018-06-20">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 </head>
 <body>
 <script type="text/javascript"><!--
     try {
         if (location.href.indexOf('is-external=true') == -1) {
             parent.document.title="Uses of Package org.apache.velocity.tools.generic (VelocityTools 3.0-SNAPSHOT API)";
         }
     }
     catch(err) {
     }
 //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar.top">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.top.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li>Class</li>
 <li class="navBarCell1Rev">Use</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev</li>
 <li>Next</li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/velocity/tools/generic/package-use.html" target="_top">Frames</a></li>
 <li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <a name="skip.navbar.top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <div class="header">
 <h1 title="Uses of Package org.apache.velocity.tools.generic" class="title">Uses of Package<br>org.apache.velocity.tools.generic</h1>
 </div>
 <div class="contentContainer">
 <ul class="blockList">
 <li class="blockList">
 <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation">
 <caption><span>Packages that use <a href="../../../../../org/apache/velocity/tools/generic/package-summary.html">org.apache.velocity.tools.generic</a></span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Package</th>
 <th class="colLast" scope="col">Description</th>
 </tr>
 <tbody>
 <tr class="altColor">
 <td class="colFirst"><a href="#org.apache.velocity.tools.generic">org.apache.velocity.tools.generic</a></td>
 <td class="colLast">
 <div class="block">Contains a collection of reusable, general-purpose "tools" for Velocity.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><a href="#org.apache.velocity.tools.view">org.apache.velocity.tools.view</a></td>
 <td class="colLast">
 <div class="block">Contains tools and supporting infrastructure for using
 those tools in a servlet environment as well as general
 use classes to support use of Velocity as (or in) the
 view layer of web applications.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </li>
 <li class="blockList"><a name="org.apache.velocity.tools.generic">
 <!--   -->
 </a>
 <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
 <caption><span>Classes in <a href="../../../../../org/apache/velocity/tools/generic/package-summary.html">org.apache.velocity.tools.generic</a> used by <a href="../../../../../org/apache/velocity/tools/generic/package-summary.html">org.apache.velocity.tools.generic</a></span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Class and Description</th>
 </tr>
 <tbody>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/Alternator.html#org.apache.velocity.tools.generic">Alternator</a>
 <div class="block">Utility class for easily alternating over values in a list.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ClassTool.html#org.apache.velocity.tools.generic">ClassTool</a>
 <div class="block">
  This tool is meant to simplify reflective lookup of information about
  a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang"><code>Class</code></a> and its <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect"><code>Field</code></a>s, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect"><code>Method</code></a>s, and <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true" title="class or interface in java.lang.reflect"><code>Constructor</code></a>s.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ClassTool.CallableSub.html#org.apache.velocity.tools.generic">ClassTool.CallableSub</a>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ClassTool.ConstructorSub.html#org.apache.velocity.tools.generic">ClassTool.ConstructorSub</a>
 <div class="block">A simplified wrapping interface for inspecting features
  of a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true" title="class or interface in java.lang.reflect"><code>Constructor</code></a> in an inspected Class.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ClassTool.FieldSub.html#org.apache.velocity.tools.generic">ClassTool.FieldSub</a>
 <div class="block">A simplified wrapping interface for inspecting features
  of a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true" title="class or interface in java.lang.reflect"><code>Field</code></a> in an inspected Class.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ClassTool.MethodSub.html#org.apache.velocity.tools.generic">ClassTool.MethodSub</a>
 <div class="block">A simplified wrapping interface for inspecting features
  of a <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true" title="class or interface in java.lang.reflect"><code>Method</code></a> in an inspected Class.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ClassTool.Sub.html#org.apache.velocity.tools.generic">ClassTool.Sub</a>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/CollectionTool.html#org.apache.velocity.tools.generic">CollectionTool</a>
 <div class="block">CollectionTool allows a user to sort a collection (or array, iterator, etc)
  on any arbitrary set of properties exposed by the objects contained
  within the collection, and to generate arrays by splitting strings.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ComparisonDateTool.Comparison.html#org.apache.velocity.tools.generic">ComparisonDateTool.Comparison</a>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/DateTool.html#org.apache.velocity.tools.generic">DateTool</a>
 <div class="block">Tool for working with <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a> and <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendar</code></a>
  in Velocity templates.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/DisplayTool.Measurements.html#org.apache.velocity.tools.generic">DisplayTool.Measurements</a>
 <div class="block">Measures the dimensions of the string given to its constructor.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/FieldTool.FieldToolSub.html#org.apache.velocity.tools.generic">FieldTool.FieldToolSub</a>
 <div class="block">Holds a <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of results for a particular class.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/FormatConfig.html#org.apache.velocity.tools.generic">FormatConfig</a>
 <div class="block">Implements common logic and constants for tools which allow their
  default format to be configured.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ImportSupport.html#org.apache.velocity.tools.generic">ImportSupport</a>
 <div class="block">Provides methods to import arbitrary local or remote resources as strings, generic version.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LocaleConfig.html#org.apache.velocity.tools.generic">LocaleConfig</a>
 <div class="block">Implements common logic and constants for tools which allow their
  default <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util"><code>Locale</code></a> to be configured.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LoopTool.html#org.apache.velocity.tools.generic">LoopTool</a>
 <div class="block">
  A convenience tool to use with #foreach loops.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LoopTool.Action.html#org.apache.velocity.tools.generic">LoopTool.Action</a>
 <div class="block">Represents an automatic action taken by a <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ManagedIterator</code></a>
  when a <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.Condition.html" title="interface in org.apache.velocity.tools.generic"><code>LoopTool.Condition</code></a> is satisfied by the subsequent element.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LoopTool.ActionCondition.html#org.apache.velocity.tools.generic">LoopTool.ActionCondition</a>
 <div class="block">Composition class which associates an <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.Action.html" title="enum in org.apache.velocity.tools.generic"><code>LoopTool.Action</code></a> and <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.Condition.html" title="interface in org.apache.velocity.tools.generic"><code>LoopTool.Condition</code></a>
  for a <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ManagedIterator</code></a>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LoopTool.Comparison.html#org.apache.velocity.tools.generic">LoopTool.Comparison</a>
 <div class="block">Base condition class for conditions (assumption here is that
  conditions are all comparative.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LoopTool.Condition.html#org.apache.velocity.tools.generic">LoopTool.Condition</a>
 <div class="block">Represents a function into which a <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.ManagedIterator.html" title="class in org.apache.velocity.tools.generic"><code>LoopTool.ManagedIterator</code></a> can
  pass it's next element to see if an <a href="../../../../../org/apache/velocity/tools/generic/LoopTool.Action.html" title="enum in org.apache.velocity.tools.generic"><code>LoopTool.Action</code></a> should be taken.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LoopTool.ManagedIterator.html#org.apache.velocity.tools.generic">LoopTool.ManagedIterator</a>
 <div class="block">Iterator implementation that wraps a standard <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a>
  and allows it to be prematurely stopped, skipped ahead, and
  associated with a name for advanced nested loop control.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/MarkupTool.html#org.apache.velocity.tools.generic">MarkupTool</a>
 <div class="block"><b>NOTE: This tools is considered "alpha" quality due to lack of testing
  and a generally unpolished API.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/MarkupTool.Tag.html#org.apache.velocity.tools.generic">MarkupTool.Tag</a>&nbsp;</td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ResourceTool.Key.html#org.apache.velocity.tools.generic">ResourceTool.Key</a>
 <div class="block">Internal class used to enable an elegant syntax for accessing
  resources.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/SafeConfig.html#org.apache.velocity.tools.generic">SafeConfig</a>
 <div class="block">Implements common logic and constants for tools which automatically
  locks down the <code>public void configure(Map params)</code> method after
  it is called once.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ValueParser.html#org.apache.velocity.tools.generic">ValueParser</a>
 <div class="block">Utility class for easy parsing of String values held in a Map.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/XmlTool.html#org.apache.velocity.tools.generic">XmlTool</a>
 <div class="block">Tool for reading/navigating XML files.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </li>
 <li class="blockList"><a name="org.apache.velocity.tools.view">
 <!--   -->
 </a>
 <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation">
 <caption><span>Classes in <a href="../../../../../org/apache/velocity/tools/generic/package-summary.html">org.apache.velocity.tools.generic</a> used by <a href="../../../../../org/apache/velocity/tools/view/package-summary.html">org.apache.velocity.tools.view</a></span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Class and Description</th>
 </tr>
 <tbody>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ContextTool.html#org.apache.velocity.tools.view">ContextTool</a>
 <div class="block">Tool for convenient access to <code>Context</code> data and
   meta-data.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/FormatConfig.html#org.apache.velocity.tools.view">FormatConfig</a>
 <div class="block">Implements common logic and constants for tools which allow their
  default format to be configured.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ImportSupport.html#org.apache.velocity.tools.view">ImportSupport</a>
 <div class="block">Provides methods to import arbitrary local or remote resources as strings, generic version.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ImportTool.html#org.apache.velocity.tools.view">ImportTool</a>
 <div class="block">General-purpose text-importing tool for templates.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/JsonTool.html#org.apache.velocity.tools.view">JsonTool</a>
 <div class="block">Tool which can parse a JSON file.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LinkTool.html#org.apache.velocity.tools.view">LinkTool</a>
 <div class="block">The LinkTool provides many methods to work with URIs and can help you:</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/LocaleConfig.html#org.apache.velocity.tools.view">LocaleConfig</a>
 <div class="block">Implements common logic and constants for tools which allow their
  default <a href="https://docs.oracle.com/javase/7/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util"><code>Locale</code></a> to be configured.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/SafeConfig.html#org.apache.velocity.tools.view">SafeConfig</a>
 <div class="block">Implements common logic and constants for tools which automatically
  locks down the <code>public void configure(Map params)</code> method after
  it is called once.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/ValueParser.html#org.apache.velocity.tools.view">ValueParser</a>
 <div class="block">Utility class for easy parsing of String values held in a Map.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colOne"><a href="../../../../../org/apache/velocity/tools/generic/class-use/XmlTool.html#org.apache.velocity.tools.view">XmlTool</a>
 <div class="block">Tool for reading/navigating XML files.</div>
 </td>
 </tr>
 </tbody>
 </table>
 </li>
 </ul>
 </div>
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar.bottom">
 <!--   -->
 </a>
 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 <a name="navbar.bottom.firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li>Class</li>
 <li class="navBarCell1Rev">Use</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev</li>
 <li>Next</li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../../index.html?org/apache/velocity/tools/generic/package-use.html" target="_top">Frames</a></li>
 <li><a href="package-use.html" target="_top">No&nbsp;Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <a name="skip.navbar.bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2018 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>