| <!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> |
| |
| org.eclipse.sisu |
| |
| |
| | 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"> </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="api apilevel-"><a href="../../../org/eclipse/sisu/BeanEntry.html">BeanEntry</a><Q extends <a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>, T></li> |
| <li class="api apilevel-"><a href="../../../org/eclipse/sisu/Mediator.html">Mediator</a><Q extends <a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>, T, W></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="api-level"> |
| |
| |
| |
| |
| |
| |
| </div> |
| </div> |
| |
| <div id="jd-header"> |
| package |
| <h1>org.eclipse.sisu</h1> |
| </div><!-- end header --> |
| |
| <div id="naMessage"></div> |
| |
| <div id="jd-content" class="api apilevel-"> |
| |
| |
| <div class="jd-descr"> |
| Injectable API for Sisu components (a.k.a beans). |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| <h2>Interfaces</h2> |
| <div class="jd-sumtable"> |
| |
| <table class="jd-sumtable-expando"> |
| <tr class="alt-color api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/BeanEntry.html">BeanEntry</a><Q extends <a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>, T></td> |
| <td class="jd-descrcol" width="100%">Describes Qualified bean implementations of T:<br> |
| <br> |
| |
| <pre> |
| @Inject |
| Iterable<BeanEntry<Named, Command>> commands; |
| </pre> |
| |
| Use this when you want to know more about available beans; especially if you want to avoid creating instances. </td> |
| </tr> |
| <tr class=" api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Mediator.html">Mediator</a><Q extends <a href="http://docs.oracle.com/javase/6/docs/api/index.html?java/lang/annotation/Annotation.html">Annotation</a>, T, W></td> |
| <td class="jd-descrcol" width="100%">Watches for Qualified bean implementations of T:<br> |
| <br> |
| |
| <pre> |
| // add @Named for automatic registration |
| public class MyMediator |
| implements Mediator<Named, MyType, MyWatcher> |
| { |
| public void add( BeanEntry<Named, MyType> entry, MyWatcher watcher ) |
| throws Exception |
| { |
| // translate event to whatever the watcher expects |
| } |
| |
| public void remove( BeanEntry<Named, MyType> entry, MyWatcher watcher ) |
| throws Exception |
| { |
| // translate event to whatever the watcher expects |
| } |
| } |
| </pre> |
| |
| Mediator implementations must have a public no-arg constructor; they are neither injected nor injectable, acting |
| instead as stateless translators. </td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <h2>Annotations</h2> |
| <div class="jd-sumtable"> |
| |
| <table class="jd-sumtable-expando"> |
| <tr class="alt-color api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Description.html">Description</a></td> |
| <td class="jd-descrcol" width="100%">Describes a bean:<br> |
| <br> |
| |
| <pre> |
| @Named |
| @Description( "Summarizes system status" ) |
| public class SystemStatus |
| { |
| // |
| } |
| </pre> </td> |
| </tr> |
| <tr class=" api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Dynamic.html">Dynamic</a></td> |
| <td class="jd-descrcol" width="100%">Marks dependencies that should be dynamic proxies:<br> |
| <br> |
| |
| <pre> |
| @Inject |
| @Dynamic |
| Component proxy; |
| </pre> |
| </td> |
| </tr> |
| <tr class="alt-color api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/EagerSingleton.html">EagerSingleton</a></td> |
| <td class="jd-descrcol" width="100%">Marks beans that should be created as soon as possible:<br> |
| <br> |
| |
| <pre> |
| @Named |
| @EagerSingleton |
| public class Startup |
| { |
| // |
| } |
| </pre> |
| </td> |
| </tr> |
| <tr class=" api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Hidden.html">Hidden</a></td> |
| <td class="jd-descrcol" width="100%">Hides a bean from being located or watched:<br> |
| <br> |
| |
| <pre> |
| @Named |
| @Hidden |
| public class InternalComponent |
| { |
| // |
| } |
| </pre> </td> |
| </tr> |
| <tr class="alt-color api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Nullable.html">Nullable</a></td> |
| <td class="jd-descrcol" width="100%">Marks dependencies that can be <code>null</code>:<br> |
| <br> |
| |
| <pre> |
| @Inject |
| @Nullable |
| Component optional; |
| </pre> |
| </td> |
| </tr> |
| <tr class=" api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Parameters.html">Parameters</a></td> |
| <td class="jd-descrcol" width="100%">Qualifier of application parameters:<br> |
| <br> |
| |
| <pre> |
| @Inject |
| @Parameters |
| String[] args; |
| |
| @Inject |
| @Parameters |
| Map<?, ?> properties; |
| </pre> |
| |
| This qualifier marks collections of values that act as overall application parameters, like the <code>String[]</code> |
| argument array passed into the main method or the <code>Map</code> of system properties. </td> |
| </tr> |
| <tr class="alt-color api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Priority.html">Priority</a></td> |
| <td class="jd-descrcol" width="100%">Defines the priority ordering of a bean:<br> |
| <br> |
| |
| <pre> |
| @Named |
| @Priority( 999 ) |
| public class ImportantComponent |
| { |
| // |
| } |
| </pre> |
| </td> |
| </tr> |
| <tr class=" api apilevel-" > |
| <td class="jd-linkcol"><a href="../../../org/eclipse/sisu/Typed.html">Typed</a></td> |
| <td class="jd-descrcol" width="100%">Restricts the visible types of a bean:<br> |
| <br> |
| |
| <pre> |
| @Named |
| @Typed( Widget.class, Service.class ) |
| public class PrinterWidget |
| extends AbstractWidget |
| implements Service |
| { |
| // |
| } |
| </pre> |
| </td> |
| </tr> |
| </table> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div id="footer"> |
| Generated by <a href="http://code.google.com/p/doclava/">Doclava</a>. |
| </div> <!-- end footer --> |
| |
| </div><!-- end jd-content --> |
| </div><!-- doc-content --> |
| |
| </div> <!-- end body-content --> |
| |
| <script type="text/javascript"> |
| init(); /* initialize doclava-developer-docs.js */ |
| </script> |
| |
| </body> |
| </html> |
