blob: fcd0782a4e1bc0bad5979d64c1a985240a0ab8fb [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="description" content="Javadoc API documentation for org.eclipse.sisu.inject." />
<!-- <link rel="shortcut icon" type="image/x-icon" href="../../../favicon.ico" /> -->
<title>
BeanEntry
| org.eclipse.sisu.inject
</title>
<link href="../../../../assets/doclava-developer-docs.css" rel="stylesheet" type="text/css" />
<link href="../../../../assets/customizations.css" rel="stylesheet" type="text/css" />
<script src="../../../../assets/search_autocomplete.js" type="text/javascript"></script>
<script src="../../../../assets/jquery-resizable.min.js" type="text/javascript"></script>
<script src="../../../../assets/doclava-developer-docs.js" type="text/javascript"></script>
<script src="../../../../assets/prettify.js" type="text/javascript"></script>
<script type="text/javascript">
setToRoot("../../../", "../../../../assets/");
</script>
<script src="../../../../assets/doclava-developer-reference.js" type="text/javascript"></script>
<script src="../../../../assets/navtree_data.js" type="text/javascript"></script>
<script src="../../../../assets/customizations.js" type="text/javascript"></script>
<noscript>
<style type="text/css">
html,body{overflow:auto;}
#body-content{position:relative; top:0;}
#doc-content{overflow:visible;border-left:3px solid #666;}
#side-nav{padding:0;}
#side-nav .toggle-list ul {display:block;}
#resize-packages-nav{border-bottom:3px solid #666;}
</style>
</noscript>
</head>
<body class="">
<div id="header">
<div id="headerLeft">
<span id="masthead-title">org.eclipse.sisu.inject</span>
</div>
<div id="headerRight">
<div id="search" >
<div id="searchForm">
<form accept-charset="utf-8" class="gsc-search-box"
onsubmit="return submit_search()">
<table class="gsc-search-box" cellpadding="0" cellspacing="0"><tbody>
<tr>
<td class="gsc-input">
<input id="search_autocomplete" class="gsc-input" type="text" size="33" autocomplete="off"
title="search developer docs" name="q"
value="search developer docs"
onFocus="search_focus_changed(this, true)"
onBlur="search_focus_changed(this, false)"
onkeydown="return search_changed(event, true, '../../../')"
onkeyup="return search_changed(event, false, '../../../')" />
<div id="search_filtered_div" class="no-display">
<table id="search_filtered" cellspacing=0>
</table>
</div>
</td>
<td class="gsc-search-button">
<input type="submit" value="Search" title="search" id="search-button" class="gsc-search-button" />
</td>
<td class="gsc-clear-button">
<div title="clear results" class="gsc-clear-button">&nbsp;</div>
</td>
</tr></tbody>
</table>
</form>
</div><!-- searchForm -->
</div><!-- search -->
</div>
</div><!-- header -->
<div class="g-section g-tpl-240" id="body-content">
<div class="g-unit g-first side-nav-resizable" id="side-nav">
<div id="swapper">
<div id="nav-panels">
<div id="resize-packages-nav">
<div id="packages-nav">
<div id="index-links">
<a href="../../../packages.html" >Package Index</a> |
<a href="../../../classes.html" >Class Index</a>
</div>
<ul>
<li class="selected api apilevel-">
<a href="../../../org/eclipse/sisu/package-summary.html">org.eclipse.sisu</a></li>
<li class="api apilevel-">
<a href="../../../org/eclipse/sisu/bean/package-summary.html">org.eclipse.sisu.bean</a></li>
<li class="api apilevel-">
<a href="../../../org/eclipse/sisu/inject/package-summary.html">org.eclipse.sisu.inject</a></li>
<li class="api apilevel-">
<a href="../../../org/eclipse/sisu/launch/package-summary.html">org.eclipse.sisu.launch</a></li>
<li class="api apilevel-">
<a href="../../../org/eclipse/sisu/osgi/package-summary.html">org.eclipse.sisu.osgi</a></li>
<li class="api apilevel-">
<a href="../../../org/eclipse/sisu/space/package-summary.html">org.eclipse.sisu.space</a></li>
<li class="api apilevel-">
<a href="../../../org/eclipse/sisu/wire/package-summary.html">org.eclipse.sisu.wire</a></li>
<li class="api apilevel-">
<a href="../../../org/sonatype/inject/package-summary.html">org.sonatype.inject</a></li>
</ul><br/>
</div> <!-- end packages -->
</div> <!-- end resize-packages -->
<div id="classes-nav">
<ul>
<li><h2>Interfaces</h2>
<ul>
<li class="selected api apilevel-"><a href="../../../org/eclipse/sisu/BeanEntry.html">BeanEntry</a>&lt;Q&nbsp;extends&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>,&nbsp;T&gt;</li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Mediator.html">Mediator</a>&lt;Q&nbsp;extends&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>,&nbsp;T,&nbsp;W&gt;</li>
</ul>
</li>
<li><h2>Annotations</h2>
<ul>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Description.html">Description</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Dynamic.html">Dynamic</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/EagerSingleton.html">EagerSingleton</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Hidden.html">Hidden</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Nullable.html">Nullable</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Parameters.html">Parameters</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Priority.html">Priority</a></li>
<li class="api apilevel-"><a href="../../../org/eclipse/sisu/Typed.html">Typed</a></li>
</ul>
</li>
</ul><br/>
</div><!-- end classes -->
</div><!-- end nav-panels -->
<div id="nav-tree" style="display:none">
<div id="index-links">
<a href="../../../packages.html" >Package Index</a> |
<a href="../../../classes.html" >Class Index</a>
</div>
</div><!-- end nav-tree -->
</div><!-- end swapper -->
</div> <!-- end side-nav -->
<script>
if (!isMobile) {
<!-- $("<a href='#' id='nav-swap' onclick='swapNav();return false;' style='font-size:10px;line-height:9px;margin-left:1em;text-decoration:none;'><span id='tree-link'>Use Tree Navigation</span><span id='panel-link' style='display:none'>Use Panel Navigation</span></a>").appendTo("#side-nav"); -->
chooseDefaultNav();
if ($("#nav-tree").is(':visible')) {
init_default_navtree("../../../");
} else {
addLoadEvent(function() {
scrollIntoView("packages-nav");
scrollIntoView("classes-nav");
});
}
$("#swapper").css({borderBottom:"2px solid #aaa"});
} else {
swapNav(); // tree view should be used on mobile
}
</script>
<div class="g-unit" id="doc-content">
<div id="api-info-block">
<div class="sum-details-links">
Summary:
<a href="#pubmethods">Methods</a>
&#124; <a href="#inhmethods">Inherited Methods</a>
&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>
</div><!-- end sum-details-links -->
<div class="api-level">
</div>
</div><!-- end api-info-block -->
<!-- ======== START OF CLASS DATA ======== -->
<div id="jd-header">
public
interface
<h1>BeanEntry</h1>
implements
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/util/Map.Entry.html">Map.Entry</a>&lt;K,&nbsp;V&gt;
</div><!-- end header -->
<div id="naMessage"></div>
<div id="jd-content" class="api apilevel-">
<table class="jd-inheritance-table">
<tr>
<td colspan="1" class="jd-inheritance-class-cell">org.eclipse.sisu.BeanEntry&lt;Q&nbsp;extends&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">java.lang.annotation.Annotation</a>,&nbsp;T&gt;</td>
</tr>
</table>
<table class="jd-sumtable jd-sumtable-subclasses"><tr><td colspan="12" style="border:none;margin:0;padding:0;">
<a href="#" onclick="return toggleInherited(this, null)" id="subclasses-indirect" class="jd-expando-trigger closed"
><img id="subclasses-indirect-trigger"
src="../../../../assets/images/triangle-closed.png"
class="jd-expando-trigger-img" /></a>Known Indirect Subclasses
<div id="subclasses-indirect">
<div id="subclasses-indirect-list"
class="jd-inheritedlinks"
>
<a href="../../../org/sonatype/inject/BeanEntry.html">BeanEntry</a>&lt;Q&nbsp;extends&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>,&nbsp;T&gt;
</div>
<div id="subclasses-indirect-summary"
style="display: none;"
>
<table class="jd-sumtable-expando">
<tr class="alt-color api apilevel-" >
<td class="jd-linkcol"><a href="../../../org/sonatype/inject/BeanEntry.html">BeanEntry</a>&lt;Q&nbsp;extends&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>,&nbsp;T&gt;</td>
<td class="jd-descrcol" width="100%">
<em>
This interface is deprecated.
Replaced by <code><a href="../../../org/eclipse/sisu/BeanEntry.html">org.eclipse.sisu.BeanEntry</a></code>
</em>&nbsp;</td>
</tr>
</table>
</div>
</div>
</td></tr></table>
<div class="jd-descr">
<h2>Class Overview</h2>
<p>Describes Qualified bean implementations of T:<br>
<br>
<pre>
&#064;Inject
Iterable&lt;BeanEntry&lt;Named, Command&gt;&gt; commands;
</pre>
Use this when you want to know more about available beans; especially if you want to avoid creating instances.</p>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">See Also</h5>
<ul class="nolist"><li><code><a href="../../../org/eclipse/sisu/inject/BeanLocator.html">BeanLocator</a></code></li>
</ul>
</div>
</div><!-- jd-descr -->
<div class="jd-descr">
<h2>Summary</h2>
<!-- ========== METHOD SUMMARY =========== -->
<table id="pubmethods" class="jd-sumtable"><tr><th colspan="12">Public Methods</th></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getDescription()">getDescription</a></span>()
<div class="jd-descrdiv">Returns a human-readable description of the bean; see @<code><a href="../../../org/eclipse/sisu/Description.html">Description</a></code>.</div>
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">
abstract
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/Class.html">Class</a>&lt;T&gt;
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getImplementationClass()">getImplementationClass</a></span>()
<div class="jd-descrdiv">Attempts to find the implementation type without creating the bean instance.</div>
</td></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
Q
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getKey()">getKey</a></span>()
<div class="jd-descrdiv">Returns the @Qualifier annotation associated with this particular bean.</div>
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">
abstract
Provider&lt;T&gt;
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getProvider()">getProvider</a></span>()
<div class="jd-descrdiv">Returns the underlying Provider; may support creation of multiple instances.</div>
</td></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
int
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getRank()">getRank</a></span>()
<div class="jd-descrdiv">Returns the bean's rank; higher ranked beans override lower ranked beans.</div>
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">
abstract
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a>
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getSource()">getSource</a></span>()
<div class="jd-descrdiv">Returns an arbitrary object that indicates where this bean was configured.</div>
</td></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
T
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad"><a href="../../../org/eclipse/sisu/BeanEntry.html#getValue()">getValue</a></span>()
<div class="jd-descrdiv">Returns the associated instance of the bean; returns same instance for each call.</div>
</td></tr>
</table>
<!-- ========== METHOD SUMMARY =========== -->
<table id="inhmethods" class="jd-sumtable"><tr><th>
<a href="#" class="toggle-all" onclick="return toggleAllInherited(this, null)">[Expand]</a>
<div style="clear:left;">Inherited Methods</div></th></tr>
<tr class="api apilevel-" >
<td colspan="12">
<a href="#" onclick="return toggleInherited(this, null)" id="inherited-methods-java.util.Map.Entry" class="jd-expando-trigger closed"
><img id="inherited-methods-java.util.Map.Entry-trigger"
src="../../../../assets/images/triangle-closed.png"
class="jd-expando-trigger-img" /></a>
From interface
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/util/Map.Entry.html">java.util.Map.Entry</a>
<div id="inherited-methods-java.util.Map.Entry">
<div id="inherited-methods-java.util.Map.Entry-list"
class="jd-inheritedlinks">
</div>
<div id="inherited-methods-java.util.Map.Entry-summary" style="display: none;">
<table class="jd-sumtable-expando">
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
boolean
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">equals</span>(<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a> arg0)
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">
abstract
K
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">getKey</span>()
</td></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
V
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">getValue</span>()
</td></tr>
<tr class=" api apilevel-" >
<td class="jd-typecol">
abstract
int
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">hashCode</span>()
</td></tr>
<tr class="alt-color api apilevel-" >
<td class="jd-typecol">
abstract
V
</td>
<td class="jd-linkcol" width="100%">
<span class="sympad">setValue</span>(V arg0)
</td></tr>
</table>
</div>
</div>
</td></tr>
</table>
</div><!-- jd-descr (summary) -->
<!-- Details -->
<!-- XML Attributes -->
<!-- Enum Values -->
<!-- Constants -->
<!-- Fields -->
<!-- Public ctors -->
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<!-- Protected ctors -->
<!-- ========= METHOD DETAIL ======== -->
<!-- Public methdos -->
<h2>Public Methods</h2>
<a id="getDescription()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/String.html">String</a>
</span>
<span class="sympad">getDescription</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns a human-readable description of the bean; see @<code><a href="../../../org/eclipse/sisu/Description.html">Description</a></code>.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Human-readable description</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">See Also</h5>
<ul class="nolist"><li><code><a href="../../../org/eclipse/sisu/Description.html">Description</a></code></li>
</ul>
</div>
</div>
</div>
<a id="getImplementationClass()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/Class.html">Class</a>&lt;T&gt;
</span>
<span class="sympad">getImplementationClass</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Attempts to find the implementation type without creating the bean instance.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Implementation type; <code>null</code> if the type cannot be determined
</li></ul>
</div>
</div>
</div>
<a id="getKey()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
Q
</span>
<span class="sympad">getKey</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns the @Qualifier annotation associated with this particular bean.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Qualifier annotation
</li></ul>
</div>
</div>
</div>
<a id="getProvider()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
Provider&lt;T&gt;
</span>
<span class="sympad">getProvider</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns the underlying Provider; may support creation of multiple instances.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Bean provider
</li></ul>
</div>
</div>
</div>
<a id="getRank()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
int
</span>
<span class="sympad">getRank</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns the bean's rank; higher ranked beans override lower ranked beans.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Assigned rank</li></ul>
</div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">See Also</h5>
<ul class="nolist"><li><code><a href="../../../org/eclipse/sisu/inject/RankingFunction.html">RankingFunction</a></code></li>
</ul>
</div>
</div>
</div>
<a id="getSource()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
<a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/Object.html">Object</a>
</span>
<span class="sympad">getSource</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns an arbitrary object that indicates where this bean was configured.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Source location
</li></ul>
</div>
</div>
</div>
<a id="getValue()"></a>
<div class="jd-details api apilevel-">
<h4 class="jd-details-title">
<span class="normal">
public
abstract
T
</span>
<span class="sympad">getValue</span>
<span class="normal">()</span>
</h4>
<div class="api-level">
<div>
</div>
</div>
<div class="jd-details-descr">
<div class="jd-tagdata jd-tagdescr"><p>Returns the associated instance of the bean; returns same instance for each call.</p></div>
<div class="jd-tagdata">
<h5 class="jd-tagtitle">Returns</h5>
<ul class="nolist"><li>Bean instance (lazily-created)
</li></ul>
</div>
</div>
</div>
<!-- ========= METHOD DETAIL ======== -->
<!-- ========= END OF CLASS DATA ========= -->
<a id="navbar_top"></a>
<div id="footer">
Generated by <a href="http://code.google.com/p/doclava/">Doclava</a>.
</div> <!-- end footer -->
</div> <!-- jd-content -->
</div><!-- end doc-content -->
</div> <!-- end body-content -->
<script type="text/javascript">
init(); /* initialize doclava-developer-docs.js */
</script>
</body>
</html>