InsanusMokrassar/MicroUtils
1
0
Fork 0
mirror of https://github.com/InsanusMokrassar/MicroUtils.git synced 2024-11-27 04:28:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
c78d53ac1e
MicroUtils/micro_utils.dokka/dev.inmo.micro_utils.repos.annotations/-generate-c-r-u-d-model/index.html

135 lines
14 KiB
HTML
Raw Normal View History

deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<!DOCTYPE html>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<html class="no-js">
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>GenerateCRUDModel</title>
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
<script>var pathToRoot = "../../../";</script>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<script>document.documentElement.classList.replace("no-js","js");</script>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<script type="text/javascript" src="https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async="async"></script>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
<link href="../../../styles/style.css" rel="Stylesheet">
<link href="../../../styles/main.css" rel="Stylesheet">
<link href="../../../styles/prism.css" rel="Stylesheet">
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<link href="../../../styles/font-jb-sans-auto.css" rel="Stylesheet">
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
</head>
<body>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<div class="root">
<nav class="navigation" id="navigation-wrapper">
<div class="navigation--inner">
<div class="navigation-title">
<button class="menu-toggle" id="menu-toggle" type="button">toggle menu</button>
<div class="library-name">
<a class="library-name--link" href="../../../index.html">
micro_utils.dokka
</a>
</div>
<div class="library-version">
deploy: f0420e2d61a774294cf8011f687a0dd94491322f
2023-10-09 12:35:24 +00:00
0.20.7 </div>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
</div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<div class="filter-section" id="filter-section">
<button class="platform-tag platform-selector common-like" data-active="" data-filter=":micro_utils.dokka:dokkaHtml/commonMain">common</button>
</div>
</div>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<div class="navigation-controls">
<button class="navigation-controls--btn navigation-controls--theme" id="theme-toggle-button" type="button">switch theme</button>
<div class="navigation-controls--btn navigation-controls--search" id="searchBar" role="button">search in API</div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
</div>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
</nav>
<div id="container">
<div class="sidebar" id="leftColumn">
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div class="main-content" data-page-type="classlike" id="content" pageIds="micro_utils.dokka::dev.inmo.micro_utils.repos.annotations/GenerateCRUDModel///PointingToDeclaration//-1478683138">
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<div class="breadcrumbs"><a href="../../../index.html">micro_utils.dokka</a><span class="delimiter">/</span><a href="../index.html">dev.inmo.micro_utils.repos.annotations</a><span class="delimiter">/</span><span class="current">GenerateCRUDModel</span></div>
<div class="cover ">
<h1 class="cover"><span>Generate</span><wbr></wbr><span><span>CRUDModel</span></span></h1>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-target/index.html"><span class="token annotation builtin">Target</span></a><span class="token punctuation">(</span><span>allowedTargets<span class="token operator"> = </span><span class="token punctuation">[</span><span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.annotation/-annotation-target/-c-l-a-s-s/index.html">AnnotationTarget.CLASS</a></span><wbr></wbr><span class="token punctuation">]</span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">annotation class </span><a href="index.html">GenerateCRUDModel</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>registeredSupertypes<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>serializable<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>generateSerialName<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></span></span><span class="token punctuation">)</span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/InsanusMokrassar/MicroUtils/blob/master//repos/common/src/commonMain/kotlin/dev/inmo/micro_utils/repos/annotations/GenerateCRUDModel.kt#L19">source</a>)</span></span></div><p class="paragraph">Use this annotation and ksp generator (module <code class="lang-kotlin">micro_utils.repos.generator</code>) to create the next hierarchy of models:</p><ul><li><p class="paragraph">New model. For example: data class NewTest</p></li><li><p class="paragraph">Registered model. For example: data class RegisteredTest</p></li></ul><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>registered</span><wbr></wbr><span><span>Supertypes</span></span></u></div></span></div><div><div class="title"><p class="paragraph">These <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a>es will be used as supertypes for registered model</p></div></div></div></div><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span><span>serializable</span></span></u></div></span></div><div><div class="title"><p class="paragraph">If true (default) will generate @<span data-unresolved-link="kotlinx.serialization/SerialName///PointingToDeclaration/">kotlinx.serialization.SerialName</span> for models with their names as values</p></div></div></div></div></div><h4 class="">See also</h4><div class="table"><div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"><div class="main-subrow k
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
</div>
<div class="tabbedcontent">
deploy: 9171d5ed11216b37f0279caa9eba5ac6287dc71d
2023-06-09 06:16:05 +00:00
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<div class="tabs-section-body">
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div data-togglable="PROPERTY">
<h2 class="">Properties</h2>
<div class="table"><a data-name="631082130%2FProperties%2F-1478683138" anchor-label="generateSerialName" id="631082130%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="generate-serial-name.html"><span>generate</span><wbr></wbr><span>Serial</span><wbr></wbr><span><span>Name</span></span></a></div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="631082130%2FProperties%2F-1478683138"></span>
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="generate-serial-name.html">generateSerialName</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></div></div></div>
</div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
</div>
</div>
</div>
<a data-name="-1401480250%2FProperties%2F-1478683138" anchor-label="registeredSupertypes" id="-1401480250%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="registered-supertypes.html"><span>registered</span><wbr></wbr><span><span>Supertypes</span></span></a></div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1401480250%2FProperties%2F-1478683138"></span>
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="registered-supertypes.html">registeredSupertypes</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html">Array</a><span class="token operator">&lt;</span><span class="token keyword">out </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html">KClass</a><span class="token operator">&lt;</span><span class="token operator">*</span><span class="token operator">&gt;</span><span class="token operator">&gt;</span></div></div></div>
</div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
</div>
</div>
</div>
<a data-name="1068402343%2FProperties%2F-1478683138" anchor-label="serializable" id="1068402343%2FProperties%2F-1478683138" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain"></a>
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div class="table-row" data-filterable-current=":micro_utils.dokka:dokkaHtml/commonMain" data-filterable-set=":micro_utils.dokka:dokkaHtml/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="serializable.html"><span><span>serializable</span></span></a></div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1068402343%2FProperties%2F-1478683138"></span>
deploy: cf1fd32b080aebd5988955ddbeee4ae11f80c4e4
2023-03-10 16:40:23 +00:00
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":micro_utils.dokka:dokkaHtml/commonMain"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="serializable.html">serializable</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator"> = </span><span class="token boolean">true</span></div></div></div>
</div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
class="pull-right"><span>Generated by </span><a
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
</div>
deploy: f2a9514d897d52574598f00c4b1c506ebe57624f
2023-09-01 22:34:58 +00:00
</div>
</div>
deploy: c70626734edca287388fddd4a2d9c4d0efc8e268
2023-02-27 10:02:57 +00:00
</div>
</body>
</html>
Reference in New Issue Copy Permalink