454 lines
16 KiB
HTML
454 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<!-- NewPage -->
|
||
<html lang="de">
|
||
<head>
|
||
<!-- Generated by javadoc (1.8.0_25) on Tue Jan 27 17:10:42 CET 2015 -->
|
||
<title>Settings</title>
|
||
<meta name="date" content="2015-01-27">
|
||
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
||
<script type="text/javascript" src="../../../script.js"></script>
|
||
</head>
|
||
<body>
|
||
<script type="text/javascript"><!--
|
||
try {
|
||
if (location.href.indexOf('is-external=true') == -1) {
|
||
parent.document.title="Settings";
|
||
}
|
||
}
|
||
catch(err) {
|
||
}
|
||
//-->
|
||
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
|
||
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
||
var altColor = "altColor";
|
||
var rowColor = "rowColor";
|
||
var tableTab = "tableTab";
|
||
var activeTableTab = "activeTableTab";
|
||
</script>
|
||
<noscript>
|
||
<div>JavaScript is disabled on your browser.</div>
|
||
</noscript>
|
||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
<div class="topNav"><a name="navbar.top">
|
||
<!-- -->
|
||
</a>
|
||
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
||
<a name="navbar.top.firstrow">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="navList" title="Navigation">
|
||
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
<li><a href="package-summary.html">Package</a></li>
|
||
<li class="navBarCell1Rev">Class</li>
|
||
<li><a href="class-use/Settings.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="../../../de/katho/kBorrow/KLogger.html" title="class in de.katho.kBorrow"><span class="typeNameLink">Prev Class</span></a></li>
|
||
<li><a href="../../../de/katho/kBorrow/Util.html" title="class in de.katho.kBorrow"><span class="typeNameLink">Next Class</span></a></li>
|
||
</ul>
|
||
<ul class="navList">
|
||
<li><a href="../../../index.html?de/katho/kBorrow/Settings.html" target="_top">Frames</a></li>
|
||
<li><a href="Settings.html" target="_top">No Frames</a></li>
|
||
</ul>
|
||
<ul class="navList" id="allclasses_navbar_top">
|
||
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
</ul>
|
||
<div>
|
||
<script type="text/javascript"><!--
|
||
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
if(window==top) {
|
||
allClassesLink.style.display = "block";
|
||
}
|
||
else {
|
||
allClassesLink.style.display = "none";
|
||
}
|
||
//-->
|
||
</script>
|
||
</div>
|
||
<div>
|
||
<ul class="subNavList">
|
||
<li>Summary: </li>
|
||
<li>Nested | </li>
|
||
<li><a href="#field.summary">Field</a> | </li>
|
||
<li><a href="#constructor.summary">Constr</a> | </li>
|
||
<li><a href="#method.summary">Method</a></li>
|
||
</ul>
|
||
<ul class="subNavList">
|
||
<li>Detail: </li>
|
||
<li><a href="#field.detail">Field</a> | </li>
|
||
<li><a href="#constructor.detail">Constr</a> | </li>
|
||
<li><a href="#method.detail">Method</a></li>
|
||
</ul>
|
||
</div>
|
||
<a name="skip.navbar.top">
|
||
<!-- -->
|
||
</a></div>
|
||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
<!-- ======== START OF CLASS DATA ======== -->
|
||
<div class="header">
|
||
<div class="subTitle">de.katho.kBorrow</div>
|
||
<h2 title="Class Settings" class="title">Class Settings</h2>
|
||
</div>
|
||
<div class="contentContainer">
|
||
<ul class="inheritance">
|
||
<li>java.lang.Object</li>
|
||
<li>
|
||
<ul class="inheritance">
|
||
<li>de.katho.kBorrow.Settings</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<div class="description">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<hr>
|
||
<br>
|
||
<pre>public class <span class="typeNameLabel">Settings</span>
|
||
extends java.lang.Object</pre>
|
||
<div class="block">Verwaltet die Settings-Datei von kBorrow.</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="summary">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- =========== FIELD SUMMARY =========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="field.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Field Summary</h3>
|
||
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
||
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
||
<tr>
|
||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
<th class="colLast" scope="col">Field and Description</th>
|
||
</tr>
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>private java.lang.String</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#fileName">fileName</a></span></code>
|
||
<div class="block">Dateiname der Settingsdatei</div>
|
||
</td>
|
||
</tr>
|
||
<tr class="rowColor">
|
||
<td class="colFirst"><code>private java.lang.String</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#filePath">filePath</a></span></code>
|
||
<div class="block">Pfad zum Settings-Verzeichnis</div>
|
||
</td>
|
||
</tr>
|
||
<tr class="altColor">
|
||
<td class="colFirst"><code>private java.util.Properties</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#properties">properties</a></span></code>
|
||
<div class="block">Properties-Objekt, <20>ber das Zugriff auf Settings-Werte erfolgt</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="constructor.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Constructor Summary</h3>
|
||
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
||
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
||
<tr>
|
||
<th class="colOne" scope="col">Constructor and Description</th>
|
||
</tr>
|
||
<tr class="altColor">
|
||
<td class="colOne"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#Settings--">Settings</a></span>()</code>
|
||
<div class="block">Initialisiert das Settingsobjekt.</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<!-- ========== METHOD SUMMARY =========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="method.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Method Summary</h3>
|
||
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
||
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
||
<tr>
|
||
<th class="colFirst" scope="col">Modifier and Type</th>
|
||
<th class="colLast" scope="col">Method and Description</th>
|
||
</tr>
|
||
<tr id="i0" class="altColor">
|
||
<td class="colFirst"><code>private void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#createDefaultConfig--">createDefaultConfig</a></span>()</code>
|
||
<div class="block">Writes a default config to the config file.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i1" class="rowColor">
|
||
<td class="colFirst"><code>private boolean</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#filePathHasValidConfig--">filePathHasValidConfig</a></span>()</code>
|
||
<div class="block">Pr<EFBFBD>ft, ob am oben definierten Dateipfad eine valide Config existiert.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i2" class="altColor">
|
||
<td class="colFirst"><code>java.lang.String</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#getProperty-java.lang.String-">getProperty</a></span>(java.lang.String pKey)</code>
|
||
<div class="block">Gibt einen Propertieswert zum als Parameter <20>bergebenen Key zur<75>ck.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i3" class="rowColor">
|
||
<td class="colFirst"><code>java.lang.String</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#getSettingsDir--">getSettingsDir</a></span>()</code>
|
||
<div class="block">Gibt den Pfad zum Configverzeichnis zur<75>ck.</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i4" class="altColor">
|
||
<td class="colFirst"><code>void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../de/katho/kBorrow/Settings.html#setProperty-java.lang.String-java.lang.String-">setProperty</a></span>(java.lang.String pKey,
|
||
java.lang.String pValue)</code>
|
||
<div class="block">Setzt <20>bergebenes Key-Value-Paar und schreibt es in die Configdatei.</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.Object</h3>
|
||
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="details">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- ============ FIELD DETAIL =========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="field.detail">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Field Detail</h3>
|
||
<a name="properties">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>properties</h4>
|
||
<pre>private java.util.Properties properties</pre>
|
||
<div class="block">Properties-Objekt, <20>ber das Zugriff auf Settings-Werte erfolgt</div>
|
||
</li>
|
||
</ul>
|
||
<a name="filePath">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>filePath</h4>
|
||
<pre>private final java.lang.String filePath</pre>
|
||
<div class="block">Pfad zum Settings-Verzeichnis</div>
|
||
</li>
|
||
</ul>
|
||
<a name="fileName">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockListLast">
|
||
<li class="blockList">
|
||
<h4>fileName</h4>
|
||
<pre>private final java.lang.String fileName</pre>
|
||
<div class="block">Dateiname der Settingsdatei</div>
|
||
<dl>
|
||
<dt><span class="seeLabel">See Also:</span></dt>
|
||
<dd><a href="../../../constant-values.html#de.katho.kBorrow.Settings.fileName">Constant Field Values</a></dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="constructor.detail">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Constructor Detail</h3>
|
||
<a name="Settings--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockListLast">
|
||
<li class="blockList">
|
||
<h4>Settings</h4>
|
||
<pre>public Settings()
|
||
throws java.lang.Exception</pre>
|
||
<div class="block">Initialisiert das Settingsobjekt.
|
||
|
||
Pr<50>ft, ob am oben definierten Dateipfad eine valide Config existiert. Falls nicht, wird eine neue Config erzeugt.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code>java.lang.Exception</code> - wenn eine Exception in <a href="../../../de/katho/kBorrow/Settings.html#filePathHasValidConfig--"><code>filePathHasValidConfig()</code></a> oder <a href="../../../de/katho/kBorrow/Settings.html#createDefaultConfig--"><code>createDefaultConfig()</code></a> auftritt und dort nicht gefangen wird.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<!-- ============ METHOD DETAIL ========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="method.detail">
|
||
<!-- -->
|
||
</a>
|
||
<h3>Method Detail</h3>
|
||
<a name="filePathHasValidConfig--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>filePathHasValidConfig</h4>
|
||
<pre>private boolean filePathHasValidConfig()</pre>
|
||
<div class="block">Pr<EFBFBD>ft, ob am oben definierten Dateipfad eine valide Config existiert.</div>
|
||
<dl>
|
||
<dt><span class="returnLabel">Returns:</span></dt>
|
||
<dd>true, wenn eine valide Config existiert, false, wenn keine Config existiert, oder die Config invalid ist.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="createDefaultConfig--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>createDefaultConfig</h4>
|
||
<pre>private void createDefaultConfig()
|
||
throws java.lang.Exception</pre>
|
||
<div class="block">Writes a default config to the config file.</div>
|
||
<dl>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code>java.lang.Exception</code> - wenn Configdatei nicht gefunden oder nicht erzeugt werden konnte.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getProperty-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>getProperty</h4>
|
||
<pre>public java.lang.String getProperty(java.lang.String pKey)</pre>
|
||
<div class="block">Gibt einen Propertieswert zum als Parameter <20>bergebenen Key zur<75>ck.</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
<dd><code>pKey</code> - Key des angefragten Propertieswerts, null gibt null zur<75>ck</dd>
|
||
<dt><span class="returnLabel">Returns:</span></dt>
|
||
<dd>Propertieswert als String oder null, wenn Key nicht gefunden werden konnte.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="setProperty-java.lang.String-java.lang.String-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>setProperty</h4>
|
||
<pre>public void setProperty(java.lang.String pKey,
|
||
java.lang.String pValue)
|
||
throws java.lang.Exception</pre>
|
||
<div class="block">Setzt <20>bergebenes Key-Value-Paar und schreibt es in die Configdatei.</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">Parameters:</span></dt>
|
||
<dd><code>pKey</code> - Key des zu schreibenden Key-Value-Paars, not null</dd>
|
||
<dd><code>pValue</code> - Value des zu schreibenden Key-Value-Paares, null</dd>
|
||
<dt><span class="throwsLabel">Throws:</span></dt>
|
||
<dd><code>java.lang.Exception</code> - Wenn Key null ist, wenn Configdatei nicht gefunden oder nicht beschrieben werden konnte.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="getSettingsDir--">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockListLast">
|
||
<li class="blockList">
|
||
<h4>getSettingsDir</h4>
|
||
<pre>public java.lang.String getSettingsDir()</pre>
|
||
<div class="block">Gibt den Pfad zum Configverzeichnis zur<75>ck.</div>
|
||
<dl>
|
||
<dt><span class="returnLabel">Returns:</span></dt>
|
||
<dd>Pfad zum Configverzeichnis als String.</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<!-- ========= END OF CLASS DATA ========= -->
|
||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
<div class="bottomNav"><a name="navbar.bottom">
|
||
<!-- -->
|
||
</a>
|
||
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
||
<a name="navbar.bottom.firstrow">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="navList" title="Navigation">
|
||
<li><a href="../../../overview-summary.html">Overview</a></li>
|
||
<li><a href="package-summary.html">Package</a></li>
|
||
<li class="navBarCell1Rev">Class</li>
|
||
<li><a href="class-use/Settings.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="../../../de/katho/kBorrow/KLogger.html" title="class in de.katho.kBorrow"><span class="typeNameLink">Prev Class</span></a></li>
|
||
<li><a href="../../../de/katho/kBorrow/Util.html" title="class in de.katho.kBorrow"><span class="typeNameLink">Next Class</span></a></li>
|
||
</ul>
|
||
<ul class="navList">
|
||
<li><a href="../../../index.html?de/katho/kBorrow/Settings.html" target="_top">Frames</a></li>
|
||
<li><a href="Settings.html" target="_top">No Frames</a></li>
|
||
</ul>
|
||
<ul class="navList" id="allclasses_navbar_bottom">
|
||
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
||
</ul>
|
||
<div>
|
||
<script type="text/javascript"><!--
|
||
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
if(window==top) {
|
||
allClassesLink.style.display = "block";
|
||
}
|
||
else {
|
||
allClassesLink.style.display = "none";
|
||
}
|
||
//-->
|
||
</script>
|
||
</div>
|
||
<div>
|
||
<ul class="subNavList">
|
||
<li>Summary: </li>
|
||
<li>Nested | </li>
|
||
<li><a href="#field.summary">Field</a> | </li>
|
||
<li><a href="#constructor.summary">Constr</a> | </li>
|
||
<li><a href="#method.summary">Method</a></li>
|
||
</ul>
|
||
<ul class="subNavList">
|
||
<li>Detail: </li>
|
||
<li><a href="#field.detail">Field</a> | </li>
|
||
<li><a href="#constructor.detail">Constr</a> | </li>
|
||
<li><a href="#method.detail">Method</a></li>
|
||
</ul>
|
||
</div>
|
||
<a name="skip.navbar.bottom">
|
||
<!-- -->
|
||
</a></div>
|
||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
</body>
|
||
</html>
|