http://git-wip-us.apache.org/repos/asf/spark-website/blob/26c57a24/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaSparkStatusTracker.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaSparkStatusTracker.html b/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaSparkStatusTracker.html new file mode 100644 index 0000000..eca95a7 --- /dev/null +++ b/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaSparkStatusTracker.html @@ -0,0 +1,354 @@ +<!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_144) on Wed Feb 28 00:07:14 PST 2018 --> +<title>JavaSparkStatusTracker (Spark 2.3.0 JavaDoc)</title> +<meta name="date" content="2018-02-28"> +<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="JavaSparkStatusTracker (Spark 2.3.0 JavaDoc)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../org/apache/spark/api/java/JavaSparkContext.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/JavaUtils.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/JavaSparkStatusTracker.html" target="_top">Frames</a></li> +<li><a href="JavaSparkStatusTracker.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">org.apache.spark.api.java</div> +<h2 title="Class JavaSparkStatusTracker" class="title">Class JavaSparkStatusTracker</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.api.java.JavaSparkStatusTracker</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">JavaSparkStatusTracker</span> +extends Object</pre> +<div class="block">Low-level status reporting APIs for monitoring job and stage progress. + <p> + These APIs intentionally provide very weak consistency semantics; consumers of these APIs should + be prepared to handle empty / missing information. For example, a job's stage ids may be known + but the status API may not have any information about the details of those stages, so + <code>getStageInfo</code> could potentially return <code>null</code> for a valid stage id. + <p> + To limit memory usage, these APIs only provide information on recent jobs / stages. These APIs + will provide information for the last <code>spark.ui.retainedStages</code> stages and + <code>spark.ui.retainedJobs</code> jobs. + <p></div> +<dl> +<dt><span class="simpleTagLabel">Note:</span></dt> +<dd>This class's constructor should be considered private and may be subject to change.</dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html#getActiveJobIds--">getActiveJobIds</a></span>()</code> +<div class="block">Returns an array containing the ids of all active jobs.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html#getActiveStageIds--">getActiveStageIds</a></span>()</code> +<div class="block">Returns an array containing the ids of all active stages.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html#getJobIdsForGroup-java.lang.String-">getJobIdsForGroup</a></span>(String jobGroup)</code> +<div class="block">Return a list of all known jobs in a particular job group.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/SparkJobInfo.html" title="interface in org.apache.spark">SparkJobInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html#getJobInfo-int-">getJobInfo</a></span>(int jobId)</code> +<div class="block">Returns job information, or <code>null</code> if the job info could not be found or was garbage collected.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/SparkStageInfo.html" title="interface in org.apache.spark">SparkStageInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html#getStageInfo-int-">getStageInfo</a></span>(int stageId)</code> +<div class="block">Returns stage information, or <code>null</code> if the stage info could not be found or was + garbage collected.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.Object"> +<!-- --> +</a> +<h3>Methods inherited from class Object</h3> +<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="getJobIdsForGroup-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobIdsForGroup</h4> +<pre>public int[] getJobIdsForGroup(String jobGroup)</pre> +<div class="block">Return a list of all known jobs in a particular job group. If <code>jobGroup</code> is <code>null</code>, then + returns all known jobs that are not associated with a job group. + <p> + The returned list may contain running, failed, and completed jobs, and may vary across + invocations of this method. This method does not guarantee the order of the elements in + its result.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobGroup</code> - (undocumented)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>(undocumented)</dd> +</dl> +</li> +</ul> +<a name="getActiveStageIds--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveStageIds</h4> +<pre>public int[] getActiveStageIds()</pre> +<div class="block">Returns an array containing the ids of all active stages. + <p> + This method does not guarantee the order of the elements in its result.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>(undocumented)</dd> +</dl> +</li> +</ul> +<a name="getActiveJobIds--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveJobIds</h4> +<pre>public int[] getActiveJobIds()</pre> +<div class="block">Returns an array containing the ids of all active jobs. + <p> + This method does not guarantee the order of the elements in its result.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>(undocumented)</dd> +</dl> +</li> +</ul> +<a name="getJobInfo-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getJobInfo</h4> +<pre>public <a href="../../../../../org/apache/spark/SparkJobInfo.html" title="interface in org.apache.spark">SparkJobInfo</a> getJobInfo(int jobId)</pre> +<div class="block">Returns job information, or <code>null</code> if the job info could not be found or was garbage collected.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>jobId</code> - (undocumented)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>(undocumented)</dd> +</dl> +</li> +</ul> +<a name="getStageInfo-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getStageInfo</h4> +<pre>public <a href="../../../../../org/apache/spark/SparkStageInfo.html" title="interface in org.apache.spark">SparkStageInfo</a> getStageInfo(int stageId)</pre> +<div class="block">Returns stage information, or <code>null</code> if the stage info could not be found or was + garbage collected.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>stageId</code> - (undocumented)</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>(undocumented)</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="../../../../../org/apache/spark/api/java/JavaSparkContext.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/JavaUtils.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/JavaSparkStatusTracker.html" target="_top">Frames</a></li> +<li><a href="JavaSparkStatusTracker.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 ======= --> +<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body> +</html>
http://git-wip-us.apache.org/repos/asf/spark-website/blob/26c57a24/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html b/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html new file mode 100644 index 0000000..9bd4526 --- /dev/null +++ b/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html @@ -0,0 +1,386 @@ +<!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_144) on Wed Feb 28 00:07:14 PST 2018 --> +<title>JavaUtils.SerializableMapWrapper (Spark 2.3.0 JavaDoc)</title> +<meta name="date" content="2018-02-28"> +<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="JavaUtils.SerializableMapWrapper (Spark 2.3.0 JavaDoc)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../org/apache/spark/api/java/JavaUtils.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" target="_top">Frames</a></li> +<li><a href="JavaUtils.SerializableMapWrapper.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><a href="#nested.classes.inherited.from.class.java.util.AbstractMap">Nested</a> | </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.spark.api.java</div> +<h2 title="Class JavaUtils.SerializableMapWrapper" class="title">Class JavaUtils.SerializableMapWrapper<A,B></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>java.util.AbstractMap<A,B></li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.api.java.JavaUtils.SerializableMapWrapper<A,B></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable, java.util.Map<A,B></dd> +</dl> +<dl> +<dt>Enclosing class:</dt> +<dd><a href="../../../../../org/apache/spark/api/java/JavaUtils.html" title="class in org.apache.spark.api.java">JavaUtils</a></dd> +</dl> +<hr> +<br> +<pre>public static class <span class="typeNameLabel">JavaUtils.SerializableMapWrapper<A,B></span> +extends java.util.AbstractMap<A,B> +implements java.io.Serializable</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.spark.api.java.JavaUtils.SerializableMapWrapper">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from class java.util.AbstractMap</h3> +<code>java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="nested.classes.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface java.util.Map</h3> +<code>java.util.Map.Entry<K,V></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html#SerializableMapWrapper-scala.collection.Map-">SerializableMapWrapper</a></span>(scala.collection.Map<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>> underlying)</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html#containsKey-java.lang.Object-">containsKey</a></span>(Object key)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html#entrySet--">entrySet</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html#get-java.lang.Object-">get</a></span>(Object key)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html#size--">size</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.AbstractMap"> +<!-- --> +</a> +<h3>Methods inherited from class java.util.AbstractMap</h3> +<code>clear, containsValue, equals, hashCode, isEmpty, keySet, put, putAll, remove, toString, values</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.Object"> +<!-- --> +</a> +<h3>Methods inherited from class Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.java.util.Map"> +<!-- --> +</a> +<h3>Methods inherited from interface java.util.Map</h3> +<code>compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll</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="SerializableMapWrapper-scala.collection.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SerializableMapWrapper</h4> +<pre>public SerializableMapWrapper(scala.collection.Map<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>> underlying)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="size--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>size</code> in interface <code>java.util.Map<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>size</code> in class <code>java.util.AbstractMap<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +</dl> +</li> +</ul> +<a name="containsKey-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsKey</h4> +<pre>public boolean containsKey(Object key)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>containsKey</code> in interface <code>java.util.Map<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>containsKey</code> in class <code>java.util.AbstractMap<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +</dl> +</li> +</ul> +<a name="get-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a> get(Object key)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>get</code> in interface <code>java.util.Map<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>get</code> in class <code>java.util.AbstractMap<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +</dl> +</li> +</ul> +<a name="entrySet--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>entrySet</h4> +<pre>public java.util.Set<java.util.Map.Entry<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>>> entrySet()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>entrySet</code> in interface <code>java.util.Map<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></code></dd> +<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> +<dd><code>entrySet</code> in class <code>java.util.AbstractMap<<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</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="../../../../../org/apache/spark/api/java/JavaUtils.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" target="_top">Frames</a></li> +<li><a href="JavaUtils.SerializableMapWrapper.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><a href="#nested.classes.inherited.from.class.java.util.AbstractMap">Nested</a> | </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 ======= --> +<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body> +</html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/26c57a24/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.html b/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.html new file mode 100644 index 0000000..00fcc8c --- /dev/null +++ b/site/docs/2.3.0/api/java/org/apache/spark/api/java/JavaUtils.html @@ -0,0 +1,301 @@ +<!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_144) on Wed Feb 28 00:07:14 PST 2018 --> +<title>JavaUtils (Spark 2.3.0 JavaDoc)</title> +<meta name="date" content="2018-02-28"> +<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="JavaUtils (Spark 2.3.0 JavaDoc)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/JavaUtils.html" target="_top">Frames</a></li> +<li><a href="JavaUtils.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><a href="#nested.class.summary">Nested</a> | </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.spark.api.java</div> +<h2 title="Class JavaUtils" class="title">Class JavaUtils</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.api.java.JavaUtils</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">JavaUtils</span> +extends Object</pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== NESTED CLASS SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="nested.class.summary"> +<!-- --> +</a> +<h3>Nested Class Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> +<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java">JavaUtils.SerializableMapWrapper</a><<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">A</a>,<a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="type parameter in JavaUtils.SerializableMapWrapper">B</a>></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.html#JavaUtils--">JavaUtils</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <A,B> <a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java">JavaUtils.SerializableMapWrapper</a><A,B></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.html#mapAsSerializableJavaMap-scala.collection.Map-">mapAsSerializableJavaMap</a></span>(scala.collection.Map<A,B> underlying)</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/JavaUtils.html#optionToOptional-scala.Option-">optionToOptional</a></span>(scala.Option<T> option)</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.Object"> +<!-- --> +</a> +<h3>Methods inherited from class Object</h3> +<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="JavaUtils--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>JavaUtils</h4> +<pre>public JavaUtils()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="optionToOptional-scala.Option-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>optionToOptional</h4> +<pre>public static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T> optionToOptional(scala.Option<T> option)</pre> +</li> +</ul> +<a name="mapAsSerializableJavaMap-scala.collection.Map-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>mapAsSerializableJavaMap</h4> +<pre>public static <A,B> <a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java">JavaUtils.SerializableMapWrapper</a><A,B> mapAsSerializableJavaMap(scala.collection.Map<A,B> underlying)</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> +<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="../../../../../org/apache/spark/api/java/JavaSparkStatusTracker.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/JavaUtils.html" target="_top">Frames</a></li> +<li><a href="JavaUtils.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><a href="#nested.class.summary">Nested</a> | </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 ======= --> +<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body> +</html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/26c57a24/site/docs/2.3.0/api/java/org/apache/spark/api/java/Optional.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.0/api/java/org/apache/spark/api/java/Optional.html b/site/docs/2.3.0/api/java/org/apache/spark/api/java/Optional.html new file mode 100644 index 0000000..b370b13 --- /dev/null +++ b/site/docs/2.3.0/api/java/org/apache/spark/api/java/Optional.html @@ -0,0 +1,514 @@ +<!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_144) on Wed Feb 28 00:07:14 PST 2018 --> +<title>Optional (Spark 2.3.0 JavaDoc)</title> +<meta name="date" content="2018-02-28"> +<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="Optional (Spark 2.3.0 JavaDoc)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":9,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/StorageLevels.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/Optional.html" target="_top">Frames</a></li> +<li><a href="Optional.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">org.apache.spark.api.java</div> +<h2 title="Class Optional" class="title">Class Optional<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.api.java.Optional<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt><span class="paramLabel">Type Parameters:</span></dt> +<dd><code>T</code> - type of value held inside</dd> +</dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">Optional<T></span> +extends Object +implements java.io.Serializable</pre> +<div class="block"><p>Like <code>java.util.Optional</code> in Java 8, <code>scala.Option</code> in Scala, and + <code>com.google.common.base.Optional</code> in Google Guava, this class represents a + value of a given type that may or may not exist. It is used in methods that wish + to optionally return a value, in preference to returning <code>null</code>.</p> + + <p>In fact, the class here is a reimplementation of the essential API of both + <code>java.util.Optional</code> and <code>com.google.common.base.Optional</code>. From + <code>java.util.Optional</code>, it implements:</p> + + <ul> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#empty--"><code>empty()</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#of-T-"><code>of(Object)</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#ofNullable-T-"><code>ofNullable(Object)</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#get--"><code>get()</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#orElse-T-"><code>orElse(Object)</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#isPresent--"><code>isPresent()</code></a></li> + </ul> + + <p>From <code>com.google.common.base.Optional</code> it implements:</p> + + <ul> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#absent--"><code>absent()</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#of-T-"><code>of(Object)</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#fromNullable-T-"><code>fromNullable(Object)</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#get--"><code>get()</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#or-T-"><code>or(Object)</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#orNull--"><code>orNull()</code></a></li> + <li><a href="../../../../../org/apache/spark/api/java/Optional.html#isPresent--"><code>isPresent()</code></a></li> + </ul> + + <p><code>java.util.Optional</code> itself was not used because at the time, the + project did not require Java 8. Using <code>com.google.common.base.Optional</code> + has in the past caused serious library version conflicts with Guava that can't + be resolved by shading. Hence this work-alike clone.</p></div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../../serialized-form.html#org.apache.spark.api.java.Optional">Serialized Form</a></dd> +</dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#absent--">absent</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#empty--">empty</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#equals-java.lang.Object-">equals</a></span>(Object obj)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#fromNullable-T-">fromNullable</a></span>(T value)</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#get--">get</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#hashCode--">hashCode</a></span>()</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#isPresent--">isPresent</a></span>()</code> </td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#of-T-">of</a></span>(T value)</code> </td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#ofNullable-T-">ofNullable</a></span>(T value)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#or-T-">or</a></span>(<a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> other)</code> </td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#orElse-T-">orElse</a></span>(<a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> other)</code> </td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#orNull--">orNull</a></span>()</code> </td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/Optional.html#toString--">toString</a></span>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.Object"> +<!-- --> +</a> +<h3>Methods inherited from class Object</h3> +<code>getClass, notify, notifyAll, wait, wait, wait</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="empty--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>empty</h4> +<pre>public static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T> empty()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an empty <code>Optional</code></dd> +</dl> +</li> +</ul> +<a name="of-java.lang.Object-"> +<!-- --> +</a><a name="of-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>of</h4> +<pre>public static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T> of(T value)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - non-null value to wrap</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>Optional</code> wrapping this value</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>NullPointerException</code> - if value is null</dd> +</dl> +</li> +</ul> +<a name="ofNullable-java.lang.Object-"> +<!-- --> +</a><a name="ofNullable-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ofNullable</h4> +<pre>public static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T> ofNullable(T value)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - value to wrap, which may be null</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>Optional</code> wrapping this value, which may be empty</dd> +</dl> +</li> +</ul> +<a name="get--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public <a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> get()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the value wrapped by this <code>Optional</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>NullPointerException</code> - if this is empty (contains no value)</dd> +</dl> +</li> +</ul> +<a name="orElse-java.lang.Object-"> +<!-- --> +</a><a name="orElse-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orElse</h4> +<pre>public <a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> orElse(<a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> other)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>other</code> - value to return if this is empty</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this <code>Optional</code>'s value if present, or else the given value</dd> +</dl> +</li> +</ul> +<a name="isPresent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isPresent</h4> +<pre>public boolean isPresent()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true iff this <code>Optional</code> contains a value (non-empty)</dd> +</dl> +</li> +</ul> +<a name="absent--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>absent</h4> +<pre>public static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T> absent()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>an empty <code>Optional</code></dd> +</dl> +</li> +</ul> +<a name="fromNullable-java.lang.Object-"> +<!-- --> +</a><a name="fromNullable-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>fromNullable</h4> +<pre>public static <T> <a href="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java">Optional</a><T> fromNullable(T value)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>value</code> - value to wrap, which may be null</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd><code>Optional</code> wrapping this value, which may be empty</dd> +</dl> +</li> +</ul> +<a name="or-java.lang.Object-"> +<!-- --> +</a><a name="or-T-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>or</h4> +<pre>public <a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> or(<a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> other)</pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>other</code> - value to return if this is empty</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this <code>Optional</code>'s value if present, or else the given value</dd> +</dl> +</li> +</ul> +<a name="orNull--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>orNull</h4> +<pre>public <a href="../../../../../org/apache/spark/api/java/Optional.html" title="type parameter in Optional">T</a> orNull()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>this <code>Optional</code>'s value if present, or else null</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(Object obj)</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>hashCode</code> in class <code>Object</code></dd> +</dl> +</li> +</ul> +<a name="toString--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public String toString()</pre> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>toString</code> in class <code>Object</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="../../../../../org/apache/spark/api/java/JavaUtils.SerializableMapWrapper.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/spark/api/java/StorageLevels.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/Optional.html" target="_top">Frames</a></li> +<li><a href="Optional.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 ======= --> +<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body> +</html> http://git-wip-us.apache.org/repos/asf/spark-website/blob/26c57a24/site/docs/2.3.0/api/java/org/apache/spark/api/java/StorageLevels.html ---------------------------------------------------------------------- diff --git a/site/docs/2.3.0/api/java/org/apache/spark/api/java/StorageLevels.html b/site/docs/2.3.0/api/java/org/apache/spark/api/java/StorageLevels.html new file mode 100644 index 0000000..a4a04d8 --- /dev/null +++ b/site/docs/2.3.0/api/java/org/apache/spark/api/java/StorageLevels.html @@ -0,0 +1,468 @@ +<!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_144) on Wed Feb 28 00:07:14 PST 2018 --> +<title>StorageLevels (Spark 2.3.0 JavaDoc)</title> +<meta name="date" content="2018-02-28"> +<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="StorageLevels (Spark 2.3.0 JavaDoc)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete 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="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/StorageLevels.html" target="_top">Frames</a></li> +<li><a href="StorageLevels.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.spark.api.java</div> +<h2 title="Class StorageLevels" class="title">Class StorageLevels</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.spark.api.java.StorageLevels</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">StorageLevels</span> +extends Object</pre> +<div class="block">Expose some commonly useful storage level constants.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#DISK_ONLY">DISK_ONLY</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#DISK_ONLY_2">DISK_ONLY_2</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_AND_DISK">MEMORY_AND_DISK</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_AND_DISK_2">MEMORY_AND_DISK_2</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_AND_DISK_SER">MEMORY_AND_DISK_SER</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_AND_DISK_SER_2">MEMORY_AND_DISK_SER_2</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_ONLY">MEMORY_ONLY</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_ONLY_2">MEMORY_ONLY_2</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_ONLY_SER">MEMORY_ONLY_SER</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#MEMORY_ONLY_SER_2">MEMORY_ONLY_SER_2</a></span></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#NONE">NONE</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#OFF_HEAP">OFF_HEAP</a></span></code> </td> +</tr> +</table> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#StorageLevels--">StorageLevels</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/spark/api/java/StorageLevels.html#create-boolean-boolean-boolean-boolean-int-">create</a></span>(boolean useDisk, + boolean useMemory, + boolean useOffHeap, + boolean deserialized, + int replication)</code> +<div class="block">Create a new StorageLevel object.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods.inherited.from.class.Object"> +<!-- --> +</a> +<h3>Methods inherited from class Object</h3> +<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field.detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="NONE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>NONE</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> NONE</pre> +</li> +</ul> +<a name="DISK_ONLY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DISK_ONLY</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> DISK_ONLY</pre> +</li> +</ul> +<a name="DISK_ONLY_2"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DISK_ONLY_2</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> DISK_ONLY_2</pre> +</li> +</ul> +<a name="MEMORY_ONLY"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_ONLY</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_ONLY</pre> +</li> +</ul> +<a name="MEMORY_ONLY_2"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_ONLY_2</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_ONLY_2</pre> +</li> +</ul> +<a name="MEMORY_ONLY_SER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_ONLY_SER</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_ONLY_SER</pre> +</li> +</ul> +<a name="MEMORY_ONLY_SER_2"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_ONLY_SER_2</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_ONLY_SER_2</pre> +</li> +</ul> +<a name="MEMORY_AND_DISK"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_AND_DISK</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_AND_DISK</pre> +</li> +</ul> +<a name="MEMORY_AND_DISK_2"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_AND_DISK_2</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_AND_DISK_2</pre> +</li> +</ul> +<a name="MEMORY_AND_DISK_SER"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_AND_DISK_SER</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_AND_DISK_SER</pre> +</li> +</ul> +<a name="MEMORY_AND_DISK_SER_2"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MEMORY_AND_DISK_SER_2</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> MEMORY_AND_DISK_SER_2</pre> +</li> +</ul> +<a name="OFF_HEAP"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>OFF_HEAP</h4> +<pre>public static final <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> OFF_HEAP</pre> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="StorageLevels--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>StorageLevels</h4> +<pre>public StorageLevels()</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-boolean-boolean-boolean-boolean-int-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/spark/storage/StorageLevel.html" title="class in org.apache.spark.storage">StorageLevel</a> create(boolean useDisk, + boolean useMemory, + boolean useOffHeap, + boolean deserialized, + int replication)</pre> +<div class="block">Create a new StorageLevel object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>useDisk</code> - saved to disk, if true</dd> +<dd><code>useMemory</code> - saved to on-heap memory, if true</dd> +<dd><code>useOffHeap</code> - saved to off-heap memory, if true</dd> +<dd><code>deserialized</code> - saved as deserialized objects, if true</dd> +<dd><code>replication</code> - replication factor</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="../../../../../org/apache/spark/api/java/Optional.html" title="class in org.apache.spark.api.java"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/spark/api/java/StorageLevels.html" target="_top">Frames</a></li> +<li><a href="StorageLevels.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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 ======= --> +<script defer="defer" type="text/javascript" src="../../../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../../../lib/api-javadocs.js"></script></body> +</html> --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
