mirror of
https://github.com/Steffo99/unimore-oop-2020-cleaver.git
synced 2024-11-26 10:04:21 +00:00
505 lines
26 KiB
HTML
505 lines
26 KiB
HTML
<!DOCTYPE HTML>
|
|
<!-- NewPage -->
|
|
<html lang="it">
|
|
<head>
|
|
<!-- Generated by javadoc (13.0.1) on Sun Jan 05 16:49:35 CET 2020 -->
|
|
<title>StitchJob</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="dc.created" content="2020-01-05">
|
|
<meta name="description" content="declaration: module: eu.steffo.cleaver, package: eu.steffo.cleaver.logic, class: StitchJob">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<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>
|
|
<!--[if IE]>
|
|
<script type="text/javascript" src="../../../../../script-dir/jszip-utils/dist/jszip-utils-ie.min.js"></script>
|
|
<![endif]-->
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-3.4.1.js"></script>
|
|
<script type="text/javascript" src="../../../../../script-dir/jquery-ui.js"></script>
|
|
</head>
|
|
<body class="class-declaration">
|
|
<script type="text/javascript">var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":9,"i6":10,"i7":10};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
var pathtoroot = "../../../../../";
|
|
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">
|
|
<li><a href="../../../../module-summary.html">Module</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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</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"> </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">
|
|
<div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../../../module-summary.html">eu.steffo.cleaver</a></div>
|
|
<div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">eu.steffo.cleaver.logic</a></div>
|
|
<h1 title="Class StitchJob" class="title">Class StitchJob</h1>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<div class="inheritance" title="Inheritance Tree">java.lang.Object
|
|
<div class="inheritance">java.lang.Thread
|
|
<div class="inheritance"><a href="Job.html" title="class in eu.steffo.cleaver.logic">eu.steffo.cleaver.logic.Job</a>
|
|
<div class="inheritance">eu.steffo.cleaver.logic.StitchJob</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<section class="description">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><code>java.lang.Runnable</code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">StitchJob</span>
|
|
extends <a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></pre>
|
|
<div class="block">A <a href="Job.html" title="class in eu.steffo.cleaver.logic"><code>Job</code></a> that converts <i>chopped</i> (*.chp + *.cXX) files back into regular files.</div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="blockList">
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
<li class="blockList">
|
|
<section class="nestedClassSummary"><a id="nested.class.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Nested Class Summary</h2>
|
|
<div class="inheritedList">
|
|
<h2>Nested classes/interfaces inherited from class java.lang.Thread</h2>
|
|
<a id="nested.classes.inherited.from.class.java.lang.Thread">
|
|
<!-- -->
|
|
</a><code>java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler</code></div>
|
|
</section>
|
|
</li>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="fieldSummary"><a id="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Field Summary</h2>
|
|
<div class="inheritedList">
|
|
<h3>Fields inherited from class java.lang.Thread</h3>
|
|
<a id="fields.inherited.from.class.java.lang.Thread">
|
|
<!-- -->
|
|
</a><code>MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY</code></div>
|
|
</section>
|
|
</li>
|
|
<!-- ======== 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"> </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(java.io.File)">StitchJob</a></span>​(java.io.File file)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Construct a StitchJob, specifying the *.chp file to import the settings from.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.io.File,java.lang.String)">StitchJob</a></span>​(java.io.File file,
|
|
java.lang.String cryptKey)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Construct a StitchJob, specifying the *.chp file to import the settings from and an encryption key to use while decrypting the files.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.io.File,java.lang.String,java.lang.Runnable)">StitchJob</a></span>​(java.io.File chpFile,
|
|
java.lang.String cryptKey,
|
|
java.lang.Runnable updateTable)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Construct a StitchJob, and additionally specify the <code>Runnable</code> that should be called on progress updates..</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li class="blockList">
|
|
<section class="methodSummary"><a id="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h2>Method Summary</h2>
|
|
<div class="memberSummary">
|
|
<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="t1" class="tableTab" onclick="show(1);">Static 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="t4" class="tableTab" onclick="show(8);">Concrete Methods</button></div>
|
|
<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">
|
|
<td class="colFirst"><code><a href="compress/CompressConfig.html" title="class in eu.steffo.cleaver.logic.compress">CompressConfig</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCompressConfig()">getCompressConfig</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="rowColor" id="i1">
|
|
<td class="colFirst"><code><a href="crypt/CryptConfig.html" title="class in eu.steffo.cleaver.logic.crypt">CryptConfig</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCryptConfig()">getCryptConfig</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="altColor" id="i2">
|
|
<td class="colFirst"><code>java.io.File</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFile()">getFile</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="rowColor" id="i3">
|
|
<td class="colFirst"><code><a href="split/SplitConfig.html" title="class in eu.steffo.cleaver.logic.split">SplitConfig</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSplitConfig()">getSplitConfig</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="altColor" id="i4">
|
|
<td class="colFirst"><code>java.lang.String</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getType()">getType</a></span>()</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="rowColor" id="i5">
|
|
<td class="colFirst"><code>protected static org.w3c.dom.Document</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openChp(java.io.File)">openChp</a></span>​(java.io.File file)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
<tr class="altColor" id="i6">
|
|
<td class="colFirst"><code>protected void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#parseChp(org.w3c.dom.Document,java.lang.String)">parseChp</a></span>​(org.w3c.dom.Document doc,
|
|
java.lang.String cryptKey)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Read a <code>Document</code> and set <code>splitConfig</code>, <code>cryptConfig</code> and <code>compressConfig</code> accordingly.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor" id="i7">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#run()">run</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">The function that is run on a different thread when <code>Thread.start()</code> is called.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class eu.steffo.cleaver.logic.<a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></h3>
|
|
<a id="methods.inherited.from.class.eu.steffo.cleaver.logic.Job">
|
|
<!-- -->
|
|
</a><code><a href="Job.html#getProgress()">getProgress</a>, <a href="Job.html#setProgress(eu.steffo.cleaver.logic.progress.Progress)">setProgress</a></code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Thread</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Thread">
|
|
<!-- -->
|
|
</a><code>activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield</code></div>
|
|
<div class="inheritedList">
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<a id="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a><code>equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></div>
|
|
</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="<init>(java.io.File)">StitchJob</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">StitchJob</span>​(<span class="arguments">java.io.File file)</span>
|
|
throws <span class="exceptions"><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a>,
|
|
<a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></span></div>
|
|
<div class="block">Construct a StitchJob, specifying the *.chp file to import the settings from.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>file</code> - The *.chp file.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a></code> - If there's an error while parsing the *.chp file.</dd>
|
|
<dd><code><a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></code> - It shouldn't be thrown, but it isn't caught to allow its display in the GUI if it actually happens.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="<init>(java.io.File,java.lang.String)">StitchJob</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">StitchJob</span>​(<span class="arguments">java.io.File file,
|
|
java.lang.String cryptKey)</span>
|
|
throws <span class="exceptions"><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a>,
|
|
<a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></span></div>
|
|
<div class="block">Construct a StitchJob, specifying the *.chp file to import the settings from and an encryption key to use while decrypting the files.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>file</code> - The *.chp file.</dd>
|
|
<dd><code>cryptKey</code> - The encryption key to use while decrypting the files.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a></code> - If there's an error while parsing the *.chp file.</dd>
|
|
<dd><code><a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></code> - It shouldn't be thrown, but it isn't caught to allow its display in the GUI if it actually happens.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#%3Cinit%3E(java.io.File)"><code>StitchJob(File)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="<init>(java.io.File,java.lang.String,java.lang.Runnable)">StitchJob</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="memberName">StitchJob</span>​(<span class="arguments">java.io.File chpFile,
|
|
java.lang.String cryptKey,
|
|
java.lang.Runnable updateTable)</span>
|
|
throws <span class="exceptions"><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a>,
|
|
<a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></span></div>
|
|
<div class="block">Construct a StitchJob, and additionally specify the <code>Runnable</code> that should be called on progress updates..</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>chpFile</code> - The *.chp file.</dd>
|
|
<dd><code>cryptKey</code> - The encryption key to use while decrypting the files.</dd>
|
|
<dd><code>updateTable</code> - The <code>Runnable</code> that should be invoked when <a href="Job.html#setProgress(eu.steffo.cleaver.logic.progress.Progress)"><code>Job.setProgress(Progress)</code></a> is called.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a></code> - If there's an error while parsing the *.chp file.</dd>
|
|
<dd><code><a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></code> - It shouldn't be thrown, but it isn't caught to allow its display in the GUI if it actually happens.</dd>
|
|
<dt><span class="seeLabel">See Also:</span></dt>
|
|
<dd><a href="#%3Cinit%3E(java.io.File,java.lang.String)"><code>StitchJob(File, String)</code></a>,
|
|
<a href="Job.html#%3Cinit%3E(java.lang.Runnable)"><code>Job(Runnable)</code></a></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ 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="getType()">getType</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.lang.String</span> <span class="memberName">getType</span>()</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Job.html#getType()">getType</a></code> in class <code><a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The name of the job type, such as "Chop" for a <a href="ChopJob.html" title="class in eu.steffo.cleaver.logic"><code>ChopJob</code></a>.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getFile()">getFile</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">java.io.File</span> <span class="memberName">getFile</span>()</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Job.html#getFile()">getFile</a></code> in class <code><a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The file path the job should act on.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getSplitConfig()">getSplitConfig</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="split/SplitConfig.html" title="class in eu.steffo.cleaver.logic.split">SplitConfig</a></span> <span class="memberName">getSplitConfig</span>()</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Job.html#getSplitConfig()">getSplitConfig</a></code> in class <code><a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The <a href="split/SplitConfig.html" title="class in eu.steffo.cleaver.logic.split"><code>SplitConfig</code></a> of the job. If null, the job shouldn't handle file splitting/merging.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getCryptConfig()">getCryptConfig</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="crypt/CryptConfig.html" title="class in eu.steffo.cleaver.logic.crypt">CryptConfig</a></span> <span class="memberName">getCryptConfig</span>()</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Job.html#getCryptConfig()">getCryptConfig</a></code> in class <code><a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The <a href="crypt/CryptConfig.html" title="class in eu.steffo.cleaver.logic.crypt"><code>CryptConfig</code></a> of the job. If null, the job shouldn't handle file encryption/decryption.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="getCompressConfig()">getCompressConfig</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType"><a href="compress/CompressConfig.html" title="class in eu.steffo.cleaver.logic.compress">CompressConfig</a></span> <span class="memberName">getCompressConfig</span>()</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Job.html#getCompressConfig()">getCompressConfig</a></code> in class <code><a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></code></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The <a href="compress/CompressConfig.html" title="class in eu.steffo.cleaver.logic.compress"><code>CompressConfig</code></a> of the job. If null, the job shouldn't handle file compression/decompression.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="openChp(java.io.File)">openChp</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">protected static</span> <span class="returnType">org.w3c.dom.Document</span> <span class="memberName">openChp</span>​(<span class="arguments">java.io.File file)</span>
|
|
throws <span class="exceptions"><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a>,
|
|
<a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></span></div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a></code></dd>
|
|
<dd><code><a href="../errors/ProgrammingError.html" title="class in eu.steffo.cleaver.errors">ProgrammingError</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="parseChp(org.w3c.dom.Document,java.lang.String)">parseChp</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">protected final</span> <span class="returnType">void</span> <span class="memberName">parseChp</span>​(<span class="arguments">org.w3c.dom.Document doc,
|
|
java.lang.String cryptKey)</span>
|
|
throws <span class="exceptions"><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a></span></div>
|
|
<div class="block">Read a <code>Document</code> and set <code>splitConfig</code>, <code>cryptConfig</code> and <code>compressConfig</code> accordingly.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>doc</code> - The <code>Document</code> to be read.</dd>
|
|
<dd><code>cryptKey</code> - The encryption key to use in the <a href="crypt/CryptConfig.html" title="class in eu.steffo.cleaver.logic.crypt"><code>CryptConfig</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../errors/ChpFileError.html" title="class in eu.steffo.cleaver.errors">ChpFileError</a></code> - If there's an error while parsing the *.chp file.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li class="blockList">
|
|
<section class="detail">
|
|
<h3><a id="run()">run</a></h3>
|
|
<div class="memberSignature"><span class="modifiers">public</span> <span class="returnType">void</span> <span class="memberName">run</span>()</div>
|
|
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="Job.html#run()">Job</a></code></span></div>
|
|
<div class="block">The function that is run on a different thread when <code>Thread.start()</code> is called.
|
|
|
|
Child classes should override <code>Thread.run()</code>.</div>
|
|
<dl>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code>run</code> in interface <code>java.lang.Runnable</code></dd>
|
|
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
|
|
<dd><code><a href="Job.html#run()">run</a></code> in class <code><a href="Job.html" title="class in eu.steffo.cleaver.logic">Job</a></code></dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</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">
|
|
<li><a href="../../../../module-summary.html">Module</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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li><a href="#nested.class.summary">Nested</a> | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<a id="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</nav>
|
|
</footer>
|
|
</body>
|
|
</html>
|