<!DOCTYPE HTML> <html lang="de"> <head> <!-- Generated by javadoc (21) on Tue Jul 09 12:47:01 CEST 2024 --> <title>LogElement</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <meta name="dc.created" content="2024-07-09"> <meta name="description" content="declaration: package: logging, class: LogElement"> <meta name="generator" content="javadoc/ClassWriterImpl"> <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"> <script type="text/javascript" src="../script.js"></script> <script type="text/javascript" src="../script-dir/jquery-3.6.1.min.js"></script> <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script> </head> <body class="class-declaration-page"> <script type="text/javascript">var pathtoroot = "../"; loadScripts(document, 'script');</script> <noscript> <div>JavaScript ist im Browser deaktiviert.</div> </noscript> <div class="flex-box"> <header role="banner" class="flex-header"> <nav role="navigation"> <!-- ========= START OF TOP NAVBAR ======= --> <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Navigationslinks umschalten"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> <div class="skip-nav"><a href="#skip-navbar-top" title="Navigations-Links überspringen">Navigations-Links überspringen</a></div> <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> <li><a href="../index.html">Überblick</a></li> <li><a href="package-summary.html">Package</a></li> <li class="nav-bar-cell1-rev">Klasse</li> <li><a href="package-tree.html">Baum</a></li> <li><a href="../index-files/index-1.html">Index</a></li> <li><a href="../help-doc.html#class">Hilfe</a></li> </ul> <ul class="sub-nav-list-small"> <li> <p>Übersicht:</p> <ul> <li>Verschachtelt</li> <li><a href="#field-summary">Feld</a></li> <li><a href="#constructor-summary">Konstruktor</a></li> <li><a href="#method-summary">Methode</a></li> </ul> </li> <li> <p>Details:</p> <ul> <li><a href="#field-detail">Feld</a></li> <li><a href="#constructor-detail">Konstruktor</a></li> <li><a href="#method-detail">Methode</a></li> </ul> </li> </ul> </div> <div class="sub-nav"> <div id="navbar-sub-list"> <ul class="sub-nav-list"> <li>Übersicht: </li> <li>Verschachtelt | </li> <li><a href="#field-summary">Feld</a> | </li> <li><a href="#constructor-summary">Konstruktor</a> | </li> <li><a href="#method-summary">Methode</a></li> </ul> <ul class="sub-nav-list"> <li>Details: </li> <li><a href="#field-detail">Feld</a> | </li> <li><a href="#constructor-detail">Konstruktor</a> | </li> <li><a href="#method-detail">Methode</a></li> </ul> </div> <div class="nav-list-search"><a href="../search.html">SEARCH</a> <input type="text" id="search-input" disabled placeholder="Suchen"> <input type="reset" id="reset-button" disabled value="reset"> </div> </div> <!-- ========= END OF TOP NAVBAR ========= --> <span class="skip-nav" id="skip-navbar-top"></span></nav> </header> <div class="flex-content"> <main role="main"> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">logging</a></div> <h1 title="Klasse LogElement" class="title">Klasse LogElement</h1> </div> <div class="inheritance" title="Vererbungsbaum"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance">logging.LogElement</div> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>Bekannte direkte Unterklassen:</dt> <dd><code><a href="../OurApplication/OurLogElement.html" title="Klasse in OurApplication">OurLogElement</a></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">LogElement</span> <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">Object</a></span></div> <div class="block">This class provides the basic log list element. Use it in assoziation with packages logging and visualization. It is used to store all relevant information about a algorithm processing'S single step. Extend it by the members you need.</div> <dl class="notes"> <dt>Siehe auch:</dt> <dd> <ul class="tag-list"> <li><a href="Algorithm.html" title="Klasse in logging"><code>Algorithm</code></a></li> <li><a href="LogElementList.html" title="Klasse in logging"><code>LogElementList</code></a></li> <li><a href="../visualisation/HybridWindow.html" title="Klasse in visualisation"><code>HybridWindow</code></a></li> </ul> </dd> </dl> </section> <section class="summary"> <ul class="summary-list"> <!-- =========== FIELD SUMMARY =========== --> <li> <section class="field-summary" id="field-summary"> <h2>Feldübersicht</h2> <div class="caption"><span>Felder</span></div> <div class="summary-table three-column-summary"> <div class="table-header col-first">Modifizierer und Typ</div> <div class="table-header col-second">Feld</div> <div class="table-header col-last">Beschreibung</div> <div class="col-first even-row-color"><code>protected <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a></code></div> <div class="col-second even-row-color"><code><a href="#description" class="member-name-link">description</a></code></div> <div class="col-last even-row-color"> <div class="block">Description of the single step's process.</div> </div> <div class="col-first odd-row-color"><code>protected int</code></div> <div class="col-second odd-row-color"><code><a href="#step" class="member-name-link">step</a></code></div> <div class="col-last odd-row-color"> <div class="block">The step number of the single step within a algorithm's log element list.</div> </div> </div> </section> </li> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <li> <section class="constructor-summary" id="constructor-summary"> <h2>Konstruktorübersicht</h2> <div class="caption"><span>Konstruktoren</span></div> <div class="summary-table two-column-summary"> <div class="table-header col-first">Konstruktor</div> <div class="table-header col-last">Beschreibung</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">LogElement</a>()</code></div> <div class="col-last even-row-color"> <div class="block">Standard constructor.</div> </div> <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,java.lang.String)" class="member-name-link">LogElement</a><wbr>(int step, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> description)</code></div> <div class="col-last odd-row-color"> <div class="block">Creates a log element with the specified step number and description.</div> </div> </div> </section> </li> <!-- ========== METHOD SUMMARY =========== --> <li> <section class="method-summary" id="method-summary"> <h2>Methodenübersicht</h2> <div id="method-summary-table"> <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">Alle Methoden</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instanzmethoden</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Konkrete Methoden</button></div> <div id="method-summary-table.tabpanel" role="tabpanel"> <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> <div class="table-header col-first">Modifizierer und Typ</div> <div class="table-header col-second">Methode</div> <div class="table-header col-last">Beschreibung</div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a></code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getDescription()" class="member-name-link">getDescription</a>()</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Returns the step's description.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getStep()" class="member-name-link">getStep</a>()</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Returns the step's step number.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setDescription(java.lang.String)" class="member-name-link">setDescription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> description)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Sets the step's description.</div> </div> <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setStep(int)" class="member-name-link">setStep</a><wbr>(int step)</code></div> <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Sets the step's step number.</div> </div> </div> </div> </div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-java.lang.Object">Von Klasse geerbte Methoden java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">Object</a></h3> <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="Klasse oder Schnittstelle in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="Klasse oder Schnittstelle in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="Klasse oder Schnittstelle in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="Klasse oder Schnittstelle in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="Klasse oder Schnittstelle in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="Klasse oder Schnittstelle in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="Klasse oder Schnittstelle in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#toString()" title="Klasse oder Schnittstelle in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a></code></div> </section> </li> </ul> </section> <section class="details"> <ul class="details-list"> <!-- ============ FIELD DETAIL =========== --> <li> <section class="field-details" id="field-detail"> <h2>Felddetails</h2> <ul class="member-list"> <li> <section class="detail" id="step"> <h3>step</h3> <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">int</span> <span class="element-name">step</span></div> <div class="block">The step number of the single step within a algorithm's log element list.</div> </section> </li> <li> <section class="detail" id="description"> <h3>description</h3> <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a></span> <span class="element-name">description</span></div> <div class="block">Description of the single step's process.</div> </section> </li> </ul> </section> </li> <!-- ========= CONSTRUCTOR DETAIL ======== --> <li> <section class="constructor-details" id="constructor-detail"> <h2>Konstruktordetails</h2> <ul class="member-list"> <li> <section class="detail" id="<init>()"> <h3>LogElement</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LogElement</span>()</div> <div class="block">Standard constructor. Creates a log element with step number 0 and "No description available." as description.</div> </section> </li> <li> <section class="detail" id="<init>(int,java.lang.String)"> <h3>LogElement</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">LogElement</span><wbr><span class="parameters">(int step, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> description)</span></div> <div class="block">Creates a log element with the specified step number and description.</div> <dl class="notes"> <dt>Parameter:</dt> <dd><code>step</code> - step number</dd> <dd><code>description</code> - step description</dd> </dl> </section> </li> </ul> </section> </li> <!-- ============ METHOD DETAIL ========== --> <li> <section class="method-details" id="method-detail"> <h2>Methodendetails</h2> <ul class="member-list"> <li> <section class="detail" id="getStep()"> <h3>getStep</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name">getStep</span>()</div> <div class="block">Returns the step's step number.</div> <dl class="notes"> <dt>Gibt zurück:</dt> <dd>the step's step number</dd> </dl> </section> </li> <li> <section class="detail" id="setStep(int)"> <h3>setStep</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setStep</span><wbr><span class="parameters">(int step)</span></div> <div class="block">Sets the step's step number.</div> <dl class="notes"> <dt>Parameter:</dt> <dd><code>step</code> - the step's step number</dd> </dl> </section> </li> <li> <section class="detail" id="getDescription()"> <h3>getDescription</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a></span> <span class="element-name">getDescription</span>()</div> <div class="block">Returns the step's description.</div> <dl class="notes"> <dt>Gibt zurück:</dt> <dd>the step's description</dd> </dl> </section> </li> <li> <section class="detail" id="setDescription(java.lang.String)"> <h3>setDescription</h3> <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setDescription</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> description)</span></div> <div class="block">Sets the step's description.</div> <dl class="notes"> <dt>Parameter:</dt> <dd><code>description</code> - the step's description</dd> </dl> </section> </li> </ul> </section> </li> </ul> </section> <!-- ========= END OF CLASS DATA ========= --> </main> </div> </div> </body> </html>