diff options
| author | Tavian Barnes <tavianator@tavianator.com> | 2014-10-04 13:09:39 -0400 |
|---|---|---|
| committer | Tavian Barnes <tavianator@tavianator.com> | 2014-10-04 13:09:39 -0400 |
| commit | 17b69d672f8e4f5e99f54256a4141320b0a846e0 (patch) | |
| tree | 1fc5d3c9680070cd751a09472f7cd6cba2e39deb /1.2/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html | |
| parent | 95bb12d092948a0e52f5fb2edd8e3c781efc2392 (diff) | |
| download | sangria-17b69d672f8e4f5e99f54256a4141320b0a846e0.tar.xz | |
Add version 1.2 site.
Diffstat (limited to '1.2/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html')
| -rw-r--r-- | 1.2/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html | 278 |
1 files changed, 278 insertions, 0 deletions
diff --git a/1.2/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html b/1.2/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html new file mode 100644 index 0000000..6cab40e --- /dev/null +++ b/1.2/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html @@ -0,0 +1,278 @@ +<!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 Sat Oct 04 13:08:12 EDT 2014 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ContextSensitiveProvider (Sangria 1.2 API)</title> +<meta name="date" content="2014-10-04"> +<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="ContextSensitiveProvider (Sangria 1.2 API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":6,"i1":6}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ContextSensitiveProvider.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-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveBindingVisitor.html" title="interface in com.tavianator.sangria.contextual"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProviderInstanceBinding.html" title="interface in com.tavianator.sangria.contextual"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/tavianator/sangria/contextual/ContextSensitiveProvider.html" target="_top">Frames</a></li> +<li><a href="ContextSensitiveProvider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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">com.tavianator.sangria.contextual</div> +<h2 title="Interface ContextSensitiveProvider" class="title">Interface ContextSensitiveProvider<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">ContextSensitiveProvider<T></span></pre> +<div class="block">Like a <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/Provider.html?is-external=true" title="class or interface in com.google.inject"><code>Provider</code></a>, but with knowledge of the target <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/spi/InjectionPoint.html?is-external=true" title="class or interface in com.google.inject.spi"><code>InjectionPoint</code></a>. + + <p> + This interface, along with <a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveBinder.html" title="class in com.tavianator.sangria.contextual"><code>ContextSensitiveBinder</code></a>, is useful for injecting custom logger types, among other + things. However, context-sensitive injections can make maintenance and debugging more difficult. + </p></div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>1.0</dd> +<dt><span class="simpleTagLabel">Version:</span></dt> +<dd>1.0</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Tavian Barnes (tavianator@tavianator.com)</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html" title="type parameter in ContextSensitiveProvider">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html#getInContext-com.google.inject.spi.InjectionPoint-">getInContext</a></span>(<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/spi/InjectionPoint.html?is-external=true" title="class or interface in com.google.inject.spi">InjectionPoint</a> injectionPoint)</code> +<div class="block">Provide an instance of <code>T</code> for the given context.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html" title="type parameter in ContextSensitiveProvider">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html#getInUnknownContext--">getInUnknownContext</a></span>()</code> +<div class="block">Provide an instance of <code>T</code> for an unknown context.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getInContext-com.google.inject.spi.InjectionPoint-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInContext</h4> +<pre><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html" title="type parameter in ContextSensitiveProvider">T</a> getInContext(<a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/spi/InjectionPoint.html?is-external=true" title="class or interface in com.google.inject.spi">InjectionPoint</a> injectionPoint)</pre> +<div class="block">Provide an instance of <code>T</code> for the given context.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>injectionPoint</code> - The <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/spi/InjectionPoint.html?is-external=true" title="class or interface in com.google.inject.spi"><code>InjectionPoint</code></a> for this provision.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An instance of <code>T</code>.</dd> +</dl> +</li> +</ul> +<a name="getInUnknownContext--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getInUnknownContext</h4> +<pre><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html" title="type parameter in ContextSensitiveProvider">T</a> getInUnknownContext()</pre> +<div class="block">Provide an instance of <code>T</code> for an unknown context. + <p> + The <a href="https://google.github.io/guice/api-docs/latest/javadoc/com/google/inject/spi/InjectionPoint.html?is-external=true" title="class or interface in com.google.inject.spi"><code>InjectionPoint</code></a> may not be known in all cases, for example if a <code>Provider<T></code> is used instead + of + a bare <code>T</code>. This method will be called in those cases. + </p> + <p> + One reasonable implementation is to return a generically applicable instance, such as an anonymous logger. + Another valid implementation is to throw an unchecked exception; in that case, <code>Provider<T></code> injections + will fail. + </p></div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>An instance of <code>T</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - If injection without a context is not supported.</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/ContextSensitiveProvider.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-all.html">Index</a></li> +<li><a href="../../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveBindingVisitor.html" title="interface in com.tavianator.sangria.contextual"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProviderInstanceBinding.html" title="interface in com.tavianator.sangria.contextual"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?com/tavianator/sangria/contextual/ContextSensitiveProvider.html" target="_top">Frames</a></li> +<li><a href="ContextSensitiveProvider.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>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method.detail">Method</a></li> +</ul> +</div> +<a name="skip.navbar.bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2014. All rights reserved.</small></p> +</body> +</html> |