http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/Config.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/Config.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/Config.html new file mode 100644 index 0000000..70d71dc --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/Config.html @@ -0,0 +1,672 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>Config (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="Config (samza-api 0.8.0-SNAPSHOT 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="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/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/Config.html" target="_top">Frames</a></li> +<li><a href="Config.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.samza.config</div> +<h2 title="Class Config" class="title">Class Config</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.config.Config</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Map<java.lang.String,java.lang.String></dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <span class="strong">Config</span> +extends java.lang.Object +implements java.util.Map<java.lang.String,java.lang.String></pre> +<div class="block">Store and retrieve named, typed values as configuration for classes implementing this interface.</div> +</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.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="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/samza/config/Config.html#Config()">Config</a></strong>()</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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#clear()">clear</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#get(java.lang.String,%20java.lang.String)">get</a></strong>(java.lang.String k, + java.lang.String defaultString)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String)">getBoolean</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String,%20boolean)">getBoolean</a></strong>(java.lang.String k, + boolean defaultValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><T> java.lang.Class<T></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getClass(java.lang.String)">getClass</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String)">getDate</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.util.Date)">getDate</a></strong>(java.lang.String k, + java.util.Date defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat)">getDate</a></strong>(java.lang.String k, + java.text.SimpleDateFormat format)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat,%20java.util.Date)">getDate</a></strong>(java.lang.String k, + java.text.SimpleDateFormat format, + java.util.Date defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String)">getDate</a></strong>(java.lang.String k, + java.lang.String format)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Date</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String,%20java.util.Date)">getDate</a></strong>(java.lang.String k, + java.lang.String format, + java.util.Date defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String)">getDouble</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>double</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String,%20double)">getDouble</a></strong>(java.lang.String k, + double defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String)">getInt</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String,%20int)">getInt</a></strong>(java.lang.String k, + int defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String)">getList</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.List<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String,%20java.util.List)">getList</a></strong>(java.lang.String k, + java.util.List<java.lang.String> defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String)">getLong</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String,%20long)">getLong</a></strong>(java.lang.String k, + long defaultValue)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><T> T</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getNewInstance(java.lang.String)">getNewInstance</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String)">getShort</a></strong>(java.lang.String k)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>short</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String,%20short)">getShort</a></strong>(java.lang.String k, + short defaultValue)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#put(java.lang.String,%20java.lang.String)">put</a></strong>(java.lang.String key, + java.lang.String value)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#putAll(java.util.Map)">putAll</a></strong>(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object s)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String)">subset</a></strong>(java.lang.String prefix)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String,%20boolean)">subset</a></strong>(java.lang.String prefix, + boolean stripPrefix)</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.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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>containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, size, values</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="Config()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Config</h4> +<pre>public Config()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="subset(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subset</h4> +<pre>public <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> subset(java.lang.String prefix)</pre> +</li> +</ul> +<a name="subset(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>subset</h4> +<pre>public <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> subset(java.lang.String prefix, + boolean stripPrefix)</pre> +</li> +</ul> +<a name="get(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.String get(java.lang.String k, + java.lang.String defaultString)</pre> +</li> +</ul> +<a name="getBoolean(java.lang.String, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(java.lang.String k, + boolean defaultValue)</pre> +</li> +</ul> +<a name="getBoolean(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBoolean</h4> +<pre>public boolean getBoolean(java.lang.String k)</pre> +</li> +</ul> +<a name="getShort(java.lang.String, short)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShort</h4> +<pre>public short getShort(java.lang.String k, + short defaultValue)</pre> +</li> +</ul> +<a name="getShort(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getShort</h4> +<pre>public short getShort(java.lang.String k)</pre> +</li> +</ul> +<a name="getLong(java.lang.String, long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLong</h4> +<pre>public long getLong(java.lang.String k, + long defaultValue)</pre> +</li> +</ul> +<a name="getLong(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLong</h4> +<pre>public long getLong(java.lang.String k)</pre> +</li> +</ul> +<a name="getInt(java.lang.String, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(java.lang.String k, + int defaultValue)</pre> +</li> +</ul> +<a name="getInt(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInt</h4> +<pre>public int getInt(java.lang.String k)</pre> +</li> +</ul> +<a name="getDouble(java.lang.String, double)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble(java.lang.String k, + double defaultValue)</pre> +</li> +</ul> +<a name="getDouble(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDouble</h4> +<pre>public double getDouble(java.lang.String k)</pre> +</li> +</ul> +<a name="getList(java.lang.String, java.util.List)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getList</h4> +<pre>public java.util.List<java.lang.String> getList(java.lang.String k, + java.util.List<java.lang.String> defaultValue)</pre> +</li> +</ul> +<a name="getList(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getList</h4> +<pre>public java.util.List<java.lang.String> getList(java.lang.String k)</pre> +</li> +</ul> +<a name="getClass(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getClass</h4> +<pre>public <T> java.lang.Class<T> getClass(java.lang.String k)</pre> +</li> +</ul> +<a name="getNewInstance(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNewInstance</h4> +<pre>public <T> T getNewInstance(java.lang.String k)</pre> +</li> +</ul> +<a name="getDate(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate(java.lang.String k)</pre> +</li> +</ul> +<a name="getDate(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate(java.lang.String k, + java.lang.String format)</pre> +</li> +</ul> +<a name="getDate(java.lang.String, java.text.SimpleDateFormat)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate(java.lang.String k, + java.text.SimpleDateFormat format)</pre> +</li> +</ul> +<a name="getDate(java.lang.String, java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate(java.lang.String k, + java.util.Date defaultValue)</pre> +</li> +</ul> +<a name="getDate(java.lang.String, java.lang.String, java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate(java.lang.String k, + java.lang.String format, + java.util.Date defaultValue)</pre> +</li> +</ul> +<a name="getDate(java.lang.String, java.text.SimpleDateFormat, java.util.Date)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDate</h4> +<pre>public java.util.Date getDate(java.lang.String k, + java.text.SimpleDateFormat format, + java.util.Date defaultValue)</pre> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void clear()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>clear</code> in interface <code>java.util.Map<java.lang.String,java.lang.String></code></dd> +</dl> +</li> +</ul> +<a name="put(java.lang.String, java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>put</h4> +<pre>public java.lang.String put(java.lang.String key, + java.lang.String value)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>put</code> in interface <code>java.util.Map<java.lang.String,java.lang.String></code></dd> +</dl> +</li> +</ul> +<a name="putAll(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>putAll</h4> +<pre>public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> m)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>putAll</code> in interface <code>java.util.Map<java.lang.String,java.lang.String></code></dd> +</dl> +</li> +</ul> +<a name="remove(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>remove</h4> +<pre>public java.lang.String remove(java.lang.Object s)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>remove</code> in interface <code>java.util.Map<java.lang.String,java.lang.String></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="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/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/Config.html" target="_top">Frames</a></li> +<li><a href="Config.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 ======= --> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigException.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigException.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigException.html new file mode 100644 index 0000000..6dec22b --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigException.html @@ -0,0 +1,285 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>ConfigException (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="ConfigException (samza-api 0.8.0-SNAPSHOT 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="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/samza/config/Config.html" title="class in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/ConfigException.html" target="_top">Frames</a></li> +<li><a href="ConfigException.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="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</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.samza.config</div> +<h2 title="Class ConfigException" class="title">Class ConfigException</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>java.lang.Throwable</li> +<li> +<ul class="inheritance"> +<li>java.lang.Exception</li> +<li> +<ul class="inheritance"> +<li>java.lang.RuntimeException</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza">org.apache.samza.SamzaException</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.config.ConfigException</li> +</ul> +</li> +</ul> +</li> +</ul> +</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</dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">ConfigException</span> +extends <a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza">SamzaException</a></pre> +<div class="block">Specific <a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza"><code>SamzaException</code></a>s thrown from <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.samza.config.ConfigException">Serialized Form</a></dd></dl> +</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/samza/config/ConfigException.html#ConfigException(java.lang.String)">ConfigException</a></strong>(java.lang.String msg)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/ConfigException.html#ConfigException(java.lang.String,%20java.lang.Throwable)">ConfigException</a></strong>(java.lang.String msg, + java.lang.Throwable e)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/ConfigException.html#ConfigException(java.lang.Throwable)">ConfigException</a></strong>(java.lang.Throwable e)</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Throwable"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Throwable</h3> +<code>addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString</code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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="ConfigException(java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigException</h4> +<pre>public ConfigException(java.lang.Throwable e)</pre> +</li> +</ul> +<a name="ConfigException(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ConfigException</h4> +<pre>public ConfigException(java.lang.String msg)</pre> +</li> +</ul> +<a name="ConfigException(java.lang.String, java.lang.Throwable)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ConfigException</h4> +<pre>public ConfigException(java.lang.String msg, + java.lang.Throwable e)</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="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/samza/config/Config.html" title="class in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/ConfigException.html" target="_top">Frames</a></li> +<li><a href="ConfigException.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="#methods_inherited_from_class_java.lang.Throwable">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li>Method</li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigFactory.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigFactory.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigFactory.html new file mode 100644 index 0000000..92c0844 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigFactory.html @@ -0,0 +1,210 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>ConfigFactory (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="ConfigFactory (samza-api 0.8.0-SNAPSHOT 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="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/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/ConfigFactory.html" target="_top">Frames</a></li> +<li><a href="ConfigFactory.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.samza.config</div> +<h2 title="Interface ConfigFactory" class="title">Interface ConfigFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ConfigFactory</span></pre> +<div class="block">Build a <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/ConfigFactory.html#getConfig(java.net.URI)">getConfig</a></strong>(java.net.URI configUri)</code> +<div class="block">Build a specific Config.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getConfig(java.net.URI)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getConfig</h4> +<pre><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> getConfig(java.net.URI configUri)</pre> +<div class="block">Build a specific Config.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>configUri</code> - Resource containing information necessary for this Config.</dd> +<dt><span class="strong">Returns:</span></dt><dd>Newly constructed Config.</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="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/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/ConfigFactory.html" target="_top">Frames</a></li> +<li><a href="ConfigFactory.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigRewriter.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigRewriter.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigRewriter.html new file mode 100644 index 0000000..86fd74a --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/ConfigRewriter.html @@ -0,0 +1,208 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>ConfigRewriter (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="ConfigRewriter (samza-api 0.8.0-SNAPSHOT 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="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/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/ConfigRewriter.html" target="_top">Frames</a></li> +<li><a href="ConfigRewriter.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.samza.config</div> +<h2 title="Interface ConfigRewriter" class="title">Interface ConfigRewriter</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="strong">ConfigRewriter</span></pre> +<div class="block">A ConfigRewriter receives the job's config during job startup and may re-write it to provide new configs, + remove existing configs or audit and verify the config is correct or permitted.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="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/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/ConfigRewriter.html#rewrite(java.lang.String,%20org.apache.samza.config.Config)">rewrite</a></strong>(java.lang.String name, + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</code> </td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="rewrite(java.lang.String, org.apache.samza.config.Config)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>rewrite</h4> +<pre><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> rewrite(java.lang.String name, + <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a> config)</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="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/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/ConfigRewriter.html" target="_top">Frames</a></li> +<li><a href="ConfigRewriter.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/MapConfig.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/MapConfig.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/MapConfig.html new file mode 100644 index 0000000..bbe7592 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/MapConfig.html @@ -0,0 +1,456 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>MapConfig (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="MapConfig (samza-api 0.8.0-SNAPSHOT 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="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/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/MapConfig.html" target="_top">Frames</a></li> +<li><a href="MapConfig.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.samza.config</div> +<h2 title="Class MapConfig" class="title">Class MapConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">org.apache.samza.config.Config</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.samza.config.MapConfig</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.util.Map<java.lang.String,java.lang.String></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">MapConfig</span> +extends <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></pre> +<div class="block">A <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> backed by a Java <code>Map</code></div> +</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.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="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/samza/config/MapConfig.html#MapConfig()">MapConfig</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#MapConfig(java.util.List)">MapConfig</a></strong>(java.util.List<java.util.Map<java.lang.String,java.lang.String>> maps)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#MapConfig(java.util.Map)">MapConfig</a></strong>(java.util.Map<java.lang.String,java.lang.String> map)</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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#containsKey(java.lang.Object)">containsKey</a></strong>(java.lang.Object k)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#containsValue(java.lang.Object)">containsValue</a></strong>(java.lang.Object v)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#entrySet()">entrySet</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object obj)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#get(java.lang.Object)">get</a></strong>(java.lang.Object k)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#isEmpty()">isEmpty</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Set<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#keySet()">keySet</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#size()">size</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#toString()">toString</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Collection<java.lang.String></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/samza/config/MapConfig.html#values()">values</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.samza.config.Config"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.samza.config.<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></h3> +<code><a href="../../../../org/apache/samza/config/Config.html#clear()">clear</a>, <a href="../../../../org/apache/samza/config/Config.html#get(java.lang.String,%20java.lang.String)">get</a>, <a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String)">getBoolean</a>, <a href="../../../../org/apache/samza/config/Config.html#getBoolean(java.lang.String,%20boolean)">getBoolean</a>, <a href="../../../../org/apache/samza/config/Config.html#getClass(java.lang.String)">getClass</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.util.Date)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.text.SimpleDateFormat,%20java.util.Date)">getDate</a>, <a hr ef="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDate(java.lang.String,%20java.lang.String,%20java.util.Date)">getDate</a>, <a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String)">getDouble</a>, <a href="../../../../org/apache/samza/config/Config.html#getDouble(java.lang.String,%20double)">getDouble</a>, <a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String)">getInt</a>, <a href="../../../../org/apache/samza/config/Config.html#getInt(java.lang.String,%20int)">getInt</a>, <a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String)">getList</a>, <a href="../../../../org/apache/samza/config/Config.html#getList(java.lang.String,%20java.util.List)">getList</a>, <a href="../../../../org/apache/samza/config/Config.html#getLong(java.lang.String)">getLong</a>, <a href="../../../../org/apache/ samza/config/Config.html#getLong(java.lang.String,%20long)">getLong</a>, <a href="../../../../org/apache/samza/config/Config.html#getNewInstance(java.lang.String)">getNewInstance</a>, <a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String)">getShort</a>, <a href="../../../../org/apache/samza/config/Config.html#getShort(java.lang.String,%20short)">getShort</a>, <a href="../../../../org/apache/samza/config/Config.html#put(java.lang.String,%20java.lang.String)">put</a>, <a href="../../../../org/apache/samza/config/Config.html#putAll(java.util.Map)">putAll</a>, <a href="../../../../org/apache/samza/config/Config.html#remove(java.lang.Object)">remove</a>, <a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String)">subset</a>, <a href="../../../../org/apache/samza/config/Config.html#subset(java.lang.String,%20boolean)">subset</a></code></li> +</ul> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.Object</h3> +<code>clone, finalize, getClass, notify, notifyAll, 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="MapConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MapConfig</h4> +<pre>public MapConfig()</pre> +</li> +</ul> +<a name="MapConfig(java.util.Map)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>MapConfig</h4> +<pre>public MapConfig(java.util.Map<java.lang.String,java.lang.String> map)</pre> +</li> +</ul> +<a name="MapConfig(java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>MapConfig</h4> +<pre>public MapConfig(java.util.List<java.util.Map<java.lang.String,java.lang.String>> maps)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="get(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>get</h4> +<pre>public java.lang.String get(java.lang.Object k)</pre> +</li> +</ul> +<a name="containsKey(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsKey</h4> +<pre>public boolean containsKey(java.lang.Object k)</pre> +</li> +</ul> +<a name="entrySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>entrySet</h4> +<pre>public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()</pre> +</li> +</ul> +<a name="isEmpty()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isEmpty</h4> +<pre>public boolean isEmpty()</pre> +</li> +</ul> +<a name="keySet()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>keySet</h4> +<pre>public java.util.Set<java.lang.String> keySet()</pre> +</li> +</ul> +<a name="size()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>size</h4> +<pre>public int size()</pre> +</li> +</ul> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public java.util.Collection<java.lang.String> values()</pre> +</li> +</ul> +<a name="containsValue(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>containsValue</h4> +<pre>public boolean containsValue(java.lang.Object v)</pre> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>hashCode</code> in interface <code>java.util.Map<java.lang.String,java.lang.String></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object obj)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>equals</code> in interface <code>java.util.Map<java.lang.String,java.lang.String></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>toString</h4> +<pre>public java.lang.String toString()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>toString</code> in class <code>java.lang.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><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="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/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/MapConfig.html" target="_top">Frames</a></li> +<li><a href="MapConfig.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 ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-frame.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-frame.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-frame.html new file mode 100644 index 0000000..c214c03 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-frame.html @@ -0,0 +1,29 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>org.apache.samza.config (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> +</head> +<body> +<h1 class="bar"><a href="../../../../org/apache/samza/config/package-summary.html" target="classFrame">org.apache.samza.config</a></h1> +<div class="indexContainer"> +<h2 title="Interfaces">Interfaces</h2> +<ul title="Interfaces"> +<li><a href="ConfigFactory.html" title="interface in org.apache.samza.config" target="classFrame"><i>ConfigFactory</i></a></li> +<li><a href="ConfigRewriter.html" title="interface in org.apache.samza.config" target="classFrame"><i>ConfigRewriter</i></a></li> +</ul> +<h2 title="Classes">Classes</h2> +<ul title="Classes"> +<li><a href="Config.html" title="class in org.apache.samza.config" target="classFrame">Config</a></li> +<li><a href="MapConfig.html" title="class in org.apache.samza.config" target="classFrame">MapConfig</a></li> +</ul> +<h2 title="Exceptions">Exceptions</h2> +<ul title="Exceptions"> +<li><a href="ConfigException.html" title="class in org.apache.samza.config" target="classFrame">ConfigException</a></li> +</ul> +</div> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-summary.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-summary.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-summary.html new file mode 100644 index 0000000..fde498a --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-summary.html @@ -0,0 +1,180 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>org.apache.samza.config (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="org.apache.samza.config (samza-api 0.8.0-SNAPSHOT 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 class="navBarCell1Rev">Package</li> +<li>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/samza/checkpoint/package-summary.html">Prev Package</a></li> +<li><a href="../../../../org/apache/samza/container/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 title="Package" class="title">Package org.apache.samza.config</h1> +</div> +<div class="contentContainer"> +<ul class="blockList"> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> +<caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Interface</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config">ConfigFactory</a></td> +<td class="colLast"> +<div class="block">Build a <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config">ConfigRewriter</a></td> +<td class="colLast"> +<div class="block">A ConfigRewriter receives the job's config during job startup and may re-write it to provide new configs, + remove existing configs or audit and verify the config is correct or permitted.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> +<caption><span>Class Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Class</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config">Config</a></td> +<td class="colLast"> +<div class="block">Store and retrieve named, typed values as configuration for classes implementing this interface.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config">MapConfig</a></td> +<td class="colLast"> +<div class="block">A <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a> backed by a Java <code>Map</code></div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> +<caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Exception</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="../../../../org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config">ConfigException</a></td> +<td class="colLast"> +<div class="block">Specific <a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza"><code>SamzaException</code></a>s thrown from <a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><code>Config</code></a></div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<!-- ======= 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 class="navBarCell1Rev">Package</li> +<li>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/samza/checkpoint/package-summary.html">Prev Package</a></li> +<li><a href="../../../../org/apache/samza/container/package-summary.html">Next Package</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/package-summary.html" target="_top">Frames</a></li> +<li><a href="package-summary.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-samza/blob/1e2cfe22/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-tree.html ---------------------------------------------------------------------- diff --git a/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-tree.html b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-tree.html new file mode 100644 index 0000000..0418a74 --- /dev/null +++ b/docs/learn/documentation/versioned/api/javadocs/org/apache/samza/config/package-tree.html @@ -0,0 +1,152 @@ +<!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_65) on Tue Aug 05 21:46:34 PDT 2014 --> +<title>org.apache.samza.config Class Hierarchy (samza-api 0.8.0-SNAPSHOT API)</title> +<meta name="date" content="2014-08-05"> +<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="org.apache.samza.config Class Hierarchy (samza-api 0.8.0-SNAPSHOT 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</li> +<li class="navBarCell1Rev">Tree</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/samza/checkpoint/package-tree.html">Prev</a></li> +<li><a href="../../../../org/apache/samza/container/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h1 class="title">Hierarchy For Package org.apache.samza.config</h1> +<span class="strong">Package Hierarchies:</span> +<ul class="horizontal"> +<li><a href="../../../../overview-tree.html">All Packages</a></li> +</ul> +</div> +<div class="contentContainer"> +<h2 title="Class Hierarchy">Class Hierarchy</h2> +<ul> +<li type="circle">java.lang.Object +<ul> +<li type="circle">org.apache.samza.config.<a href="../../../../org/apache/samza/config/Config.html" title="class in org.apache.samza.config"><span class="strong">Config</span></a> (implements java.util.Map<K,V>) +<ul> +<li type="circle">org.apache.samza.config.<a href="../../../../org/apache/samza/config/MapConfig.html" title="class in org.apache.samza.config"><span class="strong">MapConfig</span></a></li> +</ul> +</li> +<li type="circle">java.lang.Throwable (implements java.io.Serializable) +<ul> +<li type="circle">java.lang.Exception +<ul> +<li type="circle">java.lang.RuntimeException +<ul> +<li type="circle">org.apache.samza.<a href="../../../../org/apache/samza/SamzaException.html" title="class in org.apache.samza"><span class="strong">SamzaException</span></a> +<ul> +<li type="circle">org.apache.samza.config.<a href="../../../../org/apache/samza/config/ConfigException.html" title="class in org.apache.samza.config"><span class="strong">ConfigException</span></a></li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</li> +</ul> +<h2 title="Interface Hierarchy">Interface Hierarchy</h2> +<ul> +<li type="circle">org.apache.samza.config.<a href="../../../../org/apache/samza/config/ConfigFactory.html" title="interface in org.apache.samza.config"><span class="strong">ConfigFactory</span></a></li> +<li type="circle">org.apache.samza.config.<a href="../../../../org/apache/samza/config/ConfigRewriter.html" title="interface in org.apache.samza.config"><span class="strong">ConfigRewriter</span></a></li> +</ul> +</div> +<!-- ======= 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</li> +<li class="navBarCell1Rev">Tree</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/samza/checkpoint/package-tree.html">Prev</a></li> +<li><a href="../../../../org/apache/samza/container/package-tree.html">Next</a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/samza/config/package-tree.html" target="_top">Frames</a></li> +<li><a href="package-tree.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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +</body> +</html>
