Google Git
Sign in
apache / velocity-site / 7a9b64e1165f8ef26c842c56fdc0b45a47cccaa6 / . / src / content / tools / devel / apidocs / org / apache / velocity / tools / config / package-use.html
blob: 5bc356ba55983b2a7ac777485ecd0efb3042b1ba [file] [log] [blame]
<!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_191) on Mon Mar 08 21:15:20 CET 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Uses of Package org.apache.velocity.tools.config (VelocityTools 3.2-SNAPSHOT API)</title>
<meta name="date" content="2021-03-08">
<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.config (VelocityTools 3.2-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/config/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.config" class="title">Uses of Package<br>org.apache.velocity.tools.config</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/config/package-summary.html">org.apache.velocity.tools.config</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">org.apache.velocity.tools</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="#org.apache.velocity.tools.config">org.apache.velocity.tools.config</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<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">
<!-- -->
</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/config/package-summary.html">org.apache.velocity.tools.config</a> used by <a href="../../../../../org/apache/velocity/tools/package-summary.html">org.apache.velocity.tools</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/config/class-use/FactoryConfiguration.html#org.apache.velocity.tools">FactoryConfiguration</a>
<div class="block">This class serves to define configuration info for a <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a>.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList"><a name="org.apache.velocity.tools.config">
<!-- -->
</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/config/package-summary.html">org.apache.velocity.tools.config</a> used by <a href="../../../../../org/apache/velocity/tools/config/package-summary.html">org.apache.velocity.tools.config</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/config/class-use/CompoundConfiguration.html#org.apache.velocity.tools.config">CompoundConfiguration</a>
<div class="block">This class manages a <a href="https://docs.oracle.com/javase/8/docs/api/java/util/SortedSet.html?is-external=true" title="class or interface in java.util"><code>SortedSet</code></a> of child <a href="../../../../../org/apache/velocity/tools/config/Configuration.html" title="class in org.apache.velocity.tools.config"><code>Configuration</code></a>s
as well as being a <a href="../../../../../org/apache/velocity/tools/config/Configuration.html" title="class in org.apache.velocity.tools.config"><code>Configuration</code></a> itself.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/Configuration.html#org.apache.velocity.tools.config">Configuration</a>
<div class="block">This base configuration class manages a set of <a href="../../../../../org/apache/velocity/tools/config/Property.html" title="class in org.apache.velocity.tools.config"><code>Property</code></a>s
for whatever thing the instance of this class represents.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/ConfigurationException.html#org.apache.velocity.tools.config">ConfigurationException</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/ConfigurationUtils.html#org.apache.velocity.tools.config">ConfigurationUtils</a>
<div class="block">Utility methods for handling tool configurations.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/Data.html#org.apache.velocity.tools.config">Data</a>
<div class="block">This class represents configured data.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/Data.Type.html#org.apache.velocity.tools.config">Data.Type</a>
<div class="block">Delineates the standard, known types and their
associated target classes (<a href="../../../../../org/apache/velocity/tools/config/Data.html#setTargetClass-java.lang.Class-"><code>Data.setTargetClass(java.lang.Class)</code></a> and
converters (<a href="../../../../../org/apache/velocity/tools/config/Data.html#setConverter-java.lang.Class-"><code>Data.setConverter(java.lang.Class)</code></a>).</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/EasyFactoryConfiguration.html#org.apache.velocity.tools.config">EasyFactoryConfiguration</a>
<div class="block"><a href="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><code>FactoryConfiguration</code></a> subclass that simplifies the process of
configuring a <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a> in Java without the use of an
xml or properties configuration file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/EasyFactoryConfiguration.EasyData.html#org.apache.velocity.tools.config">EasyFactoryConfiguration.EasyData</a>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/EasyFactoryConfiguration.EasyWrap.html#org.apache.velocity.tools.config">EasyFactoryConfiguration.EasyWrap</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/FactoryConfiguration.html#org.apache.velocity.tools.config">FactoryConfiguration</a>
<div class="block">This class serves to define configuration info for a <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/FileFactoryConfiguration.html#org.apache.velocity.tools.config">FileFactoryConfiguration</a>
<div class="block">Provides support for reading a configuration file from a specified path.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/Property.html#org.apache.velocity.tools.config">Property</a>
<div class="block">Simple extension of <a href="../../../../../org/apache/velocity/tools/config/Data.html" title="class in org.apache.velocity.tools.config"><code>Data</code></a> that treats "name" as an alias
for "key".</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/ToolboxConfiguration.html#org.apache.velocity.tools.config">ToolboxConfiguration</a>
<div class="block">This class handles configuration info for the Toolbox instances
that will eventually be produced by <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/ToolConfiguration.html#org.apache.velocity.tools.config">ToolConfiguration</a>
<div class="block">This class handles configuration info for tools, including their key,
classname, path restriction, and properties.</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/config/package-summary.html">org.apache.velocity.tools.config</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/config/class-use/DefaultKey.html#org.apache.velocity.tools.generic">DefaultKey</a>
<div class="block">Annotation specifying the default key to use for a tool class in the
case none was specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/InvalidScope.html#org.apache.velocity.tools.generic">InvalidScope</a>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/SkipSetters.html#org.apache.velocity.tools.generic">SkipSetters</a>
<div class="block">Annotation specifying that <a href="../../../../../org/apache/velocity/tools/ToolInfo.html" title="class in org.apache.velocity.tools"><code>ToolInfo</code></a>
should only use the public void configure(Map) method for configuration of
a tool, and skip over the step of trying to find individual
property setters.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/ValidScope.html#org.apache.velocity.tools.generic">ValidScope</a>&nbsp;</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/config/package-summary.html">org.apache.velocity.tools.config</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/config/class-use/DefaultKey.html#org.apache.velocity.tools.view">DefaultKey</a>
<div class="block">Annotation specifying the default key to use for a tool class in the
case none was specified.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/FactoryConfiguration.html#org.apache.velocity.tools.view">FactoryConfiguration</a>
<div class="block">This class serves to define configuration info for a <a href="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><code>ToolboxFactory</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/InvalidScope.html#org.apache.velocity.tools.view">InvalidScope</a>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><a href="../../../../../org/apache/velocity/tools/config/class-use/ValidScope.html#org.apache.velocity.tools.view">ValidScope</a>&nbsp;</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/config/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;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>