blob: 1af0e0d879fc13c11b980d7c4aef3009ada7f8d5 [file] [log] [blame]
<!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_40) on Thu Jul 20 13:15:48 PDT 2017 -->
<title>ConfigStoreWithResolution (gobblin-config-core 0.11.0 API)</title>
<meta name="date" content="2017-07-20">
<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="ConfigStoreWithResolution (gobblin-config-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":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="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="../../../../gobblin/config/store/api/ConfigStoreWithImportedByRecursively.html" title="interface in gobblin.config.store.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/config/store/api/ConfigStoreWithStableVersioning.html" title="annotation in gobblin.config.store.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/config/store/api/ConfigStoreWithResolution.html" target="_top">Frames</a></li>
<li><a href="ConfigStoreWithResolution.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">gobblin.config.store.api</div>
<h2 title="Interface ConfigStoreWithResolution" class="title">Interface ConfigStoreWithResolution</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></dd>
</dl>
<hr>
<br>
<pre><a href="http://linkedin.github.io/gobblin/javadoc/0.11.0/gobblin-api/gobblin/annotation/Alpha.html?is-external=true" title="class or interface in gobblin.annotation">@Alpha</a>
public interface <span class="typeNameLabel">ConfigStoreWithResolution</span>
extends <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></pre>
<div class="block">The ConfigStoreWithResolution interface is used to indicate the <a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api"><code>ConfigStore</code></a> implementation
supports an efficient import configuration resolution for a given config key. The library will
delegate the import resolution to this implementation instead of performing it.
The resolution is performed by using the
<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true#withFallback-com.typesafe.config.ConfigMergeable-" title="class or interface in com.typesafe.config"><code>Config.withFallback(com.typesafe.config.ConfigMergeable)</code></a> in the correct order. See the
package documentation for more information on the order of import resolution.</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigStoreWithResolution.html#getImportsRecursively-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getImportsRecursively</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;version)</code>
<div class="block">Obtains the list of config keys which are directly and indirectly imported by the specified
config key.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigStoreWithResolution.html#getImportsRecursively-gobblin.config.store.api.ConfigKeyPath-java.lang.String-com.google.common.base.Optional-">getImportsRecursively</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;version,
<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&gt;&nbsp;runtimeConfig)</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigStoreWithResolution.html#getResolvedConfig-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getResolvedConfig</a></span>(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;version)</code>
<div class="block">Obtains a <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> object with all implicit and explicit imports resolved, i.e.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.gobblin.config.store.api.ConfigStore">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;gobblin.config.store.api.<a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface in gobblin.config.store.api">ConfigStore</a></h3>
<code><a href="../../../../gobblin/config/store/api/ConfigStore.html#getChildren-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getChildren</a>, <a href="../../../../gobblin/config/store/api/ConfigStore.html#getCurrentVersion--">getCurrentVersion</a>, <a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnConfig-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getOwnConfig</a>, <a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">getOwnImports</a>, <a href="../../../../gobblin/config/store/api/ConfigStore.html#getOwnImports-gobblin.config.store.api.ConfigKeyPath-java.lang.String-com.google.common.base.Optional-">getOwnImports</a>, <a href="../../../../gobblin/config/store/api/ConfigStore.html#getStoreURI--">getStoreURI</a></code></li>
</ul>
</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="getResolvedConfig-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResolvedConfig</h4>
<pre><a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&nbsp;getResolvedConfig(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;version)
throws <a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></pre>
<div class="block">Obtains a <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> object with all implicit and explicit imports resolved, i.e. specified
using the <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true#withFallback-com.typesafe.config.ConfigMergeable-" title="class or interface in com.typesafe.config"><code>Config.withFallback(com.typesafe.config.ConfigMergeable)</code></a> API.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - the path of the configuration key to be resolved</dd>
<dd><code>version</code> - the configuration version for resolution</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config"><code>Config</code></a> object associated with the specified config key with akk direct
and indirect imports resolved.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></code> - if the requested config version does not exist (any longer)</dd>
</dl>
</li>
</ul>
<a name="getImportsRecursively-gobblin.config.store.api.ConfigKeyPath-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImportsRecursively</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;&nbsp;getImportsRecursively(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;version)
throws <a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></pre>
<div class="block">Obtains the list of config keys which are directly and indirectly imported by the specified
config key. The import graph is traversed in depth-first manner. For a given config key,
explicit imports are listed before implicit imports from the ancestor keys.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>configKey</code> - the path of the config key whose imports are needed</dd>
<dd><code>version</code> - the configuration version to check</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the paths of the directly and indirectly imported keys, including config keys imported
by ancestors. The earlier config key in the list will have higher priority when resolving
configuration conflict.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></code> - if the requested config version does not exist (any longer)</dd>
</dl>
</li>
</ul>
<a name="getImportsRecursively-gobblin.config.store.api.ConfigKeyPath-java.lang.String-com.google.common.base.Optional-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getImportsRecursively</h4>
<pre><a href="https://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&gt;&nbsp;getImportsRecursively(<a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;configKey,
<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;version,
<a href="http://google.github.io/guava/releases/15.0/api/docs/com/google/common/base/Optional.html?is-external=true" title="class or interface in com.google.common.base">Optional</a>&lt;<a href="http://typesafehub.github.io/config/latest/api/com/typesafe/config/Config.html?is-external=true" title="class or interface in com.typesafe.config">Config</a>&gt;&nbsp;runtimeConfig)
throws <a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></pre>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../gobblin/config/store/api/VersionDoesNotExistException.html" title="class in gobblin.config.store.api">VersionDoesNotExistException</a></code></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="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="../../../../gobblin/config/store/api/ConfigStoreWithImportedByRecursively.html" title="interface in gobblin.config.store.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../gobblin/config/store/api/ConfigStoreWithStableVersioning.html" title="annotation in gobblin.config.store.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?gobblin/config/store/api/ConfigStoreWithResolution.html" target="_top">Frames</a></li>
<li><a href="ConfigStoreWithResolution.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>