blob: ba23001251204cd9b3026b2a9731b5036d2008d7 [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:47 PDT 2017 -->
<title>ConfigKeyPath (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="ConfigKeyPath (gobblin-config-core 0.11.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":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>Prev&nbsp;Class</li>
<li><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface 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/ConfigKeyPath.html" target="_top">Frames</a></li>
<li><a href="ConfigKeyPath.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 ConfigKeyPath" class="title">Interface ConfigKeyPath</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../gobblin/config/common/impl/SingleLinkedListConfigKeyPath.html" title="class in gobblin.config.common.impl">SingleLinkedListConfigKeyPath</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">ConfigKeyPath</span></pre>
<div class="block">The ConfigKeyPath is used to describe the relative path for a given configuration key URI to
the root URI of a config store (<a href="../../../../gobblin/config/store/api/ConfigStore.html#getStoreURI--"><code>ConfigStore.getStoreURI()</code></a>). For example,
for a configuration store with root URI hfs://namenode.grid.company.com:9000/configs/hfs_config_root/
and a config key URI hfs://namenode.grid.company.com:9000/configs/hfs_config_root/data/tracking/,
the ConfigKeyPath will be /data/tracking.</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="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html#createChild-java.lang.String-">createChild</a></span>(<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;childPathName)</code>
<div class="block">Creates a path that is a child of the current path by appending one component to the path.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html#getAbsolutePathString--">getAbsolutePathString</a></span>()</code>
<div class="block">The absolute configuration key path.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><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></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html#getOwnPathName--">getOwnPathName</a></span>()</code>
<div class="block">The last component of this path.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html#getParent--">getParent</a></span>()</code>
<div class="block">The path to the parent.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html#isRootPath--">isRootPath</a></span>()</code>
<div class="block">Check if the current path is the root path ("/").</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="getParent--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
<pre><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;getParent()</pre>
<div class="block">The path to the parent.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the current node is the root.</dd>
</dl>
</li>
</ul>
<a name="getOwnPathName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOwnPathName</h4>
<pre><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;getOwnPathName()</pre>
<div class="block">The last component of this path. For example, for /a/b/c, it will return "c". If the current
path points to the root ("/"), the result is the empty string "".</div>
</li>
</ul>
<a name="createChild-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChild</h4>
<pre><a href="../../../../gobblin/config/store/api/ConfigKeyPath.html" title="interface in gobblin.config.store.api">ConfigKeyPath</a>&nbsp;createChild(<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;childPathName)</pre>
<div class="block">Creates a path that is a child of the current path by appending one component to the path.
For example, if the current path points to "/a/b", createChild("c") will return a path that
points to "/a/b/c" .</div>
</li>
</ul>
<a name="getAbsolutePathString--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAbsolutePathString</h4>
<pre><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;getAbsolutePathString()</pre>
<div class="block">The absolute configuration key path. This is joining all path components from the root using
"/" as a separator.</div>
</li>
</ul>
<a name="isRootPath--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isRootPath</h4>
<pre>boolean&nbsp;isRootPath()</pre>
<div class="block">Check if the current path is the root path ("/").</div>
</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>Prev&nbsp;Class</li>
<li><a href="../../../../gobblin/config/store/api/ConfigStore.html" title="interface 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/ConfigKeyPath.html" target="_top">Frames</a></li>
<li><a href="ConfigKeyPath.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>