2023-02-27 10:02:57 +00:00
<!DOCTYPE html>
< html >
< 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 >
< script > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
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 >
< script type = "text/javascript" src = "../../../scripts/sourceset_dependencies.js" async = "async" > < / script >
< link href = "../../../styles/style.css" rel = "Stylesheet" >
< link href = "../../../styles/jetbrains-mono.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" >
< 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 >
< div class = "navigation-wrapper" id = "navigation-wrapper" >
< div id = "leftToggler" > < span class = "icon-toggler" > < / span > < / div >
< div class = "library-name" >
< a href = "../../../index.html" >
< span > micro_utils.dokka< / span >
< / a >
< / div >
< div >
2023-02-28 06:25:53 +00:00
0.17.0 < / div >
2023-02-27 10:02:57 +00:00
< div class = "pull-right d-flex" >
< 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 >
< button id = "theme-toggle-button" > < span id = "theme-toggle" > < / span > < / button >
< div id = "searchBar" > < / div >
< / div >
< / div >
< div id = "container" >
< div id = "leftColumn" >
< div id = "sideMenu" > < / div >
< / div >
< div id = "main" >
< div class = "main-content" id = "content" pageIds = "micro_utils.dokka::dev.inmo.micro_utils.repos.annotations/GenerateCRUDModel///PointingToDeclaration//-1478683138" >
< 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 >
< 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" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / 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 > < / 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 > < / div > < / div >
< / div >
< div class = "tabbedcontent" >
< div class = "tabs-section" tabs-section = "tabs-section" > < button class = "section-tab" data-active = "" data-togglable = "Properties" > Properties< / button > < button class = "section-tab" data-togglable = "Parameters" > Parameters< / button > < button class = "section-tab" data-togglable = "See also" > See also< / button > < / div >
< div class = "tabs-section-body" >
< h4 class = "" > See also< / h4 >
< div data-togglable = "See also" >
< div class = "platform-hinted WithExtraAttributes" data-platform-hinted = "data-platform-hinted" data-togglable = "See also" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div data-togglable = "See also" > < div class = "table" data-togglable = "See also" > < 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 WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < a href = "../-generate-c-r-u-d-model-exclude-override/index.html" > < span > Generate< / span > < wbr > < / wbr > < span > CRUDModel< / span > < wbr > < / wbr > < span > Exclude< / span > < wbr > < / wbr > < span > < span > Override< / span > < / span > < / a > < / div > < / span > < / div > < div > < / div > < / div > < / div > < / div > < / div > < / div > < / div >
< / div >
< h4 class = "" > Parameters< / h4 >
< div data-togglable = "Parameters" >
< div class = "platform-hinted WithExtraAttributes" data-platform-hinted = "data-platform-hinted" data-togglable = "Parameters" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < div data-togglable = "Parameters" > < div class = "table" data-togglable = "Parameters" > < 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 WithExtraAttributes" > < 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" > < div data-togglable = "Parameters" > < 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 > < 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 WithExtraAttributes" > < div class = "" > < span class = "inline-flex" > < div > < u > < span > < span > serializable< / span > < / span > < / u > < / div > < / span > < / div > < div > < div class = "title" > < div data-togglable = "Parameters" > < 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 > < / div > < / div > < / div > < / div >
< / div >
< h2 class = "" > Properties< / h2 >
< div class = "table" data-togglable = "Properties" > < 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 >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "631082130%2FProperties%2F-1478683138" > < / span >
< 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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < 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 = "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 >
< / 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 >
< 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 >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1401480250%2FProperties%2F-1478683138" > < / span >
< 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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "-1401480250%2FProperties%2F-1478683138" anchor-label = "registeredSupertypes" id = "-1401480250%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < 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" > < < / 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" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / span > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / 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 >
< 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 >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1068402343%2FProperties%2F-1478683138" > < / span >
< 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" data-togglable = "Properties" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":micro_utils.dokka:dokkaHtml/commonMain" > < a data-name = "1068402343%2FProperties%2F-1478683138" anchor-label = "serializable" id = "1068402343%2FProperties%2F-1478683138" data-filterable-set = ":micro_utils.dokka:dokkaHtml/commonMain" > < / a > < 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 >
< / 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 >
< / div >
< / div >
< / body >
< / html >
