http://git-wip-us.apache.org/repos/asf/twill/blob/8abb84ac/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/FileContextLocationFactory.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/FileContextLocationFactory.html b/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/FileContextLocationFactory.html new file mode 100644 index 0000000..17feb71 --- /dev/null +++ b/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/FileContextLocationFactory.html @@ -0,0 +1,402 @@ +<!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_80) on Sat Apr 08 11:09:15 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>FileContextLocationFactory (Apache Twill 0.11.0 API)</title> +<meta name="date" content="2017-04-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="FileContextLocationFactory (Apache Twill 0.11.0 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="../../../../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/FileContextLocationFactory.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>Prev Class</li> +<li><a href="../../../../org/apache/twill/filesystem/ForwardingLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/filesystem/FileContextLocationFactory.html" target="_top">Frames</a></li> +<li><a href="FileContextLocationFactory.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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">org.apache.twill.filesystem</div> +<h2 title="Class FileContextLocationFactory" class="title">Class FileContextLocationFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.twill.filesystem.FileContextLocationFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">FileContextLocationFactory</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></pre> +<div class="block">A <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem"><code>LocationFactory</code></a> implementation that uses <code>FileContext</code> to create <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration)">FileContextLocationFactory</a></strong>(org.apache.hadoop.conf.Configuration configuration)</code> +<div class="block">Same as <a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>FileContextLocationFactory(configuration, "/")</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20org.apache.hadoop.fs.FileContext,%20java.lang.String)">FileContextLocationFactory</a></strong>(org.apache.hadoop.conf.Configuration configuration, + org.apache.hadoop.fs.FileContext fc, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pathBase)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>Use <a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration)"><code>FileContextLocationFactory(Configuration)</code></a> + or <a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>FileContextLocationFactory(Configuration, String)</code></a> instead. The <code>FileContext</code> + provided to this method will only be used if the current user calling any methods of this class + matches with the <code>UserGroupInformation</code> of the <code>FileContext</code> instance.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)">FileContextLocationFactory</a></strong>(org.apache.hadoop.conf.Configuration configuration, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pathBase)</code> +<div class="block">Creates a new instance.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#create(java.lang.String)">create</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> of the given path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#create(java.net.URI)">create</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</code> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> based on <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> <code>uri</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>org.apache.hadoop.conf.Configuration</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#getConfiguration()">getConfiguration</a></strong>()</code> +<div class="block">Returns the <code>Configuration</code> used by this <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem"><code>LocationFactory</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>org.apache.hadoop.fs.FileContext</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#getFileContext()">getFileContext</a></strong>()</code> +<div class="block">Returns the <code>FileContext</code> for the current user based on <code>UserGroupInformation.getCurrentUser()</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#getHomeLocation()">getHomeLocation</a></strong>()</code> +<div class="block">Returns the home location.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="FileContextLocationFactory(org.apache.hadoop.conf.Configuration)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FileContextLocationFactory</h4> +<pre>public FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration)</pre> +<div class="block">Same as <a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>FileContextLocationFactory(configuration, "/")</code></a>.</div> +</li> +</ul> +<a name="FileContextLocationFactory(org.apache.hadoop.conf.Configuration, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>FileContextLocationFactory</h4> +<pre>public FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pathBase)</pre> +<div class="block">Creates a new instance.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuration</code> - the hadoop configuration</dd><dd><code>pathBase</code> - base path for all non-absolute location created through this <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem"><code>LocationFactory</code></a>.</dd></dl> +</li> +</ul> +<a name="FileContextLocationFactory(org.apache.hadoop.conf.Configuration, org.apache.hadoop.fs.FileContext, java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FileContextLocationFactory</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> +public FileContextLocationFactory(org.apache.hadoop.conf.Configuration configuration, + org.apache.hadoop.fs.FileContext fc, + <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> pathBase)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>Use <a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration)"><code>FileContextLocationFactory(Configuration)</code></a> + or <a href="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html#FileContextLocationFactory(org.apache.hadoop.conf.Configuration,%20java.lang.String)"><code>FileContextLocationFactory(Configuration, String)</code></a> instead. The <code>FileContext</code> + provided to this method will only be used if the current user calling any methods of this class + matches with the <code>UserGroupInformation</code> of the <code>FileContext</code> instance.</i></div> +<div class="block">Creates a new instance with the given <code>FileContext</code> created from the given <code>Configuration</code>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configuration</code> - the hadoop configuration</dd><dd><code>fc</code> - <code>FileContext</code> instance created from the given configuration</dd><dd><code>pathBase</code> - base path for all non-absolute location created through this (@link LocationFactory}.</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.lang.String)">LocationFactory</a></code></strong></div> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> of the given path.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.lang.String)">create</a></code> in interface <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The path representing the location.</dd> +<dt><span class="strong">Returns:</span></dt><dd>An instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a>.</dd></dl> +</li> +</ul> +<a name="create(java.net.URI)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.net.URI)">LocationFactory</a></code></strong></div> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> based on <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> <code>uri</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.net.URI)">create</a></code> in interface <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - to the resource on the filesystem.</dd> +<dt><span class="strong">Returns:</span></dt><dd>An instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a></dd></dl> +</li> +</ul> +<a name="getHomeLocation()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHomeLocation</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a> getHomeLocation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#getHomeLocation()">LocationFactory</a></code></strong></div> +<div class="block">Returns the home location.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#getHomeLocation()">getHomeLocation</a></code> in interface <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></code></dd> +</dl> +</li> +</ul> +<a name="getFileContext()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFileContext</h4> +<pre>public org.apache.hadoop.fs.FileContext getFileContext()</pre> +<div class="block">Returns the <code>FileContext</code> for the current user based on <code>UserGroupInformation.getCurrentUser()</code>.</div> +<dl><dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if failed to determine the current user or fail to create the FileContext.</dd> +<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 failed to get the <code>FileContext</code> object for the current user due to exception</dd></dl> +</li> +</ul> +<a name="getConfiguration()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConfiguration</h4> +<pre>public org.apache.hadoop.conf.Configuration getConfiguration()</pre> +<div class="block">Returns the <code>Configuration</code> used by this <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem"><code>LocationFactory</code></a>.</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/FileContextLocationFactory.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>Prev Class</li> +<li><a href="../../../../org/apache/twill/filesystem/ForwardingLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/filesystem/FileContextLocationFactory.html" target="_top">Frames</a></li> +<li><a href="FileContextLocationFactory.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 © 2013-2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/twill/blob/8abb84ac/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/ForwardingLocationFactory.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/ForwardingLocationFactory.html b/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/ForwardingLocationFactory.html new file mode 100644 index 0000000..8f54461 --- /dev/null +++ b/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/ForwardingLocationFactory.html @@ -0,0 +1,272 @@ +<!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_80) on Sat Apr 08 11:09:15 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>ForwardingLocationFactory (Apache Twill 0.11.0 API)</title> +<meta name="date" content="2017-04-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="ForwardingLocationFactory (Apache Twill 0.11.0 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="../../../../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/ForwardingLocationFactory.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="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/filesystem/ForwardingLocationFactory.html" target="_top">Frames</a></li> +<li><a href="ForwardingLocationFactory.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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">org.apache.twill.filesystem</div> +<h2 title="Class ForwardingLocationFactory" class="title">Class ForwardingLocationFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.twill.filesystem.ForwardingLocationFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">ForwardingLocationFactory</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier</th> +<th class="colLast" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>protected </code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/ForwardingLocationFactory.html#ForwardingLocationFactory(org.apache.twill.filesystem.LocationFactory)">ForwardingLocationFactory</a></strong>(<a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a> delegate)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/ForwardingLocationFactory.html#getDelegate()">getDelegate</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.twill.filesystem.LocationFactory"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.twill.filesystem.<a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></h3> +<code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.lang.String)">create</a>, <a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.net.URI)">create</a>, <a href="../../../../org/apache/twill/filesystem/LocationFactory.html#getHomeLocation()">getHomeLocation</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ForwardingLocationFactory(org.apache.twill.filesystem.LocationFactory)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ForwardingLocationFactory</h4> +<pre>protected ForwardingLocationFactory(<a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a> delegate)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getDelegate()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getDelegate</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a> getDelegate()</pre> +</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="../../../../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/ForwardingLocationFactory.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="../../../../org/apache/twill/filesystem/FileContextLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/filesystem/ForwardingLocationFactory.html" target="_top">Frames</a></li> +<li><a href="ForwardingLocationFactory.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 © 2013-2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/twill/blob/8abb84ac/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/LocalLocationFactory.html ---------------------------------------------------------------------- diff --git a/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/LocalLocationFactory.html b/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/LocalLocationFactory.html new file mode 100644 index 0000000..c99aa0c --- /dev/null +++ b/src/site/resources/apidocs-0.11.0/org/apache/twill/filesystem/LocalLocationFactory.html @@ -0,0 +1,331 @@ +<!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_80) on Sat Apr 08 11:09:15 PDT 2017 --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>LocalLocationFactory (Apache Twill 0.11.0 API)</title> +<meta name="date" content="2017-04-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="LocalLocationFactory (Apache Twill 0.11.0 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="../../../../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/LocalLocationFactory.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="../../../../org/apache/twill/filesystem/ForwardingLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/filesystem/LocalLocationFactory.html" target="_top">Frames</a></li> +<li><a href="LocalLocationFactory.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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">org.apache.twill.filesystem</div> +<h2 title="Class LocalLocationFactory" class="title">Class LocalLocationFactory</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.twill.filesystem.LocalLocationFactory</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></dd> +</dl> +<hr> +<br> +<pre>public final class <span class="strong">LocalLocationFactory</span> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></pre> +<div class="block">A <a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem"><code>LocationFactory</code></a> for creating local file <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html#LocalLocationFactory()">LocalLocationFactory</a></strong>()</code> +<div class="block">Constructs a LocalLocationFactory that Location created will be relative to system root.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html#LocalLocationFactory(java.io.File)">LocalLocationFactory</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basePath)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== 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="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html#create(java.lang.String)">create</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</code> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> of the given path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html#create(java.net.URI)">create</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</code> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> based on <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> <code>uri</code>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/twill/filesystem/LocalLocationFactory.html#getHomeLocation()">getHomeLocation</a></strong>()</code> +<div class="block">Returns the home location.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="LocalLocationFactory()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>LocalLocationFactory</h4> +<pre>public LocalLocationFactory()</pre> +<div class="block">Constructs a LocalLocationFactory that Location created will be relative to system root.</div> +</li> +</ul> +<a name="LocalLocationFactory(java.io.File)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>LocalLocationFactory</h4> +<pre>public LocalLocationFactory(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> basePath)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> path)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.lang.String)">LocationFactory</a></code></strong></div> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> of the given path.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.lang.String)">create</a></code> in interface <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - The path representing the location.</dd> +<dt><span class="strong">Returns:</span></dt><dd>An instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a>.</dd></dl> +</li> +</ul> +<a name="create(java.net.URI)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a> create(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> uri)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.net.URI)">LocationFactory</a></code></strong></div> +<div class="block">Creates an instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a> based on <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net"><code>URI</code></a> <code>uri</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#create(java.net.URI)">create</a></code> in interface <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</a></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>uri</code> - to the resource on the filesystem.</dd> +<dt><span class="strong">Returns:</span></dt><dd>An instance of <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><code>Location</code></a></dd></dl> +</li> +</ul> +<a name="getHomeLocation()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getHomeLocation</h4> +<pre>public <a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem">Location</a> getHomeLocation()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#getHomeLocation()">LocationFactory</a></code></strong></div> +<div class="block">Returns the home location.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html#getHomeLocation()">getHomeLocation</a></code> in interface <code><a href="../../../../org/apache/twill/filesystem/LocationFactory.html" title="interface in org.apache.twill.filesystem">LocationFactory</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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/LocalLocationFactory.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="../../../../org/apache/twill/filesystem/ForwardingLocationFactory.html" title="class in org.apache.twill.filesystem"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/twill/filesystem/Location.html" title="interface in org.apache.twill.filesystem"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/twill/filesystem/LocalLocationFactory.html" target="_top">Frames</a></li> +<li><a href="LocalLocationFactory.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><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </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 © 2013-2016 <a href="http://www.apache.org">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
