Files
CloudflareDNS-java/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html
T

479 lines
28 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (21) on Sat Apr 26 18:54:18 CEST 2025 -->
<title>ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API)</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="2025-04-26">
<meta name="description" content="declaration: package: codes.thischwa.cf.model, record: ResultInfo">
<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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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="class-use/ResultInfo.html">Verwendung</a></li>
<li><a href="package-tree.html">Baum</a></li>
<li><a href="../../../../index-all.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>Feld</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>Feld</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:&nbsp;</li>
<li>Verschachtelt&nbsp;|&nbsp;</li>
<li>Feld&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Konstruktor</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Methode</a></li>
</ul>
<ul class="sub-nav-list">
<li>Details:&nbsp;</li>
<li>Feld&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Konstruktor</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">codes.thischwa.cf.model</a></div>
<h1 title="Datensatzklasse ResultInfo" class="title">Datensatzklasse ResultInfo</h1>
</div>
<div class="inheritance" title="Vererbungsbaum"><a href="https://docs.oracle.com/en/java/javase/17/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"><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html"
title="Klasse oder Schnittstelle in java.lang" class="external-link">java.lang.Record</a>
<div class="inheritance">codes.thischwa.cf.model.ResultInfo</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public record </span><span class="element-name type-name-label">ResultInfo</span>(int&nbsp;page,
int&nbsp;perPage, int&nbsp;totalPages, int&nbsp;count, int&nbsp;totalCount)
<span class="extends-implements">extends <a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html"
title="Klasse oder Schnittstelle in java.lang" class="external-link">Record</a></span></div>
<div class="block">Represents metadata for paginated results.
<p>This class contains information about the current page, page size, total pages, and result
counts, which can be utilized in managing and navigating through paginated data.
<ul>
<li><b>page:</b> The current page number.
<li><b>perPage:</b> The number of results per page.
<li><b>totalPages:</b> The total number of pages available.
<li><b>count:</b> The number of results on the current page.
<li><b>totalCount:</b> The total number of results across all pages.
</ul></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== 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(int)" class="member-name-link">ResultInfo</a>
<wbr>
(int&nbsp;totalCount)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a ResultInfo instance with the specified total count and default values for other
fields.
</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,int,int,int,int)"
class="member-name-link">ResultInfo</a>
<wbr>
(int&nbsp;page,
int&nbsp;perPage,
int&nbsp;totalPages,
int&nbsp;count,
int&nbsp;totalCount)</code></div>
<div class="col-last odd-row-color">
<div class="block">Erstellt eine Instanz einer Datensatzklasse <code>ResultInfo</code>.</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" aria-labelledby="method-summary-table-tab0">
<div class="summary-table three-column-summary">
<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>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#count()" class="member-name-link">count</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den Wert für die Datensatzkomponente <code>count</code> zurück.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>final boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#equals(java.lang.Object)" class="member-name-link">equals</a>
<wbr>
(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">Object</a>&nbsp;o)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt an, ob ein anderes Objekt diesem gleich ("equal to") ist.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>final int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#hashCode()" class="member-name-link">hashCode</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt einen Hashcodewert für diese Objekt zurück.</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="#page()" class="member-name-link">page</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den Wert für die Datensatzkomponente <code>page</code> zurück.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#perPage()" class="member-name-link">perPage</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den Wert für die Datensatzkomponente <code>perPage</code> zurück.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>final <a
href="https://docs.oracle.com/en/java/javase/17/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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#toString()" class="member-name-link">toString</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt eine Zeichenfolgendarstellung dieser Datensatzklasse zurück.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<code><a href="#totalCount()" class="member-name-link">totalCount</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den Wert für die Datensatzkomponente <code>totalCount</code> zurück.</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="#totalPages()" class="member-name-link">totalPages</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gibt den Wert für die Datensatzkomponente <code>totalPages</code> zurück.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Von Klasse geerbte Methoden&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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/17/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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Konstruktordetails</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;(int)">
<h3>ResultInfo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="element-name">ResultInfo</span>
<wbr>
<span class="parameters">(int&nbsp;totalCount)</span></div>
<div class="block">Constructs a ResultInfo instance with the specified total count and default values for other
fields. Just to use in tests!
</div>
<dl class="notes">
<dt>Parameter:</dt>
<dd><code>totalCount</code> - the total number of results across all pages</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(int,int,int,int,int)">
<h3>ResultInfo</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ResultInfo</span>
<wbr>
<span class="parameters">(int&nbsp;page,
int&nbsp;perPage,
int&nbsp;totalPages,
int&nbsp;count,
int&nbsp;totalCount)</span></div>
<div class="block">Erstellt eine Instanz einer Datensatzklasse <code>ResultInfo</code>.</div>
<dl class="notes">
<dt>Parameter:</dt>
<dd><code>page</code> - Wert für die Datensatzkomponente <code>page</code></dd>
<dd><code>perPage</code> - Wert für die Datensatzkomponente <code>perPage</code></dd>
<dd><code>totalPages</code> - Wert für die Datensatzkomponente <code>totalPages</code></dd>
<dd><code>count</code> - Wert für die Datensatzkomponente <code>count</code></dd>
<dd><code>totalCount</code> - Wert für die Datensatzkomponente <code>totalCount</code></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="toString()">
<h3>toString</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span
class="return-type"><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html"
title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a></span>&nbsp;<span
class="element-name">toString</span>()
</div>
<div class="block">Gibt eine Zeichenfolgendarstellung dieser Datensatzklasse zurück. Die
Darstellung enthält den Namen der Klasse, gefolgt vom Namen und Wert jeder der
Datensatzkomponenten.
</div>
<dl class="notes">
<dt>Angegeben von:</dt>
<dd><code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html#toString()"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">toString</a></code>&nbsp;in Klasse&nbsp;<code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">Record</a></code></dd>
<dt>Gibt zurück:</dt>
<dd>eine Zeichenfolgendarstellung dieses Objekts</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hashCode()">
<h3>hashCode</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span
class="return-type">int</span>&nbsp;<span class="element-name">hashCode</span>()
</div>
<div class="block">Gibt einen Hashcodewert für diese Objekt zurück. Der Wert wird vom Hashcode
jeder der Datensatzkomponenten abgeleitet.
</div>
<dl class="notes">
<dt>Angegeben von:</dt>
<dd><code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html#hashCode()"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">hashCode</a></code>&nbsp;in Klasse&nbsp;<code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">Record</a></code></dd>
<dt>Gibt zurück:</dt>
<dd>ein Hashcodewert für dieses Objekt</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="equals(java.lang.Object)">
<h3>equals</h3>
<div class="member-signature"><span class="modifiers">public final</span>&nbsp;<span
class="return-type">boolean</span>&nbsp;<span class="element-name">equals</span>
<wbr>
<span class="parameters">(<a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html"
title="Klasse oder Schnittstelle in java.lang" class="external-link">Object</a>&nbsp;o)</span>
</div>
<div class="block">Gibt an, ob ein anderes Objekt diesem gleich ("equal to") ist. Die Objekte
sind gleich, wenn das andere Objekt der gleichen Klasse angehört und alle
Datensatzkomponenten gleich sind. Alle Komponenten in dieser Datensatzklasse werden
verglichen mit "==".
</div>
<dl class="notes">
<dt>Angegeben von:</dt>
<dd><code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html#equals(java.lang.Object)"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">equals</a></code>&nbsp;in Klasse&nbsp;<code><a
href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Record.html"
title="Klasse oder Schnittstelle in java.lang"
class="external-link">Record</a></code></dd>
<dt>Parameter:</dt>
<dd><code>o</code> - das Objekt, mit dem verglichen wird</dd>
<dt>Gibt zurück:</dt>
<dd><code>true</code>, wenn dieses Objekt gleich dem Argument <code>o</code> ist,
andernfalls <code>false</code>.
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="page()">
<h3>page</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">int</span>&nbsp;<span class="element-name">page</span>()
</div>
<div class="block">Gibt den Wert für die Datensatzkomponente <code>page</code> zurück.</div>
<dl class="notes">
<dt>Gibt zurück:</dt>
<dd>Wert der Datensatzkomponente <code>page</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="perPage()">
<h3>perPage</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">int</span>&nbsp;<span class="element-name">perPage</span>()
</div>
<div class="block">Gibt den Wert für die Datensatzkomponente <code>perPage</code> zurück.</div>
<dl class="notes">
<dt>Gibt zurück:</dt>
<dd>Wert der Datensatzkomponente <code>perPage</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="totalPages()">
<h3>totalPages</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">int</span>&nbsp;<span class="element-name">totalPages</span>()
</div>
<div class="block">Gibt den Wert für die Datensatzkomponente <code>totalPages</code> zurück.
</div>
<dl class="notes">
<dt>Gibt zurück:</dt>
<dd>Wert der Datensatzkomponente <code>totalPages</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="count()">
<h3>count</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">int</span>&nbsp;<span class="element-name">count</span>()
</div>
<div class="block">Gibt den Wert für die Datensatzkomponente <code>count</code> zurück.</div>
<dl class="notes">
<dt>Gibt zurück:</dt>
<dd>Wert der Datensatzkomponente <code>count</code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="totalCount()">
<h3>totalCount</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span
class="return-type">int</span>&nbsp;<span class="element-name">totalCount</span>()
</div>
<div class="block">Gibt den Wert für die Datensatzkomponente <code>totalCount</code> zurück.
</div>
<dl class="notes">
<dt>Gibt zurück:</dt>
<dd>Wert der Datensatzkomponente <code>totalCount</code></dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>