Promote the Preferences API to stable (#568)

readium · Sep 18, 2024 · 775f742 · 775f742
1 parent 160668d
commit 775f742
Show file tree

Hide file tree

Showing 42 changed files with 23 additions and 112 deletions.
diff --git a/...rs/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerDefaults.kt b/...rs/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerDefaults.kt
@@ -6,8 +6,6 @@
 
 package org.readium.adapter.exoplayer.audio
 
-import org.readium.r2.shared.ExperimentalReadiumApi
-
 /**
  * Default values for the ExoPlayer engine.
  *
@@ -16,7 +14,6 @@ import org.readium.r2.shared.ExperimentalReadiumApi
  *
  * @see ExoPlayerPreferences
  */
-@ExperimentalReadiumApi
 public data class ExoPlayerDefaults(
     val pitch: Double? = null,
     val speed: Double? = null

diff --git a/...exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferences.kt b/...exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferences.kt
@@ -7,15 +7,13 @@
 package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.navigator.preferences.Configurable
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Preferences for the the ExoPlayer engine.
  *
  *  @param pitch Playback pitch rate.
  *  @param speed Playback speed rate.
  */
-@ExperimentalReadiumApi
 @kotlinx.serialization.Serializable
 public data class ExoPlayerPreferences(
     val pitch: Double? = null,

diff --git a/...yer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferencesEditor.kt b/...yer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferencesEditor.kt
@@ -13,7 +13,6 @@ import org.readium.r2.navigator.preferences.DoubleIncrement
 import org.readium.r2.navigator.preferences.PreferencesEditor
 import org.readium.r2.navigator.preferences.RangePreference
 import org.readium.r2.navigator.preferences.RangePreferenceDelegate
-import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.InternalReadiumApi
 import org.readium.r2.shared.publication.Metadata
 
@@ -24,7 +23,6 @@ import org.readium.r2.shared.publication.Metadata
  * existing preferences. It includes rules for adjusting preferences, such as the supported values
  * or ranges.
  */
-@ExperimentalReadiumApi
 public class ExoPlayerPreferencesEditor(
     initialPreferences: ExoPlayerPreferences,
     @Suppress("UNUSED_PARAMETER") publicationMetadata: Metadata,

diff --git a/...audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferencesSerializer.kt b/...audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerPreferencesSerializer.kt
@@ -8,12 +8,10 @@ package org.readium.adapter.exoplayer.audio
 
 import kotlinx.serialization.json.Json
 import org.readium.r2.navigator.preferences.PreferencesSerializer
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * JSON serializer of [ExoPlayerPreferences].
  */
-@ExperimentalReadiumApi
 public class ExoPlayerPreferencesSerializer : PreferencesSerializer<ExoPlayerPreferences> {
 
     override fun serialize(preferences: ExoPlayerPreferences): String =

diff --git a/...rs/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerSettings.kt b/...rs/exoplayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerSettings.kt
@@ -7,14 +7,12 @@
 package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.navigator.preferences.Configurable
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Settings values of the ExoPlayer engine.
  *
  * @see ExoPlayerPreferences
  */
-@ExperimentalReadiumApi
 public data class ExoPlayerSettings(
     val pitch: Double,
     val speed: Double

diff --git a/...ayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerSettingsResolver.kt b/...ayer/audio/src/main/java/org/readium/adapter/exoplayer/audio/ExoPlayerSettingsResolver.kt
@@ -8,7 +8,7 @@ package org.readium.adapter.exoplayer.audio
 
 import org.readium.r2.shared.ExperimentalReadiumApi
 
-@ExperimentalReadiumApi
+@OptIn(ExperimentalReadiumApi::class)
 internal class ExoPlayerSettingsResolver(
     private val defaults: ExoPlayerDefaults
 ) : ExoPlayerEngine.SettingsResolver {

diff --git a/...ers/pdfium/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumDefaults.kt b/...ers/pdfium/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumDefaults.kt
@@ -7,7 +7,6 @@
 package org.readium.adapter.pdfium.navigator
 
 import org.readium.r2.navigator.preferences.ReadingProgression
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Default values for the PDF navigator with the PDFium adapter.
@@ -16,7 +15,6 @@ import org.readium.r2.shared.ExperimentalReadiumApi
  *
  * @see PdfiumPreferences
  */
-@ExperimentalReadiumApi
 public data class PdfiumDefaults(
     val pageSpacing: Double? = null,
     val readingProgression: ReadingProgression? = null

diff --git a/.../pdfium/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferences.kt b/.../pdfium/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferences.kt
@@ -11,7 +11,6 @@ import org.readium.r2.navigator.preferences.Axis
 import org.readium.r2.navigator.preferences.Configurable
 import org.readium.r2.navigator.preferences.Fit
 import org.readium.r2.navigator.preferences.ReadingProgression
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Preferences for the PDF navigator with the PDFium adapter.
@@ -21,7 +20,6 @@ import org.readium.r2.shared.ExperimentalReadiumApi
  *  @param readingProgression Direction of the horizontal progression across pages.
  *  @param scrollAxis Indicates the axis along which pages should be laid out in scroll mode.
  */
-@ExperimentalReadiumApi
 @Serializable
 public data class PdfiumPreferences(
     val fit: Fit? = null,

diff --git a/...m/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferencesEditor.kt b/...m/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferencesEditor.kt
@@ -10,7 +10,6 @@ package org.readium.adapter.pdfium.navigator
 
 import org.readium.r2.navigator.extensions.format
 import org.readium.r2.navigator.preferences.*
-import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.InternalReadiumApi
 import org.readium.r2.shared.publication.Metadata
 
@@ -21,7 +20,6 @@ import org.readium.r2.shared.publication.Metadata
  * existing preferences. It includes rules for adjusting preferences, such as the supported values
  * or ranges.
  */
-@ExperimentalReadiumApi
 public class PdfiumPreferencesEditor internal constructor(
     initialPreferences: PdfiumPreferences,
     publicationMetadata: Metadata,

diff --git a/.../navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferencesFilters.kt b/.../navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferencesFilters.kt
@@ -7,12 +7,10 @@
 package org.readium.adapter.pdfium.navigator
 
 import org.readium.r2.navigator.preferences.PreferencesFilter
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Suggested filter to keep only shared [PdfiumPreferences].
  */
-@ExperimentalReadiumApi
 public object PdfiumSharedPreferencesFilter : PreferencesFilter<PdfiumPreferences> {
 
     override fun filter(preferences: PdfiumPreferences): PdfiumPreferences =
@@ -24,7 +22,6 @@ public object PdfiumSharedPreferencesFilter : PreferencesFilter<PdfiumPreference
 /**
  * Suggested filter to keep only publication-specific [PdfiumPreferences].
  */
-@ExperimentalReadiumApi
 public object PdfiumPublicationPreferencesFilter : PreferencesFilter<PdfiumPreferences> {
 
     override fun filter(preferences: PdfiumPreferences): PdfiumPreferences =

diff --git a/...vigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferencesSerializer.kt b/...vigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumPreferencesSerializer.kt
@@ -8,12 +8,10 @@ package org.readium.adapter.pdfium.navigator
 
 import kotlinx.serialization.json.Json
 import org.readium.r2.navigator.preferences.PreferencesSerializer
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * JSON serializer of [PdfiumPreferences].
  */
-@ExperimentalReadiumApi
 public class PdfiumPreferencesSerializer : PreferencesSerializer<PdfiumPreferences> {
 
     override fun serialize(preferences: PdfiumPreferences): String =

diff --git a/...ers/pdfium/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumSettings.kt b/...ers/pdfium/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumSettings.kt
@@ -7,14 +7,12 @@
 package org.readium.adapter.pdfium.navigator
 
 import org.readium.r2.navigator.preferences.*
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  *  Settings values of the PDF navigator with the PDFium adapter.
  *
  *  @see PdfiumPreferences
  */
-@ExperimentalReadiumApi
 public data class PdfiumSettings(
     val fit: Fit,
     val pageSpacing: Double,

diff --git a/...um/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumSettingsResolver.kt b/...um/navigator/src/main/java/org/readium/adapter/pdfium/navigator/PdfiumSettingsResolver.kt
@@ -9,11 +9,9 @@ package org.readium.adapter.pdfium.navigator
 import org.readium.r2.navigator.preferences.Axis
 import org.readium.r2.navigator.preferences.Fit
 import org.readium.r2.navigator.preferences.ReadingProgression
-import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.publication.Metadata
 import org.readium.r2.shared.publication.ReadingProgression as PublicationReadingProgression
 
-@ExperimentalReadiumApi
 internal class PdfiumSettingsResolver(
     private val metadata: Metadata,
     private val defaults: PdfiumDefaults

diff --git a/...pdfkit/navigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitDefaults.kt b/...pdfkit/navigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitDefaults.kt
@@ -8,7 +8,6 @@ package org.readium.adapter.pspdfkit.navigator
 
 import org.readium.r2.navigator.preferences.ReadingProgression
 import org.readium.r2.navigator.preferences.Spread
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Default values for the PDF navigator with the PSPDFKit adapter.
@@ -17,7 +16,6 @@ import org.readium.r2.shared.ExperimentalReadiumApi
  *
  * @see PsPdfKitPreferences
  */
-@ExperimentalReadiumApi
 public data class PsPdfKitDefaults(
     val offsetFirstPage: Boolean? = null,
     val pageSpacing: Double? = null,

diff --git a/...kit/navigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferences.kt b/...kit/navigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferences.kt
@@ -8,7 +8,6 @@ package org.readium.adapter.pspdfkit.navigator
 
 import kotlinx.serialization.Serializable
 import org.readium.r2.navigator.preferences.*
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Preferences for the PDF navigator with the PSPDFKit adapter.
@@ -21,7 +20,6 @@ import org.readium.r2.shared.ExperimentalReadiumApi
  *  @param scrollAxis Indicates the axis along which pages should be laid out in scroll mode.
  *  @param spread Indicates if the publication should be rendered with a synthetic spread (dual-page).
  */
-@ExperimentalReadiumApi
 @Serializable
 public data class PsPdfKitPreferences(
     val fit: Fit? = null,

diff --git a/...vigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferencesEditor.kt b/...vigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferencesEditor.kt
@@ -21,7 +21,6 @@ import org.readium.r2.navigator.preferences.RangePreference
 import org.readium.r2.navigator.preferences.RangePreferenceDelegate
 import org.readium.r2.navigator.preferences.ReadingProgression
 import org.readium.r2.navigator.preferences.Spread
-import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.InternalReadiumApi
 import org.readium.r2.shared.publication.Metadata
 
@@ -32,7 +31,6 @@ import org.readium.r2.shared.publication.Metadata
  * existing preferences. It includes rules for adjusting preferences, such as the supported values
  * or ranges.
  */
-@ExperimentalReadiumApi
 public class PsPdfKitPreferencesEditor internal constructor(
     initialPreferences: PsPdfKitPreferences,
     publicationMetadata: Metadata,

diff --git a/...igator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferencesFilters.kt b/...igator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferencesFilters.kt
@@ -7,12 +7,10 @@
 package org.readium.adapter.pspdfkit.navigator
 
 import org.readium.r2.navigator.preferences.PreferencesFilter
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Suggested filter to keep only shared [PsPdfKitPreferences].
  */
-@ExperimentalReadiumApi
 public object PsPdfKitSharedPreferencesFilter : PreferencesFilter<PsPdfKitPreferences> {
 
     override fun filter(preferences: PsPdfKitPreferences): PsPdfKitPreferences =
@@ -26,7 +24,6 @@ public object PsPdfKitSharedPreferencesFilter : PreferencesFilter<PsPdfKitPrefer
 /**
  * Suggested filter to keep only publication-specific [PsPdfKitPreferences].
  */
-@ExperimentalReadiumApi
 public object PsPdfKitPublicationPreferencesFilter : PreferencesFilter<PsPdfKitPreferences> {
 
     override fun filter(preferences: PsPdfKitPreferences): PsPdfKitPreferences =

diff --git a/...tor/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferencesSerializer.kt b/...tor/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitPreferencesSerializer.kt
@@ -8,12 +8,10 @@ package org.readium.adapter.pspdfkit.navigator
 
 import kotlinx.serialization.json.Json
 import org.readium.r2.navigator.preferences.PreferencesSerializer
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * JSON serializer of [PsPdfKitPreferences].
  */
-@ExperimentalReadiumApi
 public class PsPdfKitPreferencesSerializer : PreferencesSerializer<PsPdfKitPreferences> {
 
     override fun serialize(preferences: PsPdfKitPreferences): String =

diff --git a/...pdfkit/navigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitSettings.kt b/...pdfkit/navigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitSettings.kt
@@ -7,14 +7,12 @@
 package org.readium.adapter.pspdfkit.navigator
 
 import org.readium.r2.navigator.preferences.*
-import org.readium.r2.shared.ExperimentalReadiumApi
 
 /**
  * Settings values of the PDF navigator with the PSPDFKit adapter.
  *
  * @see PsPdfKitPreferences
  */
-@ExperimentalReadiumApi
 public data class PsPdfKitSettings(
     val fit: Fit,
     val offsetFirstPage: Boolean,

diff --git a/...avigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitSettingsResolver.kt b/...avigator/src/main/java/org/readium/adapter/pspdfkit/navigator/PsPdfKitSettingsResolver.kt
@@ -10,11 +10,9 @@ import org.readium.r2.navigator.preferences.Axis
 import org.readium.r2.navigator.preferences.Fit
 import org.readium.r2.navigator.preferences.ReadingProgression
 import org.readium.r2.navigator.preferences.Spread
-import org.readium.r2.shared.ExperimentalReadiumApi
 import org.readium.r2.shared.publication.Metadata
 import org.readium.r2.shared.publication.ReadingProgression as PublicationReadingProgression
 
-@ExperimentalReadiumApi
 internal class PsPdfKitSettingsResolver(
     private val metadata: Metadata,
     private val defaults: PsPdfKitDefaults

diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubDefaults.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubDefaults.kt
@@ -17,8 +17,7 @@ import org.readium.r2.shared.util.Language
  *
  * @see EpubPreferences
  */
-@ExperimentalReadiumApi
-public data class EpubDefaults(
+public data class EpubDefaults @ExperimentalReadiumApi constructor(
     val columnCount: ColumnCount? = null,
     val fontSize: Double? = null,
     val fontWeight: Double? = null,

diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubNavigatorFactory.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubNavigatorFactory.kt
@@ -23,7 +23,7 @@ import org.readium.r2.shared.publication.presentation.presentation
  * @param publication EPUB publication to render in the navigator.
  * @param configuration Configuration of the factory to create.
  */
-@ExperimentalReadiumApi
+@OptIn(ExperimentalReadiumApi::class)
 public class EpubNavigatorFactory(
     private val publication: Publication,
     private val configuration: Configuration = Configuration()

diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubPreferences.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubPreferences.kt
@@ -47,9 +47,8 @@ import org.readium.r2.shared.util.Language
  *   no preference is given.
  * @param wordSpacing Space between words.
  */
-@ExperimentalReadiumApi
 @Serializable
-public data class EpubPreferences(
+public data class EpubPreferences @ExperimentalReadiumApi constructor(
     val backgroundColor: Color? = null,
     val columnCount: ColumnCount? = null,
     val fontFamily: FontFamily? = null,
@@ -88,6 +87,7 @@ public data class EpubPreferences(
         require(wordSpacing == null || wordSpacing >= 0)
     }
 
+    @OptIn(ExperimentalReadiumApi::class)
     override operator fun plus(other: EpubPreferences): EpubPreferences =
         EpubPreferences(
             backgroundColor = other.backgroundColor ?: backgroundColor,

diff --git a/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubPreferencesEditor.kt b/readium/navigator/src/main/java/org/readium/r2/navigator/epub/EpubPreferencesEditor.kt
@@ -24,7 +24,7 @@ import org.readium.r2.shared.util.Language
  * existing preferences. It includes rules for adjusting preferences, such as the supported values
  * or ranges.
  */
-@ExperimentalReadiumApi
+@OptIn(ExperimentalReadiumApi::class)
 public class EpubPreferencesEditor internal constructor(
     initialPreferences: EpubPreferences,
     publicationMetadata: Metadata,
@@ -50,6 +50,7 @@ public class EpubPreferencesEditor internal constructor(
     /**
      * Reset all preferences.
      */
+    @OptIn(ExperimentalReadiumApi::class)
     override fun clear() {
         updateValues { EpubPreferences() }
     }
@@ -81,6 +82,7 @@ public class EpubPreferencesEditor internal constructor(
      *  - the publication is reflowable
      *  - [scroll] is off
      */
+    @ExperimentalReadiumApi
     public val columnCount: EnumPreference<ColumnCount> =
         EnumPreferenceDelegate(
             getValue = { preferences.columnCount },
@@ -246,6 +248,7 @@ public class EpubPreferencesEditor internal constructor(
      *
      * Only effective with reflowable publications.
      */
+    @ExperimentalReadiumApi
     public val pageMargins: RangePreference<Double> =
         RangePreferenceDelegate(
             getValue = { preferences.pageMargins },
@@ -425,6 +428,7 @@ public class EpubPreferencesEditor internal constructor(
      *  - the publication is reflowable
      *  - [publisherStyles] is off
      */
+    @ExperimentalReadiumApi
     public val typeScale: RangePreference<Double> =
         RangePreferenceDelegate(
             getValue = { preferences.typeScale },