GoalTemplateFactory.html

414 lines | 20.057 kB Blame History Raw Download
<!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 (version 1.7.0_17) on Tue Aug 12 15:49:05 BRT 2014 -->
<title>GoalTemplateFactory</title>
<meta name="date" content="2014-08-12">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="GoalTemplateFactory";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="navBarCell1Rev">Class</li>
<li><a href="class-use/GoalTemplateFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/goal/NamedSoftgoal.html" title="class in bdi4jade.goal"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/goal/GoalTemplateFactory.html" target="_top">Frames</a></li>
<li><a href="GoalTemplateFactory.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">bdi4jade.goal</div>
<h2 title="Class GoalTemplateFactory" class="title">Class GoalTemplateFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.goal.GoalTemplateFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="strong">GoalTemplateFactory</span>
extends java.lang.Object</pre>
<div class="block">This class provides a collection of static methods to create common goal
 templates.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Ingrid Nunes</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#GoalTemplateFactory()">GoalTemplateFactory</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#beliefGoal(java.lang.String)">beliefGoal</a></strong>(java.lang.String&nbsp;beliefName)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefGoal.html" title="class in bdi4jade.goal"><code>BeliefGoal</code></a> and has the given belief name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#beliefSetTypeGoal(java.lang.String, java.lang.Class)">beliefSetTypeGoal</a></strong>(java.lang.String&nbsp;beliefName,
                 java.lang.Class&lt;?&gt;&nbsp;beliefValueClass)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="class in bdi4jade.goal"><code>BeliefSetValueGoal</code></a>, has the given belief name, and
 its value is of the given type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#beliefSetValueGoal(java.lang.String, java.lang.Object)">beliefSetValueGoal</a></strong>(java.lang.String&nbsp;beliefName,
                  java.lang.Object&nbsp;beliefValue)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="class in bdi4jade.goal"><code>BeliefSetValueGoal</code></a>, has the given belief name, and
 has the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#beliefTypeGoal(java.lang.String, java.lang.Class)">beliefTypeGoal</a></strong>(java.lang.String&nbsp;beliefName,
              java.lang.Class&lt;?&gt;&nbsp;beliefValueClass)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a>, has the given belief name, and
 its value is of the given type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#beliefValueGoal(java.lang.String, java.lang.Object)">beliefValueGoal</a></strong>(java.lang.String&nbsp;beliefName,
               java.lang.Object&nbsp;beliefValue)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a>, has the given belief name, and
 has the given value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#goalType(java.lang.Class)">goalType</a></strong>(java.lang.Class&lt;? extends <a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&gt;&nbsp;goalClass)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the given type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a></code></td>
<td class="colLast"><code><strong><a href="../../bdi4jade/goal/GoalTemplateFactory.html#nullBeliefValueGoal(java.lang.String)">nullBeliefValueGoal</a></strong>(java.lang.String&nbsp;beliefName)</code>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a>, has the given belief name, and is
 associated with a null value.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="GoalTemplateFactory()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GoalTemplateFactory</h4>
<pre>public&nbsp;GoalTemplateFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="beliefGoal(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beliefGoal</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;beliefGoal(java.lang.String&nbsp;beliefName)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefGoal.html" title="class in bdi4jade.goal"><code>BeliefGoal</code></a> and has the given belief name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefName</code> - the belief name to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is a <a href="../../bdi4jade/goal/BeliefGoal.html" title="class in bdi4jade.goal"><code>BeliefGoal</code></a>
         with the given name.</dd></dl>
</li>
</ul>
<a name="beliefSetTypeGoal(java.lang.String, java.lang.Class)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beliefSetTypeGoal</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;beliefSetTypeGoal(java.lang.String&nbsp;beliefName,
                             java.lang.Class&lt;?&gt;&nbsp;beliefValueClass)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="class in bdi4jade.goal"><code>BeliefSetValueGoal</code></a>, has the given belief name, and
 its value is of the given type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefName</code> - the belief name to be matched.</dd><dd><code>beliefValueClass</code> - the value class name to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is a
         <a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="class in bdi4jade.goal"><code>BeliefSetValueGoal</code></a> with the given name and value of the
         given type.</dd></dl>
</li>
</ul>
<a name="beliefSetValueGoal(java.lang.String, java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beliefSetValueGoal</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;beliefSetValueGoal(java.lang.String&nbsp;beliefName,
                              java.lang.Object&nbsp;beliefValue)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="class in bdi4jade.goal"><code>BeliefSetValueGoal</code></a>, has the given belief name, and
 has the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefName</code> - the belief name to be matched.</dd><dd><code>beliefValue</code> - the value to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is a
         <a href="../../bdi4jade/goal/BeliefSetValueGoal.html" title="class in bdi4jade.goal"><code>BeliefSetValueGoal</code></a> with the given name and value.</dd></dl>
</li>
</ul>
<a name="beliefTypeGoal(java.lang.String, java.lang.Class)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beliefTypeGoal</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;beliefTypeGoal(java.lang.String&nbsp;beliefName,
                          java.lang.Class&lt;?&gt;&nbsp;beliefValueClass)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a>, has the given belief name, and
 its value is of the given type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefName</code> - the belief name to be matched.</dd><dd><code>beliefValueClass</code> - the value class name to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is a
         <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a> with the given name and value of the
         given type.</dd></dl>
</li>
</ul>
<a name="beliefValueGoal(java.lang.String, java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beliefValueGoal</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;beliefValueGoal(java.lang.String&nbsp;beliefName,
                           java.lang.Object&nbsp;beliefValue)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a>, has the given belief name, and
 has the given value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefName</code> - the belief name to be matched.</dd><dd><code>beliefValue</code> - the value to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is a
         <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a> with the given name and value.</dd></dl>
</li>
</ul>
<a name="goalType(java.lang.Class)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>goalType</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;goalType(java.lang.Class&lt;? extends <a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a>&gt;&nbsp;goalClass)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the given type.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>goalClass</code> - the goal class to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is of the given type.</dd></dl>
</li>
</ul>
<a name="nullBeliefValueGoal(java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>nullBeliefValueGoal</h4>
<pre>public static&nbsp;<a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal">GoalTemplate</a>&nbsp;nullBeliefValueGoal(java.lang.String&nbsp;beliefName)</pre>
<div class="block">This method creates a goal template that positively matches a goal if it
 is of the type <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a>, has the given belief name, and is
 associated with a null value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>beliefName</code> - the belief name to be matched.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the goal template that checks if the goal is a
         <a href="../../bdi4jade/goal/BeliefValueGoal.html" title="class in bdi4jade.goal"><code>BeliefValueGoal</code></a> with the given name and null value.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="navBarCell1Rev">Class</li>
<li><a href="class-use/GoalTemplateFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-files/index-1.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../bdi4jade/goal/GoalTemplate.html" title="interface in bdi4jade.goal"><span class="strong">Prev Class</span></a></li>
<li><a href="../../bdi4jade/goal/NamedSoftgoal.html" title="class in bdi4jade.goal"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/goal/GoalTemplateFactory.html" target="_top">Frames</a></li>
<li><a href="GoalTemplateFactory.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All 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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>