SCBC-486: Change case class creation for Scala 3

programmatix · programmatix · commit c63a30a62552 · 2025-05-29T09:36:36.000Z
Make all public interface input case classes have public constructors. Currently case classes cannot be created in Scala 3, as the automatically generated object apply() method matches the visibility of the case class constructor. In Scala 2, it remains public. The upshot is: users cannot create these case classes at all, in Scala 3. (There are no issues with Scala 2). We not currently support or test Scala 3, and that continues to be the case. However, using the Scala 2 SDK has previously worked from Scala 3, and this small tweak will restore that functionality. Change-Id: I636afbb140865c8d31007cefbfb8e52545806350 Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/228227 Tested-by: Build Bot <build@couchbase.com> Reviewed-by: Graham Pople <graham.pople@couchbase.com> (cherry picked from commit 2a6f845) Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/228418 Reviewed-by: David Nault <david.nault@couchbase.com>
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/analytics/AnalyticsOptions.scala b/scala-client/src/main/scala/com/couchbase/client/scala/analytics/AnalyticsOptions.scala
@@ -30,7 +30,7 @@ import scala.concurrent.duration.Duration
   * @author Graham Pople
   * @since 1.0.0
   */
-case class AnalyticsOptions private (
+case class AnalyticsOptions (
     private[scala] val parameters: Option[AnalyticsParameters] = None,
     private[scala] val clientContextId: Option[String] = None,
     private[scala] val retryStrategy: Option[RetryStrategy] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/manager/collection/CollectionSpec.scala b/scala-client/src/main/scala/com/couchbase/client/scala/manager/collection/CollectionSpec.scala
@@ -25,7 +25,7 @@ import scala.concurrent.duration.Duration
   * @param expiry any configured TTL for newly created documents on this collection.  Older server versions will not have this setting, in which case it will be `None`.
   * @param history whether history retention is enabled on this collection.  Older server versions will not have this setting, in which case it will be `None`.
   */
-case class CollectionSpec private (
+case class CollectionSpec (
     name: String,
     scopeName: String,
     expiry: Option[Duration] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/search/queries/BooleanQuery.scala b/scala-client/src/main/scala/com/couchbase/client/scala/search/queries/BooleanQuery.scala
@@ -22,7 +22,7 @@ import com.couchbase.client.core.api.search.queries.CoreBooleanQuery
   *
   * @since 1.0.0
   */
-case class BooleanQuery private (
+case class BooleanQuery (
     private[scala] val must: Option[ConjunctionQuery] = None,
     private[scala] val should: Option[DisjunctionQuery] = None,
     private[scala] val mustNot: Option[DisjunctionQuery] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/search/result/SearchFacetResult.scala b/scala-client/src/main/scala/com/couchbase/client/scala/search/result/SearchFacetResult.scala
@@ -62,7 +62,7 @@ object SearchFacetResult {
     *
     * @since 1.0.0
     */
-  case class DateRange private (private val internal: CoreSearchDateRange) {
+  case class DateRange (private val internal: CoreSearchDateRange) {
     def name: String = internal.name
 
     def start: String = internal.start.toString
@@ -99,7 +99,7 @@ object SearchFacetResult {
       internal.numericRanges.asScala.toSeq.map(v => NumericRange(v))
   }
 
-  case class NumericRange private (private val internal: CoreSearchNumericRange) {
+  case class NumericRange (private val internal: CoreSearchNumericRange) {
     def name: String = internal.name
 
     def min: Double = internal.min
@@ -127,7 +127,7 @@ object SearchFacetResult {
     *
     * @since 1.0.0
     */
-  case class TermRange private (private val internal: CoreSearchTermRange) {
+  case class TermRange (private val internal: CoreSearchTermRange) {
     def term: String = internal.name
 
     def count: Long = internal.count
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/SearchRequest.scala b/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/SearchRequest.scala
@@ -28,7 +28,7 @@ import scala.util.{Failure, Success, Try}
   *
   * If both are provided, the FS service will merge the results.
   */
-case class SearchRequest private (
+case class SearchRequest (
     private val searchQuery: Option[SearchQuery] = None,
     private val vectorSearch: Option[VectorSearch] = None,
     private val deferredError: Option[Throwable] = None
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorQuery.scala b/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorQuery.scala
@@ -21,7 +21,7 @@ import com.couchbase.client.core.annotation.Stability.Uncommitted
 import com.couchbase.client.core.api.search.vector.{CoreVector, CoreVectorQuery}
 
 /** Represents a vector query. */
-case class VectorQuery private (
+case class VectorQuery (
     private val vectorQuery: Either[Array[Float], String],
     private val vectorField: String,
     private val numCandidates: Option[Int] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorSearch.scala b/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorSearch.scala
@@ -21,7 +21,7 @@ import com.couchbase.client.core.api.search.vector.CoreVectorSearch
 import scala.collection.JavaConverters._
 
 /** Allows one or more [[VectorQuery]]s to be executed. */
-case class VectorSearch private (
+case class VectorSearch (
     private val vectorQueries: Iterable[VectorQuery],
     private val vectorSearchOptions: Option[VectorSearchOptions] = None
 ) {
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorSearchOptions.scala b/scala-client/src/main/scala/com/couchbase/client/scala/search/vector/VectorSearchOptions.scala
@@ -33,7 +33,7 @@ object VectorQueryCombination {
 }
 
 /** Options related to executing a [[VectorSearch]]. */
-case class VectorSearchOptions private (
+case class VectorSearchOptions (
     private val vectorQueryCombination: Option[VectorQueryCombination] = None
 ) {
 
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/transactions/TransactionQueryOptions.scala b/scala-client/src/main/scala/com/couchbase/client/scala/transactions/TransactionQueryOptions.scala
@@ -27,7 +27,7 @@ import com.couchbase.client.scala.query.{
 
 /** Customize the execution of a N1QL query performed inside a transaction.
   */
-case class TransactionQueryOptions private (
+case class TransactionQueryOptions (
     private[scala] val parameters: Option[QueryParameters] = None,
     private[scala] val clientContextId: Option[String] = None,
     private[scala] val pipelineBatch: Option[Int] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/transactions/config/SingleQueryTransactionOptions.scala b/scala-client/src/main/scala/com/couchbase/client/scala/transactions/config/SingleQueryTransactionOptions.scala
@@ -23,7 +23,7 @@ import com.couchbase.client.scala.Collection
 /**
   * Allows configuring a single-query-transaction.
   */
-case class SingleQueryTransactionOptions private (
+case class SingleQueryTransactionOptions (
     private val durabilityLevel: Option[DurabilityLevel] = None,
     private val attemptContextFactory: Option[TransactionAttemptContextFactory] = None,
     private val metadataCollection: Option[CollectionIdentifier] = None
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/transactions/config/TransactionOptions.scala b/scala-client/src/main/scala/com/couchbase/client/scala/transactions/config/TransactionOptions.scala
@@ -29,7 +29,7 @@ import scala.concurrent.duration.Duration
 /**
   * Provides all configurable parameters for a single Couchbase transaction.
   */
-case class TransactionOptions private (
+case class TransactionOptions (
     private val durabilityLevel: Option[DurabilityLevel] = None,
     private val parentSpan: Option[RequestSpan] = None,
     private val timeout: Option[Duration] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/transactions/config/TransactionsConfig.scala b/scala-client/src/main/scala/com/couchbase/client/scala/transactions/config/TransactionsConfig.scala
@@ -35,7 +35,7 @@ import scala.concurrent.duration.Duration
 /**
   * Provides all configurable parameters for Couchbase transactions.
   */
-case class TransactionsConfig private (
+case class TransactionsConfig (
     private val cleanupConfig: Option[TransactionsCleanupConfig] = None,
     private val durabilityLevel: Option[DurabilityLevel] = None,
     private val timeout: Option[Duration] = None,
diff --git a/scala-client/src/main/scala/com/couchbase/client/scala/util/Coordinate.scala b/scala-client/src/main/scala/com/couchbase/client/scala/util/Coordinate.scala
@@ -30,7 +30,7 @@ object Coordinate {
   def ofLonLat(lon: Double, lat: Double) = new Coordinate(lon, lat)
 }
 
-case class Coordinate private (
+case class Coordinate (
     /**
       * The longitude of this coordinate.
       */

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ import com.couchbase.client.core.api.search.queries.CoreBooleanQuery`
`22`	`22`	`*`
`23`	`23`	`* @since 1.0.0`
`24`	`24`	`*/`
`25`		`-case class BooleanQuery private (`
	`25`	`+case class BooleanQuery (`
`26`	`26`	`private[scala] val must: Option[ConjunctionQuery] = None,`
`27`	`27`	`private[scala] val should: Option[DisjunctionQuery] = None,`
`28`	`28`	`private[scala] val mustNot: Option[DisjunctionQuery] = None,`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ import scala.util.{Failure, Success, Try}`
`28`	`28`	`*`
`29`	`29`	`* If both are provided, the FS service will merge the results.`
`30`	`30`	`*/`
`31`		`-case class SearchRequest private (`
	`31`	`+case class SearchRequest (`
`32`	`32`	`private val searchQuery: Option[SearchQuery] = None,`
`33`	`33`	`private val vectorSearch: Option[VectorSearch] = None,`
`34`	`34`	`private val deferredError: Option[Throwable] = None`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ object VectorQueryCombination {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`/** Options related to executing a [[VectorSearch]]. */`
`36`		`-case class VectorSearchOptions private (`
	`36`	`+case class VectorSearchOptions (`
`37`	`37`	`private val vectorQueryCombination: Option[VectorQueryCombination] = None`
`38`	`38`	`) {`
`39`	`39`