PostsSystem/core
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

add kdoc for Post.kt

Browse Source
This commit is contained in:
InsanusMokrassar 2019-11-01 11:27:58 +06:00
parent f241ed55e0
commit febf442faa
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
core/src/main/kotlin/com/insanusmokrassar/postssystem/core/post/Post.kt
View File

@ -9,10 +9,17 @@ typealias PostId = String
typealias PostContents = List<Content> typealias PostContents = List<Content>
typealias RegisteredPostContents = List<RegisteredContent> typealias RegisteredPostContents = List<RegisteredContent>
/**
* Base interface for creating of new post. Usually, it is just [SimplePost] instance
*/
interface Post { interface Post {
val content: PostContents val content: PostContents
} }
/**
* Root entity of whole system. Can be retrieved from [com.insanusmokrassar.postssystem.core.api.ReadPostsAPI] by
* getting and created in [com.insanusmokrassar.postssystem.core.api.WritePostsAPI] by inserting of [Post] instance
*/
interface RegisteredPost : Post { interface RegisteredPost : Post {
val id: PostId val id: PostId
@ -22,10 +29,17 @@ interface RegisteredPost : Post {
val modificationDate: DateTime val modificationDate: DateTime
} }
/**
* Base and currently (1st Nov 2019) single realisation of [Post]. There is [SimpleRegisteredPost] which is technically
* is [Post] too, but it is not direct [Post] realisation
*/
data class SimplePost( data class SimplePost(
override val content: PostContents override val content: PostContents
) : Post ) : Post
/**
* Base and currently (1st Nov 2019) single realisation of [RegisteredPost]
*/
data class SimpleRegisteredPost( data class SimpleRegisteredPost(
override val id: PostId, override val id: PostId,
override val content: RegisteredPostContents, override val content: RegisteredPostContents,