ReflectionUtils.html
Home
/
bdi-jade /
doc /
bdi4jade /
util /
ReflectionUtils.html
<!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_20) on Mon Sep 22 13:06:34 BRT 2014 -->
<title>ReflectionUtils</title>
<meta name="date" content="2014-09-22">
<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="ReflectionUtils";
}
}
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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="navBarCell1Rev">Class</li>
<li><a href="class-use/ReflectionUtils.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>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/util/ReflectionUtils.html" target="_top">Frames</a></li>
<li><a href="ReflectionUtils.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </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.util</div>
<h2 title="Class ReflectionUtils" class="title">Class ReflectionUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.util.ReflectionUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">ReflectionUtils</span>
extends java.lang.Object</pre>
<div class="block">This is a utility class that provides many methods that use reflection for
different purposes.</div>
<dl>
<dt><span class="simpleTagLabel">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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../bdi4jade/util/ReflectionUtils.html#ReflectionUtils--">ReflectionUtils</a></span>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/util/ReflectionUtils.html#addGoalOwner-java.util.Map-bdi4jade.core.Capability-">addGoalOwner</a></span>(java.util.Map<java.lang.Class<? extends <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>>,java.util.Set<<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>>> goalOwnersMap,
<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability)</code>
<div class="block">Adds to the goal owners map the capability classes that owns a goal to
the capability instance passed as parameter.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/util/ReflectionUtils.html#setPlanBodyInput-bdi4jade.plan.planbody.PlanBody-bdi4jade.goal.Goal-">setPlanBodyInput</a></span>(<a href="../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a> planBody,
<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Sets the input parameters of a plan body based on the parameters passed
in the goal that triggered its execution.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/util/ReflectionUtils.html#setPlanBodyOutput-bdi4jade.plan.planbody.PlanBody-bdi4jade.goal.Goal-">setPlanBodyOutput</a></span>(<a href="../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a> planBody,
<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)</code>
<div class="block">Sets the output parameters of a goal based on the output generated by the
plan body whose execution was triggered by this goal.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/util/ReflectionUtils.html#setupBeliefs-bdi4jade.plan.planbody.PlanBody-">setupBeliefs</a></span>(<a href="../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a> planBody)</code>
<div class="block">Sets plan body fields annotated with <a href="../../bdi4jade/annotation/Belief.html" title="annotation in bdi4jade.annotation"><code>Belief</code></a>.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/util/ReflectionUtils.html#setupParameters-bdi4jade.goal.Goal-bdi4jade.goal.Goal-">setupParameters</a></span>(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goalOut,
<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goalIn)</code>
<div class="block">Sets the input parameters of goal based on the output parameters of
another goal.</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 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="ReflectionUtils--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ReflectionUtils</h4>
<pre>public ReflectionUtils()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addGoalOwner-java.util.Map-bdi4jade.core.Capability-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addGoalOwner</h4>
<pre>public static void addGoalOwner(java.util.Map<java.lang.Class<? extends <a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>>,java.util.Set<<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a>>> goalOwnersMap,
<a href="../../bdi4jade/core/Capability.html" title="class in bdi4jade.core">Capability</a> capability)</pre>
<div class="block">Adds to the goal owners map the capability classes that owns a goal to
the capability instance passed as parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goalOwnersMap</code> - the goal owners map to which the owners of the given
capability should be added.</dd>
<dd><code>capability</code> - the capability that should be added to the map.</dd>
</dl>
</li>
</ul>
<a name="setPlanBodyInput-bdi4jade.plan.planbody.PlanBody-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlanBodyInput</h4>
<pre>public static void setPlanBodyInput(<a href="../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a> planBody,
<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)
throws <a href="../../bdi4jade/exception/ParameterException.html" title="class in bdi4jade.exception">ParameterException</a></pre>
<div class="block">Sets the input parameters of a plan body based on the parameters passed
in the goal that triggered its execution.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planBody</code> - the plan body to have its input parameters set.</dd>
<dd><code>goal</code> - the goal that has input parameters.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../bdi4jade/exception/ParameterException.html" title="class in bdi4jade.exception">ParameterException</a></code> - if an exception occurs in this setting process.</dd>
</dl>
</li>
</ul>
<a name="setPlanBodyOutput-bdi4jade.plan.planbody.PlanBody-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPlanBodyOutput</h4>
<pre>public static void setPlanBodyOutput(<a href="../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a> planBody,
<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goal)
throws <a href="../../bdi4jade/exception/ParameterException.html" title="class in bdi4jade.exception">ParameterException</a></pre>
<div class="block">Sets the output parameters of a goal based on the output generated by the
plan body whose execution was triggered by this goal.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planBody</code> - the plan body generated the output parameters.</dd>
<dd><code>goal</code> - the goal to have its output parameters set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../bdi4jade/exception/ParameterException.html" title="class in bdi4jade.exception">ParameterException</a></code> - if an exception occurs in this setting process.</dd>
</dl>
</li>
</ul>
<a name="setupBeliefs-bdi4jade.plan.planbody.PlanBody-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setupBeliefs</h4>
<pre>public static void setupBeliefs(<a href="../../bdi4jade/plan/planbody/PlanBody.html" title="interface in bdi4jade.plan.planbody">PlanBody</a> planBody)</pre>
<div class="block">Sets plan body fields annotated with <a href="../../bdi4jade/annotation/Belief.html" title="annotation in bdi4jade.annotation"><code>Belief</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>planBody</code> - the plan body to be setup with beliefs.</dd>
</dl>
</li>
</ul>
<a name="setupParameters-bdi4jade.goal.Goal-bdi4jade.goal.Goal-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setupParameters</h4>
<pre>public static void setupParameters(<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goalOut,
<a href="../../bdi4jade/goal/Goal.html" title="interface in bdi4jade.goal">Goal</a> goalIn)
throws <a href="../../bdi4jade/exception/ParameterException.html" title="class in bdi4jade.exception">ParameterException</a></pre>
<div class="block">Sets the input parameters of goal based on the output parameters of
another goal. This is useful when goals are executed sequentially, and
the input of a goal is the output of another.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>goalOut</code> - the goal that has output parameters that are input of the
goalIn.</dd>
<dd><code>goalIn</code> - the goal to have its input parameters set.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../bdi4jade/exception/ParameterException.html" title="class in bdi4jade.exception">ParameterException</a></code> - if an exception occurs in this setting process.</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>
<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="navBarCell1Rev">Class</li>
<li><a href="class-use/ReflectionUtils.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>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/util/ReflectionUtils.html" target="_top">Frames</a></li>
<li><a href="ReflectionUtils.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>