diff options
Diffstat (limited to '1.3/sangria-contextual/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html')
| -rw-r--r-- | 1.3/sangria-contextual/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html | 252 |
1 files changed, 252 insertions, 0 deletions
diff --git a/1.3/sangria-contextual/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html b/1.3/sangria-contextual/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html new file mode 100644 index 0000000..262b3df --- /dev/null +++ b/1.3/sangria-contextual/apidocs/com/tavianator/sangria/contextual/ContextSensitiveProvider.html @@ -0,0 +1,252 @@ +<!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 (version 1.7.0_79) on Fri May 08 20:52:36 EDT 2015 --> +<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> +<title>ContextSensitiveProvider (Sangria Contextual 1.3 API)</title> +<meta name="date" content="2015-05-08"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="ContextSensitiveProvider (Sangria Contextual 1.3 API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../com/tavianator/sangria/contextual/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="strong">Prev Class</span></a></li> +<li><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProviderInstanceBinding.html" title="interface in com.tavianator.sangria.contextual"><span class="strong">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="strong">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="strong">Since:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>1.0</dd> +<dt><span class="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr 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><strong><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html#getInContext(com.google.inject.spi.InjectionPoint)">getInContext</a></strong>(<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 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><strong><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProvider.html#getInUnknownContext()">getInUnknownContext</a></strong>()</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="strong">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="strong">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="strong">Returns:</span></dt><dd>An instance of <code>T</code></dd> +<dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../com/tavianator/sangria/contextual/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="strong">Prev Class</span></a></li> +<li><a href="../../../../com/tavianator/sangria/contextual/ContextSensitiveProviderInstanceBinding.html" title="interface in com.tavianator.sangria.contextual"><span class="strong">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–2015. All rights reserved.</small></p> +</body> +</html> |