[change]StudyRecordAmountの設計修正

Author: JASON13F

README.md

@@ -76,7 +76,7 @@ Create a record and post.
 val record = StudyRecord(
     duration = 2 * 60,
     comment = "勉強した！！！",
-    amount = StudyRecordAmount(30)
+    amount = StudyRecordAmountTotal(30)
 )
 Studyplus.instance.postRecord(this@MainActivity, record,
         object : Studyplus.Companion.OnPostRecordListener {

sdk-example-java/src/main/java/jp/studyplus/android/sdk_example_java/MainActivity.java

@@ -11,7 +11,7 @@
 import androidx.appcompat.app.AppCompatActivity;
 import jp.studyplus.android.sdk.Studyplus;
 import jp.studyplus.android.sdk.record.StudyRecord;
-import jp.studyplus.android.sdk.record.StudyRecordAmount;
+import jp.studyplus.android.sdk.record.StudyRecordAmountTotal;
 
 import java.util.Locale;
 
@@ -41,7 +41,7 @@ protected void onCreate(Bundle savedInstanceState) {
         Button postRecordButton = findViewById(R.id.post_study_record);
         postRecordButton.setOnClickListener(view -> {
             StudyRecord record = new StudyRecord(2 * 60);
-            record.setAmount(new StudyRecordAmount(30));
+            record.setAmount(new StudyRecordAmountTotal(30));
             record.setComment("勉強した！！！");
 
             Studyplus.getInstance().postRecord(MainActivity.this, record,

sdk-example-kt/src/main/java/jp/studyplus/android/sdk_example_kt/MainActivity.kt

@@ -10,7 +10,7 @@ import android.widget.Toast
 import androidx.appcompat.app.AppCompatActivity
 import jp.studyplus.android.sdk.Studyplus
 import jp.studyplus.android.sdk.record.StudyRecord
-import jp.studyplus.android.sdk.record.StudyRecordAmount
+import jp.studyplus.android.sdk.record.StudyRecordAmountTotal
 
 class MainActivity : AppCompatActivity() {
 
@@ -43,7 +43,7 @@ class MainActivity : AppCompatActivity() {
                 val record = StudyRecord(
                     duration = 2 * 60,
                     comment = "勉強した！！！",
-                    amount = StudyRecordAmount(30)
+                    amount = StudyRecordAmountTotal(30)
                 )
                 Studyplus.instance.postRecord(this@MainActivity, record,
                     object : Studyplus.Companion.OnPostRecordListener {

studyplus-android-sdk2/src/main/java/jp/studyplus/android/sdk/record/StudyRecord.kt

@@ -11,7 +11,7 @@ import java.util.*
  * @param recordedTime  学習を終えた日時
  * @param comment       学習に関するコメント
  * @param amount        学習量
- * @since 2.3.0
+ * @since 2.5.0
  */
 data class StudyRecord @JvmOverloads constructor(
     var duration: Int,
@@ -44,41 +44,3 @@ data class StudyRecord @JvmOverloads constructor(
     }
 
 }
-
-/**
- * Studyplusに投稿する学習記録の学習量
- *
- * @since 2.3.0
- */
-class StudyRecordAmount {
-
-    val amountTotal: Int?
-    val startPosition: Int?
-    val endPosition: Int?
-
-    /**
-     * 学習記録の合計学習量
-     *
-     * @param amountTotal 合計学習量
-     * @since 2.3.0
-     */
-    constructor(amountTotal: Int) {
-        this.amountTotal = amountTotal
-        this.startPosition = null
-        this.endPosition = null
-    }
-
-    /**
-     * 学習記録の学習範囲
-     *
-     * @param startPosition 学習量の起点
-     * @param endPosition   学習量の終点
-     * @since 2.3.0
-     */
-    constructor(startPosition: Int, endPosition: Int) {
-        this.amountTotal = null
-        this.startPosition = startPosition
-        this.endPosition = endPosition
-    }
-
-}

studyplus-android-sdk2/src/main/java/jp/studyplus/android/sdk/record/StudyRecordAmount.kt

@@ -0,0 +1,34 @@
+package jp.studyplus.android.sdk.record
+
+/**
+ * Studyplusに投稿する学習記録の学習量
+ *
+ * @since 2.5.0
+ */
+interface StudyRecordAmount {
+    val amountTotal: Int?
+    val startPosition: Int?
+    val endPosition: Int?
+}
+
+/**
+ * 学習記録の合計学習量
+ *
+ * @param amountTotal 合計学習量
+ * @since 2.5.0
+ */
+data class StudyRecordAmountTotal(override val amountTotal: Int) : StudyRecordAmount {
+    override val startPosition: Int? = null
+    override val endPosition: Int? = null
+}
+
+/**
+ * 学習記録の学習範囲
+ *
+ * @param startPosition 学習量の起点
+ * @param endPosition   学習量の終点
+ * @since 2.5.0
+ */
+data class StudyRecordAmountRange(override val startPosition: Int, override val endPosition: Int) : StudyRecordAmount {
+    override val amountTotal: Int? = null
+}

studyplus-android-sdk2/src/test/java/jp/studyplus/android/sdk/StudyRecordUnitTest.kt

@@ -1,7 +1,8 @@
 package jp.studyplus.android.sdk
 
 import jp.studyplus.android.sdk.record.StudyRecord
-import jp.studyplus.android.sdk.record.StudyRecordAmount
+import jp.studyplus.android.sdk.record.StudyRecordAmountRange
+import jp.studyplus.android.sdk.record.StudyRecordAmountTotal
 import org.junit.Assert.assertEquals
 import org.junit.Test
 import java.util.*
@@ -24,7 +25,7 @@ class StudyRecordUnitTest {
             duration = 2 * 60,
             recordedTime = Calendar.getInstance().apply { set(2019, 5, 1, 1, 2, 3) },
             comment = "perfect!",
-            amount = StudyRecordAmount(30)
+            amount = StudyRecordAmountTotal(30)
         )
 
         assertEquals(
@@ -39,7 +40,7 @@ class StudyRecordUnitTest {
             duration = 2 * 60,
             recordedTime = Calendar.getInstance().apply { set(2019, 5, 1, 1, 2, 3) },
             comment = "perfect!",
-            amount = StudyRecordAmount(5, 12)
+            amount = StudyRecordAmountRange(5, 12)
         )
 
         assertEquals(