doc: ドキュメントを追加

common/src/main/kotlin/dev/usbharu/owl/common/property/BooleanPropertyValue.kt

@@ -1,10 +1,19 @@
 package dev.usbharu.owl.common.property
 
+/**
+ * Boolean型のプロパティ
+ *
+ * @property value プロパティ
+ */
 class BooleanPropertyValue(override val value: Boolean) : PropertyValue<Boolean>() {
     override val type: PropertyType
         get() = PropertyType.binary
 }
 
+/**
+ * [BooleanPropertyValue]のシリアライザー
+ *
+ */
 class BooleanPropertySerializer : PropertySerializer<Boolean> {
     override fun isSupported(propertyValue: PropertyValue<*>): Boolean {
         return propertyValue.value is Boolean

common/src/main/kotlin/dev/usbharu/owl/common/property/DoublePropertyValue.kt

@@ -1,10 +1,19 @@
 package dev.usbharu.owl.common.property
 
+/**
+ * Double型のプロパティ
+ *
+ * @property value プロパティ
+ */
 class DoublePropertyValue(override val value: Double) : PropertyValue<Double>() {
     override val type: PropertyType
         get() = PropertyType.number
 }
 
+/**
+ * [DoublePropertyValue]のシリアライザー
+ *
+ */
 class DoublePropertySerializer : PropertySerializer<Double> {
     override fun isSupported(propertyValue: PropertyValue<*>): Boolean {
         return propertyValue.value is Double

common/src/main/kotlin/dev/usbharu/owl/common/property/IntegerPropertyValue.kt

@@ -16,11 +16,20 @@
 
 package dev.usbharu.owl.common.property
 
+/**
+ * Integer型のプロパティ
+ *
+ * @property value プロパティ
+ */
 class IntegerPropertyValue(override val value: Int) : PropertyValue<Int>() {
     override val type: PropertyType
         get() = PropertyType.number
 }
 
+/**
+ * [IntegerPropertyValue]のシリアライザー
+ *
+ */
 class IntegerPropertySerializer : PropertySerializer<Int> {
     override fun isSupported(propertyValue: PropertyValue<*>): Boolean {
         return propertyValue.value is Int

common/src/main/kotlin/dev/usbharu/owl/common/property/PropertySerializeUtils.kt

@@ -16,13 +16,30 @@
 
 package dev.usbharu.owl.common.property
 
+/**
+ * [PropertySerializer]のユーティリティークラス
+ */
 object PropertySerializeUtils {
+    /**
+     * Stringと[PropertyValue]の[Map]から[PropertyValue]をシリアライズし、StringとStringの[Map]として返します
+     *
+     * @param serializerFactory シリアライズに使用する[PropertySerializerFactory]
+     * @param properties シリアライズする[Map]
+     * @return Stringとシリアライズ済みの[PropertyValue]の[Map]
+     */
     fun serialize(
         serializerFactory: PropertySerializerFactory,
         properties: Map<String, PropertyValue<*>>
     ): Map<String, String> =
         properties.map { it.key to serializerFactory.factory(it.value).serialize(it.value) }.toMap()
 
+    /**
+     * Stringとシリアライズ済みの[PropertyValue]の[Map]からシリアライズ済みの[PropertyValue]をデシリアライズし、Stringと[PropertyValue]の[Map]として返します
+     *
+     * @param serializerFactory デシリアライズに使用する[PropertySerializerFactory]
+     * @param properties デシリアライズする[Map]
+     * @return Stringと[PropertyValue]の[Map]
+     */
     fun deserialize(
         serializerFactory: PropertySerializerFactory,
         properties: Map<String, String>

common/src/main/kotlin/dev/usbharu/owl/common/property/PropertyType.kt

@@ -16,8 +16,26 @@
 
 package dev.usbharu.owl.common.property
 
+/**
+ * プロパティの型
+ *
+ */
 enum class PropertyType {
+    /**
+     * 数字
+     *
+     */
     number,
+
+    /**
+     * 文字列
+     *
+     */
     string,
+
+    /**
+     * バイナリ
+     *
+     */
     binary
 }

common/src/main/kotlin/dev/usbharu/owl/common/property/PropertyValue.kt

@@ -22,6 +22,13 @@ package dev.usbharu.owl.common.property
  * @param T プロパティの型
  */
 sealed class PropertyValue<T> {
+    /**
+     * プロパティ
+     */
     abstract val value: T
+
+    /**
+     * プロパティの型
+     */
     abstract val type: PropertyType
 }

common/src/main/kotlin/dev/usbharu/owl/common/property/StringPropertyValue.kt

@@ -1,10 +1,19 @@
 package dev.usbharu.owl.common.property
 
+/**
+ * String型のプロパティ
+ *
+ * @property value プロパティ
+ */
 class StringPropertyValue(override val value: String) : PropertyValue<String>() {
     override val type: PropertyType
         get() = PropertyType.string
 }
 
+/**
+ * [StringPropertyValue]のシリアライザー
+ *
+ */
 class StringPropertyValueSerializer : PropertySerializer<String> {
     override fun isSupported(propertyValue: PropertyValue<*>): Boolean {
         return propertyValue.value is String

common/src/main/kotlin/dev/usbharu/owl/common/retry/ExponentialRetryPolicy.kt

@@ -4,8 +4,14 @@ import java.time.Instant
 import kotlin.math.pow
 import kotlin.math.roundToLong
 
+/**
+ * 指数関数的に待機時間が増えるリトライポリシー
+ * `firstRetrySeconds x attempt ^ 2 - firstRetrySeconds`
+ *
+ * @property firstRetrySeconds
+ */
 class ExponentialRetryPolicy(private val firstRetrySeconds: Int = 30) : RetryPolicy {
     override fun nextRetry(now: Instant, attempt: Int): Instant =
-        now.plusSeconds(firstRetrySeconds.times((2.0).pow(attempt).roundToLong()) - 30)
+        now.plusSeconds(firstRetrySeconds.times((2.0).pow(attempt).roundToLong()) - firstRetrySeconds)
 
 }

common/src/main/kotlin/dev/usbharu/owl/common/retry/RetryPolicy.kt

@@ -18,6 +18,19 @@ package dev.usbharu.owl.common.retry
 
 import java.time.Instant
 
+/**
+ * リトライポリシー
+ *
+ */
 interface RetryPolicy {
+    /**
+     * 次のリトライ時刻を返します。
+     *
+     * [attempt]を負の値にしてはいけません
+     *
+     * @param now 現在の時刻
+     * @param attempt 試行回数
+     * @return 次のリトライ時刻
+     */
     fun nextRetry(now: Instant, attempt: Int): Instant
 }

common/src/main/kotlin/dev/usbharu/owl/common/task/PropertyDefinition.kt

@@ -18,7 +18,19 @@ package dev.usbharu.owl.common.task
 
 import dev.usbharu.owl.common.property.PropertyType
 
+/**
+ * プロパティ定義
+ *
+ * @property map プロパティ名とプロパティタイプの[Map]
+ */
 class PropertyDefinition(val map: Map<String, PropertyType>) : Map<String, PropertyType> by map {
+    /**
+     * プロパティ定義のハッシュを求めます
+     *
+     * ハッシュ値はプロパティ名とプロパティタイプ名を結合したものを結合し、各文字のUTF-16コードと31を掛け続けたものです。
+     *
+     * @return
+     */
     fun hash(): Long {
         var hash = 1L
         map.map { it.key + it.value.name }.joinToString("").map { hash *= it.code * 31 }

common/src/main/kotlin/dev/usbharu/owl/common/task/PublishedTask.kt

@@ -17,8 +17,16 @@
 package dev.usbharu.owl.common.task
 
 import java.time.Instant
-import java.util.UUID
+import java.util.*
 
+/**
+ * 公開済みのタスク
+ *
+ * @param T タスク
+ * @property task タスク
+ * @property id タスクのID
+ * @property published 公開された時刻
+ */
 data class PublishedTask<T : Task>(
     val task: T,
     val id: UUID,

common/src/main/kotlin/dev/usbharu/owl/common/task/Task.kt

@@ -16,5 +16,9 @@
 
 package dev.usbharu.owl.common.task
 
+/**
+ * タスク
+ *
+ */
 open class Task {
 }

common/src/main/kotlin/dev/usbharu/owl/common/task/TaskDefinition.kt

@@ -18,15 +18,62 @@ package dev.usbharu.owl.common.task
 
 import dev.usbharu.owl.common.property.PropertyValue
 
+/**
+ * タスク定義
+ *
+ * @param T タスク
+ */
 interface TaskDefinition<T : Task> {
+    /**
+     * タスク名
+     */
     val name: String
+
+    /**
+     * 優先度
+     */
     val priority: Int
+
+    /**
+     * 最大リトライ数
+     */
     val maxRetry: Int
+
+    /**
+     * リトライポリシー名
+     *
+     * ポリシーの解決は各Brokerに依存しています
+     */
     val retryPolicy: String
+
+    /**
+     * タスク実行時のタイムアウト(ミリ秒)
+     */
     val timeoutMilli: Long
+
+    /**
+     * プロパティ定義
+     */
     val propertyDefinition: PropertyDefinition
+
+    /**
+     * [Task]の[Class]
+     */
     val type: Class<T>
 
+    /**
+     * タスクをシリアライズします.
+     * プロパティのシリアライズと混同しないようにしてください。
+     * @param task シリアライズするタスク
+     * @return シリアライズされたタスク
+     */
     fun serialize(task: T): Map<String, PropertyValue<*>>
+
+    /**
+     * タスクをデシリアライズします。
+     * プロパティのデシリアライズと混同しないようにしてください
+     * @param value デシリアライズするタスク
+     * @return デシリアライズされたタスク
+     */
     fun deserialize(value: Map<String, PropertyValue<*>>): T
 }