339 lines
24 KiB
HTML
339 lines
24 KiB
HTML
<!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_51) on Wed Apr 06 13:11:06 EDT 2016 -->
|
|
<title>SourceConfig (Parallel Java 2 Library Documentation)</title>
|
|
<meta name="date" content="2016-04-06">
|
|
<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="SourceConfig (Parallel Java 2 Library Documentation)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/SourceConfig.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/pjmr/TextDirectorySource.html" title="class in edu.rit.pjmr"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/pjmr/SourceConfig.html" target="_top">Frames</a></li>
|
|
<li><a href="SourceConfig.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">edu.rit.pjmr</div>
|
|
<h2 title="Class SourceConfig" class="title">Class SourceConfig<IK,IV,OK,OV extends <a href="../../../edu/rit/pj2/Vbl.html" title="interface in edu.rit.pj2">Vbl</a>></h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>edu.rit.pjmr.SourceConfig<IK,IV,OK,OV></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>IK</code> - Mapper input key data type.</dd><dd><code>IV</code> - Mapper input value data type.</dd><dd><code>OK</code> - Mapper output key data type.</dd><dd><code>OV</code> - Mapper output value data type; must implement interface
|
|
<a href="../../../edu/rit/pj2/Vbl.html" title="interface in edu.rit.pj2">Vbl</a>.</dd></dl>
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="../../../edu/rit/io/Streamable.html" title="interface in edu.rit.io">Streamable</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">SourceConfig<IK,IV,OK,OV extends <a href="../../../edu/rit/pj2/Vbl.html" title="interface in edu.rit.pj2">Vbl</a>></span>
|
|
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
|
|
implements <a href="../../../edu/rit/io/Streamable.html" title="interface in edu.rit.io">Streamable</a></pre>
|
|
<div class="block">Class SourceConfig contains specifications for configuring a <a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr">Source</a> in a mapper task.</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><T extends <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>>> <br><a href="../../../edu/rit/pjmr/MapperConfig.html" title="class in edu.rit.pjmr">MapperConfig</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/SourceConfig.html#mapper(java.lang.Class, java.lang.String...)">mapper</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> mapperClass,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code>
|
|
<div class="block">Add the given <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a> to this source.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><T extends <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>>> <br><a href="../../../edu/rit/pjmr/MapperConfig.html" title="class in edu.rit.pjmr">MapperConfig</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/SourceConfig.html#mapper(int, java.lang.Class, java.lang.String...)">mapper</a></strong>(int copies,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> mapperClass,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</code>
|
|
<div class="block">Add the given number of copies of the given <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a> to this
|
|
source.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/SourceConfig.html#readIn(edu.rit.io.InStream)">readIn</a></strong>(<a href="../../../edu/rit/io/InStream.html" title="class in edu.rit.io">InStream</a> in)</code>
|
|
<div class="block">Read this source config object from the given in stream.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../edu/rit/pjmr/SourceConfig.html" title="class in edu.rit.pjmr">SourceConfig</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/SourceConfig.html#source(edu.rit.pjmr.Source)">source</a></strong>(<a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr">Source</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>> source)</code>
|
|
<div class="block">Add the given <a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr">Source</a> to this source's mapper task.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../edu/rit/pjmr/SourceConfig.html#writeOut(edu.rit.io.OutStream)">writeOut</a></strong>(<a href="../../../edu/rit/io/OutStream.html" title="class in edu.rit.io">OutStream</a> out)</code>
|
|
<div class="block">Write this source config object to the given out stream.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="mapper(java.lang.Class, java.lang.String...)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mapper</h4>
|
|
<pre>public <T extends <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>>> <a href="../../../edu/rit/pjmr/MapperConfig.html" title="class in edu.rit.pjmr">MapperConfig</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>> mapper(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> mapperClass,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre>
|
|
<div class="block">Add the given <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a> to this source. A source must have at
|
|
least one mapper; it may have more than one mapper. The argument strings
|
|
for the mapper, if any, may also be specified.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mapperClass</code> - Mapper class.</dd><dd><code>args</code> - Zero or more argument strings for the mapper.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>Mapper config object for <TT>mapperClass</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>mapperClass</TT> is null.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="mapper(int, java.lang.Class, java.lang.String...)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mapper</h4>
|
|
<pre>public <T extends <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>>> <a href="../../../edu/rit/pjmr/MapperConfig.html" title="class in edu.rit.pjmr">MapperConfig</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>> mapper(int copies,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><T> mapperClass,
|
|
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>... args)</pre>
|
|
<div class="block">Add the given number of copies of the given <a href="../../../edu/rit/pjmr/Mapper.html" title="class in edu.rit.pjmr">Mapper</a> to this
|
|
source. A source must have at least one mapper; it may have more than one
|
|
mapper. The argument strings for the mappers, if any, may also be
|
|
specified; each mapper has the same argument strings.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>copies</code> - Number of copies to add (≥ 1).</dd><dd><code>mapperClass</code> - Mapper class.</dd><dd><code>args</code> - Zero or more argument strings for the mappers.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>Mapper config object for <TT>mapperClass</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - (unchecked exception) Thrown if <TT>copies</TT> < 1.</dd>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>mapperClass</TT> is null.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="source(edu.rit.pjmr.Source)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>source</h4>
|
|
<pre>public <a href="../../../edu/rit/pjmr/SourceConfig.html" title="class in edu.rit.pjmr">SourceConfig</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">OV</a>> source(<a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr">Source</a><<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IK</a>,<a href="../../../edu/rit/pjmr/SourceConfig.html" title="type parameter in SourceConfig">IV</a>> source)</pre>
|
|
<div class="block">Add the given <a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr">Source</a> to this source's mapper task. For
|
|
further information, see <a href="../../../edu/rit/pjmr/MapperTaskConfig.html#source(edu.rit.pjmr.Source)"><code>MapperTaskConfig.source()</code></a>.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source.</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>Source config object for <TT>source</TT>.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - (unchecked exception) Thrown if <TT>source</TT> is null.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="writeOut(edu.rit.io.OutStream)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>writeOut</h4>
|
|
<pre>public void writeOut(<a href="../../../edu/rit/io/OutStream.html" title="class in edu.rit.io">OutStream</a> out)
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block">Write this source config object to the given out stream.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../edu/rit/io/Streamable.html#writeOut(edu.rit.io.OutStream)">writeOut</a></code> in interface <code><a href="../../../edu/rit/io/Streamable.html" title="interface in edu.rit.io">Streamable</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>out</code> - Out stream.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown if an I/O error occurred.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="readIn(edu.rit.io.InStream)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>readIn</h4>
|
|
<pre>public void readIn(<a href="../../../edu/rit/io/InStream.html" title="class in edu.rit.io">InStream</a> in)
|
|
throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
|
|
<div class="block">Read this source config object from the given in stream.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<dd><code><a href="../../../edu/rit/io/Streamable.html#readIn(edu.rit.io.InStream)">readIn</a></code> in interface <code><a href="../../../edu/rit/io/Streamable.html" title="interface in edu.rit.io">Streamable</a></code></dd>
|
|
<dt><span class="strong">Parameters:</span></dt><dd><code>in</code> - In stream.</dd>
|
|
<dt><span class="strong">Throws:</span></dt>
|
|
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - Thrown if an I/O error occurred.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/SourceConfig.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../edu/rit/pjmr/Source.html" title="interface in edu.rit.pjmr"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../edu/rit/pjmr/TextDirectorySource.html" title="class in edu.rit.pjmr"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?edu/rit/pjmr/SourceConfig.html" target="_top">Frames</a></li>
|
|
<li><a href="SourceConfig.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 ======= -->
|
|
<p class="legalCopy"><small><FONT SIZE="-2">Copyright © 2013–2016 by Alan Kaminsky. All rights reserved. Send comments to ark</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">@</FONT><FONT SIZE="1" COLOR="#FFFFFF">­</FONT><FONT SIZE="-2">cs.rit.edu.</FONT></small></p>
|
|
</body>
|
|
</html>
|