MetadataElementImpl.html
Home
/
bdi-jade /
doc /
bdi4jade /
core /
MetadataElementImpl.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>MetadataElementImpl</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="MetadataElementImpl";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/MetadataElementImpl.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/core/MetadataElement.html" title="interface in bdi4jade.core"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../bdi4jade/core/MultipleCapabilityAgent.html" title="class in bdi4jade.core"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/core/MetadataElementImpl.html" target="_top">Frames</a></li>
<li><a href="MetadataElementImpl.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.core</div>
<h2 title="Class MetadataElementImpl" class="title">Class MetadataElementImpl</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>bdi4jade.core.MetadataElementImpl</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../bdi4jade/belief/AbstractBelief.html" title="class in bdi4jade.belief">AbstractBelief</a>, <a href="../../bdi4jade/plan/AbstractPlan.html" title="class in bdi4jade.plan">AbstractPlan</a>, <a href="../../bdi4jade/goal/NamedSoftgoal.html" title="class in bdi4jade.goal">NamedSoftgoal</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">MetadataElementImpl</span>
extends java.lang.Object
implements <a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></pre>
<div class="block">This class provides an implementation to the <a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core"><code>MetadataElement</code></a>. It is
able to store metadata.</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">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.Map<java.lang.Object,java.lang.Object></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/MetadataElementImpl.html#metadata">metadata</a></span></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/core/MetadataElementImpl.html#MetadataElementImpl--">MetadataElementImpl</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>java.util.Map<?,?></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/MetadataElementImpl.html#getMetadata--">getMetadata</a></span>()</code> </td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/MetadataElementImpl.html#getMetadata-java.lang.Object-">getMetadata</a></span>(java.lang.Object name)</code>
<div class="block">Gets a value of a metadata.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/MetadataElementImpl.html#hasMetadata-java.lang.Object-">hasMetadata</a></span>(java.lang.Object name)</code>
<div class="block">Verifies if a metadata is associated with this element.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/MetadataElementImpl.html#putMetadata-java.lang.Object-java.lang.Object-">putMetadata</a></span>(java.lang.Object name,
java.lang.Object value)</code>
<div class="block">Put a metadata in this element.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../bdi4jade/core/MetadataElementImpl.html#removeMetadata-java.lang.Object-">removeMetadata</a></span>(java.lang.Object name)</code>
<div class="block">Removes a metadata of this element.</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">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="metadata">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>metadata</h4>
<pre>protected java.util.Map<java.lang.Object,java.lang.Object> metadata</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="MetadataElementImpl--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>MetadataElementImpl</h4>
<pre>public MetadataElementImpl()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre>public java.util.Map<?,?> getMetadata()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../bdi4jade/core/MetadataElement.html#getMetadata--">getMetadata</a></code> in interface <code><a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the metadata</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../bdi4jade/core/MetadataElement.html#getMetadata--"><code>MetadataElement.getMetadata()</code></a></dd>
</dl>
</li>
</ul>
<a name="getMetadata-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre>public java.lang.Object getMetadata(java.lang.Object name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../bdi4jade/core/MetadataElement.html#getMetadata-java.lang.Object-">MetadataElement</a></code></span></div>
<div class="block">Gets a value of a metadata.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../bdi4jade/core/MetadataElement.html#getMetadata-java.lang.Object-">getMetadata</a></code> in interface <code><a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the metadata.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the existing value of this metadata.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../bdi4jade/core/MetadataElement.html#getMetadata-java.lang.Object-"><code>MetadataElement.getMetadata(Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="hasMetadata-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMetadata</h4>
<pre>public boolean hasMetadata(java.lang.Object name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../bdi4jade/core/MetadataElement.html#hasMetadata-java.lang.Object-">MetadataElement</a></code></span></div>
<div class="block">Verifies if a metadata is associated with this element.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../bdi4jade/core/MetadataElement.html#hasMetadata-java.lang.Object-">hasMetadata</a></code> in interface <code><a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the metadata.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the element has this metadata.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../bdi4jade/core/MetadataElement.html#hasMetadata-java.lang.Object-"><code>MetadataElement.hasMetadata(Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="putMetadata-java.lang.Object-java.lang.Object-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putMetadata</h4>
<pre>public void putMetadata(java.lang.Object name,
java.lang.Object value)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../bdi4jade/core/MetadataElement.html#putMetadata-java.lang.Object-java.lang.Object-">MetadataElement</a></code></span></div>
<div class="block">Put a metadata in this element. If it does not exists, it is added, and
it is update otherwise.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../bdi4jade/core/MetadataElement.html#putMetadata-java.lang.Object-java.lang.Object-">putMetadata</a></code> in interface <code><a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the metadata.</dd>
<dd><code>value</code> - the value associated with this metadata.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../bdi4jade/core/MetadataElement.html#putMetadata-java.lang.Object-java.lang.Object-"><code>MetadataElement.putMetadata(Object, Object)</code></a></dd>
</dl>
</li>
</ul>
<a name="removeMetadata-java.lang.Object-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeMetadata</h4>
<pre>public java.lang.Object removeMetadata(java.lang.Object name)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../bdi4jade/core/MetadataElement.html#removeMetadata-java.lang.Object-">MetadataElement</a></code></span></div>
<div class="block">Removes a metadata of this element.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../bdi4jade/core/MetadataElement.html#removeMetadata-java.lang.Object-">removeMetadata</a></code> in interface <code><a href="../../bdi4jade/core/MetadataElement.html" title="interface in bdi4jade.core">MetadataElement</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name of the metadata.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the existing value of this metadata.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../bdi4jade/core/MetadataElement.html#removeMetadata-java.lang.Object-"><code>MetadataElement.removeMetadata(Object)</code></a></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/MetadataElementImpl.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/core/MetadataElement.html" title="interface in bdi4jade.core"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../bdi4jade/core/MultipleCapabilityAgent.html" title="class in bdi4jade.core"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?bdi4jade/core/MetadataElementImpl.html" target="_top">Frames</a></li>
<li><a href="MetadataElementImpl.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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>