unimore/oop-2020-steffo-cleaver
unimore/oop-2020-steffo-cleaver
1
Fork 0
mirror of https://github.com/Steffo99/unimore-oop-2020-cleaver.git synced 2024-11-23 08:34:19 +00:00
Code Activity
oop-2020-steffo-cleaver/docs/eu.steffo.cleaver/eu/steffo/cleaver/logic/split/SplitConfig.html

331 lines
18 KiB
HTML
Raw Normal View History

2019-12-05-2
2019-12-06 01:14:13 +00:00
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="it">
<head>
Progress was done!
2020-01-05 17:46:32 +00:00
<!-- Generated by javadoc (13.0.1) on Sun Jan 05 18:44:04 CET 2020 -->
2019-12-05-2
2019-12-06 01:14:13 +00:00
<title>SplitConfig</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
Move a few things around
2020-01-05 15:50:06 +00:00
<meta name="dc.created" content="2020-01-05">
<meta name="description" content="declaration: module: eu.steffo.cleaver, package: eu.steffo.cleaver.logic.split, class: SplitConfig">
2019-12-05-2
2019-12-06 01:14:13 +00:00
<meta name="generator" content="javadoc/ClassWriterImpl">
Move a few things around
2020-01-05 15:50:06 +00:00
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jszip-utils/dist/jszip-utils.min.js"></script>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<!--[if IE]>
Move a few things around
2020-01-05 15:50:06 +00:00
<script type="text/javascript" src="../../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<![endif]-->
Move a few things around
2020-01-05 15:50:06 +00:00
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.js"></script>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</head>
<body class="class-declaration">
Progress was done!
2020-01-05 17:46:32 +00:00
<script type="text/javascript">var data = {"i0":6,"i1":6,"i2":6,"i3":10,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
Move a few things around
2020-01-05 15:50:06 +00:00
var pathtoroot = "../../../../../../";
2019-12-05-2
2019-12-06 01:14:13 +00:00
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
Move a few things around
2020-01-05 15:50:06 +00:00
<li><a href="../../../../../module-summary.html">Module</a></li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
Move a few things around
2020-01-05 15:50:06 +00:00
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
<li><a href="#method.detail">Method</a></li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</ul>
</div>
<div class="navListSearch"><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</div>
</div>
<a id="skip.navbar.top">
<!-- -->
</a>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
Move a few things around
2020-01-05 15:50:06 +00:00
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../../module-summary.html">eu.steffo.cleaver</a></div>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">eu.steffo.cleaver.logic.split</a></div>
<h1 title="Class SplitConfig" class="title">Class SplitConfig</h1>
</div>
<div class="contentContainer">
Progress was done!
2020-01-05 17:46:32 +00:00
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<div class="inheritance">eu.steffo.cleaver.logic.split.SplitConfig</div>
</div>
<section class="description">
<dl>
<dt>Direct Known Subclasses:</dt>
Progress was done!
2020-01-05 17:46:32 +00:00
<dd><code><a href="MergeConfig.html" title="class in eu.steffo.cleaver.logic.split">MergeConfig</a></code>, <code><a href="SplitByPartsConfig.html" title="class in eu.steffo.cleaver.logic.split">SplitByPartsConfig</a></code>, <code><a href="SplitBySizeConfig.html" title="class in eu.steffo.cleaver.logic.split">SplitBySizeConfig</a></code></dd>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</dl>
<hr>
2019-12-06
2019-12-07 00:09:56 +00:00
<pre>public abstract class <span class="typeNameLabel">SplitConfig</span>
Progress was done!
2020-01-05 17:46:32 +00:00
extends <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></pre>
Move a few things around
2020-01-05 15:50:06 +00:00
<div class="block">A class containing the configuration for the split/merge step of a <a href="../Job.html" title="class in eu.steffo.cleaver.logic"><code>Job</code></a>.</div>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</section>
<section class="summary">
<ul class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li class="blockList">
<section class="constructorSummary"><a id="constructor.summary">
<!-- -->
</a>
<h2>Constructor Summary</h2>
<div class="memberSummary">
<table>
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<thead>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">SplitConfig</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li class="blockList">
<section class="methodSummary"><a id="method.summary">
<!-- -->
</a>
<h2>Method Summary</h2>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
<div class="memberSummary">
Progress was done!
2020-01-05 17:46:32 +00:00
<div role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="memberSummary_tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="activeTableTab">All Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="tableTab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="tableTab" onclick="show(4);">Abstract Methods</button><button role="tab" aria-selected="false" aria-controls="memberSummary_tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
<div id="memberSummary_tabpanel" role="tabpanel">
<table aria-labelledby="t0">
<thead>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr class="altColor" id="i0">
Progress was done!
2020-01-05 17:46:32 +00:00
<td class="colFirst"><code>abstract int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartCount()">getPartCount</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i1">
<td class="colFirst"><code>abstract long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPartSize()">getPartSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor" id="i2">
<td class="colFirst"><code>abstract long</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTotalSize()">getTotalSize</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor" id="i3">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Element</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toElement(org.w3c.dom.Document)">toElement</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Document</a>&nbsp;doc)</code></th>
Move a few things around
2020-01-05 15:50:06 +00:00
<td class="colLast">
Progress was done!
2020-01-05 17:46:32 +00:00
<div class="block">Create a <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a> representing this SplitConfig (to be used in *.chp metadata files).</div>
Move a few things around
2020-01-05 15:50:06 +00:00
</td>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
</tr>
Progress was done!
2020-01-05 17:46:32 +00:00
<tr class="altColor" id="i4">
<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toString()">toString</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
</tbody>
</table>
</div>
</div>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<div class="inheritedList">
Progress was done!
2020-01-05 17:46:32 +00:00
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
Progress was done!
2020-01-05 17:46:32 +00:00
</a><code><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></div>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li class="blockList">
<section class="constructorDetails"><a id="constructor.detail">
<!-- -->
</a>
<h2>Constructor Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="&lt;init&gt;()">SplitConfig</a></h3>
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="memberName">SplitConfig</span>()</div>
</section>
</li>
</ul>
</section>
</li>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
<!-- ============ METHOD DETAIL ========== -->
<li class="blockList">
<section class="methodDetails"><a id="method.detail">
<!-- -->
</a>
<h2>Method Details</h2>
<ul class="blockList">
<li class="blockList">
<section class="detail">
<h3><a id="toElement(org.w3c.dom.Document)">toElement</a></h3>
Progress was done!
2020-01-05 17:46:32 +00:00
<div class="memberSignature"><span class="modifiers">public</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Element</a></span>&nbsp;<span class="memberName">toElement</span>&#8203;(<span class="arguments"><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink">Document</a>&nbsp;doc)</span></div>
<div class="block">Create a <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a> representing this SplitConfig (to be used in *.chp metadata files).</div>
Move a few things around
2020-01-05 15:50:06 +00:00
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
Progress was done!
2020-01-05 17:46:32 +00:00
<dd><code>doc</code> - The <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Document.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Document</code></a> the <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a> should be created in.</dd>
Move a few things around
2020-01-05 15:50:06 +00:00
<dt><span class="returnLabel">Returns:</span></dt>
Progress was done!
2020-01-05 17:46:32 +00:00
<dd>The created <a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.xml/org/w3c/dom/Element.html?is-external=true" title="class or interface in org.w3c.dom" class="externalLink"><code>Element</code></a>.</dd>
Move a few things around
2020-01-05 15:50:06 +00:00
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../ChopJob.html" title="class in eu.steffo.cleaver.logic"><code>ChopJob</code></a>,
<a href="../StitchJob.html" title="class in eu.steffo.cleaver.logic"><code>StitchJob</code></a></dd>
</dl>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
</section>
</li>
Progress was done!
2020-01-05 17:46:32 +00:00
<li class="blockList">
<section class="detail">
<h3><a id="getPartSize()">getPartSize</a></h3>
<div class="memberSignature"><span class="modifiers">public abstract</span>&nbsp;<span class="returnType">long</span>&nbsp;<span class="memberName">getPartSize</span>()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The size in bytes of a single part of the file.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getPartCount()">getPartCount</a></h3>
<div class="memberSignature"><span class="modifiers">public abstract</span>&nbsp;<span class="returnType">int</span>&nbsp;<span class="memberName">getPartCount</span>()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The number of parts the file should be split in.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="getTotalSize()">getTotalSize</a></h3>
<div class="memberSignature"><span class="modifiers">public abstract</span>&nbsp;<span class="returnType">long</span>&nbsp;<span class="memberName">getTotalSize</span>()</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The total size of the original file.</dd>
</dl>
</section>
</li>
<li class="blockList">
<section class="detail">
<h3><a id="toString()">toString</a></h3>
<div class="memberSignature"><span class="modifiers">public abstract</span>&nbsp;<span class="returnType"><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></span>&nbsp;<span class="memberName">toString</span>()</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/13/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The string representation of the <a href="SplitConfig.html" title="class in eu.steffo.cleaver.logic.split"><code>SplitConfig</code></a>, to be used in the jobs table.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../gui/panels/JobsTablePanel.html" title="class in eu.steffo.cleaver.gui.panels"><code>JobsTablePanel</code></a></dd>
</dl>
</section>
</li>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
</ul>
</section>
</li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</ul>
</section>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
Move a few things around
2020-01-05 15:50:06 +00:00
<li><a href="../../../../../module-summary.html">Module</a></li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
Move a few things around
2020-01-05 15:50:06 +00:00
<li><a href="../../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</ul>
</div>
<div class="subNav">
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
Make the project a module (and add some new docs)
2020-01-03 12:55:19 +00:00
<li><a href="#method.detail">Method</a></li>
2019-12-05-2
2019-12-06 01:14:13 +00:00
</ul>
</div>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
</footer>
</body>
</html>
Copy permalink